Skip to content

Commit

Permalink
Docs Update
Browse files Browse the repository at this point in the history
  • Loading branch information
Service Account committed Oct 22, 2024
1 parent 93e2c71 commit 100fc46
Show file tree
Hide file tree
Showing 17 changed files with 203 additions and 15 deletions.
7 changes: 5 additions & 2 deletions API/Store/ASNs.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@ This allows you to create an advanced shipment notification
| expected_arrival_date | The date when the items are expected to arrive | Date | | NULL | N | N |
| goods_in_type | The goods in type for this ASN - `tbc` can only be used when status is `draft` | String | One of the following values: `20ft container`, `40ft container`, `40fthc container`, `carton`, `pallet`, `tbc` | NULL | Y | N |
| is_pickup_managed | Indicates whether or not the receiver is to pickup the items | Boolean | | false | N | N |
| notes | Notes related to this ASN | String | | NULL | N | N |
| pickup_from | A UTC datetime of when to pickup the items from; required when `is_pickup_managed` is `true` | Datetime | | NULL | N | Y |
| pickup_until | A UTC datetime of when to pickup the items until; required when `is_pickup_managed` is `true` | Datetime | | NULL | N | Y |
| reference | A unique reference used to identify the ASN | String | Up to 50 characters long | NULL | Y | N |
Expand Down Expand Up @@ -73,11 +74,12 @@ This allows you to update a specific advanced shipment notification
| expected_arrival_date | The date when the items are expected to arrive | Date | | NULL | N | N |
| goods_in_type | The goods in type for this ASN - `tbc` can only be used when status is `draft` | String | One of the following values: `20ft container`, `40ft container`, `40fthc container`, `carton`, `pallet`, `tbc` | NULL | Y | N |
| is_pickup_managed | Indicates whether or not the receiver is to pickup the items | Boolean | | false | N | N |
| notes | Notes related to this ASN | String | | NULL | N | N |
| pickup_from | A UTC datetime of when to pickup the items from; required when `is_pickup_managed` is `true` | Datetime | | NULL | N | Y |
| pickup_until | A UTC datetime of when to pickup the items until; required when `is_pickup_managed` is `true` | Datetime | | NULL | N | Y |
| received_at | A UTC datetime of when the items were received | Datetime | | NOW | N | N |
| reference | A unique reference used to identify the ASN | String | Up to 50 characters long | NULL | Y | N |
| status | The status of the ASN | String | One of the following values: `cancelled`, `completed`, `draft`, `in transit`, `pending`, `received` | draft | N | N |
| status | The status of the ASN | String | One of the following values: `cancelled`, `completed`, `draft`, `in transit`, `part received`, `pending`, `received` | draft | N | N |

## View Advanced Shipment Notifications
This allows you to list the advanced shipment notifications
Expand Down Expand Up @@ -106,11 +108,12 @@ This allows you to list the advanced shipment notifications
| expected_arrival_date | The date when the items are expected to arrive | Date | |
| goods_in_type | The goods in type for this ASN | String | One of the following values: `20ft container`, `40ft container`, `40fthc container`, `carton`, `pallet`, `tbc` |
| is_pickup_managed | Indicates whether or not the receiver is to pickup the items | Boolean | |
| notes | Notes related to this ASN | String | |
| pickup_from | A UTC datetime of when to pickup the items from | Datetime | |
| pickup_until | A UTC datetime of when to pickup the items until | Datetime | |
| received_at | A UTC datetime of when the items were received | Datetime | |
| reference | A unique reference used to identify the ASN | String | Up to 50 characters long |
| status | The status of the ASN | String | One of the following values: `cancelled`, `completed`, `draft`, `in transit`, `pending`, `received` |
| status | The status of the ASN | String | One of the following values: `cancelled`, `completed`, `draft`, `in transit`, `part received`, `pending`, `received` |
| supplier | The name of the Supplier | String | |
| supplier_id | A valid Supplier ID | Integer | |
| total_item_weight | The total item weight within the ASN | Integer | |
Expand Down
6 changes: 3 additions & 3 deletions API/Store/ASNs_Contents.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ This allows you to create contents for an adanced shipping notification
| items | An array of items - see [ASNs Contents Items](ASNs_Contents_Items.md#create-asns-contents-items) | Array | | NULL | N | N |
| length | The length of the content, in mm | Integer | Up to 10 digits long | NULL | N | N |
| tracking_number | The tracking number of the content | String | Up to 100 characters long | NULL | N | N |
| weight | The total weight of the content, including packaging, in g | Integer | Up to 10 digits long | NULL | N | N |
| weight | The total weight of the content, including outer packaging, excluding the items, in g | Integer | Up to 10 digits long | NULL | N | N |
| width | The width of the content, in mm | Integer | Up to 10 digits long | NULL | N | N |

## Delete Advanced Shipment Notification Contents
Expand All @@ -54,7 +54,7 @@ This allows you to update a specific content in an advanced shipment notificatio
| items | An array of items - see [ASNs Contents Items](ASNs_Contents_Items.md#update-asns-contents-items) | Array | | NULL | N | N |
| length | The length of the contents, in mm | Integer | Up to 10 digits long | NULL | N | N |
| tracking_number | The tracking number of the contents | String | Up to 100 characters long | NULL | N | N |
| weight | The total weight of the contents, including packaging, in g | Integer | Up to 10 digits long | NULL | N | N |
| weight | The total weight of the contents, including outer packaging, excluding the items, in g | Integer | Up to 10 digits long | NULL | N | N |
| width | The width of the contents, in mm | Integer | Up to 10 digits long | NULL | N | N |

## View Advanced Shipment Notification Contents
Expand Down Expand Up @@ -82,5 +82,5 @@ This allows you to list the contents belonging to the advanced shipment notifica
| total_units_rejected | The total number of units rejected within the contents | Integer | |
| total_weight | The total weight of everything within the contents | Integer | |
| tracking_number | The tracking number of the contents | String | Up to 100 characters long |
| weight | The total weight of the contents, including packaging, in g | Integer | Up to 10 digits long |
| weight | The total weight of the contents, including outer packaging, excluding the items, in g | Integer | Up to 10 digits long |
| width | The width of the contents, in mm | Integer | Up to 10 digits long |
8 changes: 4 additions & 4 deletions API/Store/ASNs_Contents_Items.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@ The below endpoints are available with this API

| Endpoint | Method | Description | |
| --- | --- | --- | --- |
| /asns/:asn/items/:item/contents | POST | This allows you to create items for an advanced shipment notification content | [Details](#create-advanced-shipment-notification-content-items) |
| /asns/:asn/items/:item/contents/:content | DELETE | This allows you to delete items from an advanced shipment notification content | [Details](#delete-advanced-shipment-notification-content-items) |
| /asns/:asn/contents/:content/items | POST | This allows you to create items for an advanced shipment notification content | [Details](#create-advanced-shipment-notification-content-items) |
| /asns/:asn/contents/:content/items/:item | DELETE | This allows you to delete items from an advanced shipment notification content | [Details](#delete-advanced-shipment-notification-content-items) |
| /asns/:asn/contents/:content/items/ | PUT | This allows you to update a specific item in an advanced shipment notification content | [Details](#update-advanced-shipment-notification-content-items) |
| /asns/:asn/contents/:content/items/:item | PUT | This allows you to update a specific item in an advanced shipment notification content | [Details](#update-advanced-shipment-notification-content-items) |
| /asns/:asn/contents/:content/items/ | GET | This allows you to list the items belonging to the advanced shipment notification content | [Details](#view-advanced-shipment-notification-content-items) |
Expand All @@ -17,7 +17,7 @@ The below endpoints are available with this API
## Create Advanced Shipment Notification Content Items
This allows you to create items for an advanced shipment notification content

**URL** : `/asns/:asn/items/:item/contents`
**URL** : `/asns/:asn/contents/:content/items`

**Method** : `POST`

Expand All @@ -38,7 +38,7 @@ This allows you to create items for an advanced shipment notification content
## Delete Advanced Shipment Notification Content Items
This allows you to delete items from an advanced shipment notification content

**URL** : `/asns/:asn/items/:item/contents/:content`
**URL** : `/asns/:asn/contents/:content/items/:item`

**Method** : `DELETE`

Expand Down
12 changes: 12 additions & 0 deletions API/Store/Customers.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,12 +30,16 @@ This allows you to create customers
| company_name | The customers company name | String | Up to 100 characters long | NULL | N | N |
| company_number | The customers company number | String | Up to 50 characters long | NULL | N | N |
| customer_group_id | A valid Customer Group ID | Integer | | NULL | N | N |
| customer_type | The type that the customer is | String | One of the following values: `b2b`, `b2c` | b2c | N | N |
| eori_number | The customers EORI number | String | Up to 20 characters long | NULL | N | N |
| eu_movement_risk | Indicates if orders are at risk of entering the EU, or not | Boolean | | false | N | N |
| marketplaces | An array of marketplaces that this customer belongs to - see [Customers Marketplaces](Customers_Marketplaces.md#create-customers-marketplaces) | Array | | NULL | N | N |
| profiles | An array of profiles that this customer belongs to - see [Customers Profiles](Customers_Profiles.md#create-customers-profiles) | Array | | NULL | N | N |
| requires_approvedorders | Indicates whether or not the customer requires orders to have approval being being processed | Boolean | | NULL | N | N |
| status | The status of the customer | String | One of the following values: `active`, `hold` | active | N | N |
| store_id | A valid Store ID | Integer | | NULL | Y | N |
| tax_class_id | A valid Tax Class ID | Integer | | NULL | N | N |
| ukims_number | The customers UKIMS number | String | Up to 40 characters long | NULL | N | N |
| vat_number | The customers VAT number | String | Up to 50 characters long | NULL | N | N |

## Delete Customer
Expand All @@ -62,10 +66,14 @@ This allows you to update customers
| company_name | The customers company name | String | Up to 100 characters long | NULL | N | N |
| company_number | The customers company number | String | Up to 50 characters long | NULL | N | N |
| customer_group_id | A valid Customer Group ID | Integer | | NULL | N | N |
| customer_type | The type that the customer is | String | One of the following values: `b2b`, `b2c` | b2c | N | N |
| eori_number | The customers EORI number | String | Up to 20 characters long | NULL | N | N |
| eu_movement_risk | Indicates if orders are at risk of entering the EU, or not | Boolean | | false | N | N |
| profiles | An array of profiles that this customer belongs to - see [Customers Profiles](Customers_Profiles.md#update-customers-profiles) | Array | | NULL | N | N |
| requires_approvedorders | Indicates whether or not the customer requires orders to have approval being being processed | Boolean | | NULL | N | N |
| status | The status of the customer | String | One of the following values: `active`, `hold` | active | N | N |
| tax_class_id | A valid Tax Class ID | Integer | | NULL | N | N |
| ukims_number | The customers UKIMS number | String | Up to 40 characters long | NULL | N | N |
| vat_number | The customers VAT number | String | Up to 50 characters long | NULL | N | N |

## View Customers
Expand All @@ -89,6 +97,9 @@ This allows you to list customers
| created_at | A UTC datetime of when the customer was created | Datetime | |
| customer_group | The name of the Customer Group | String | |
| customer_group_id | A valid Customer Group ID | Integer | |
| customer_type | The type that the customer is | String | One of the following values: `b2b`, `b2c` |
| eori_number | The customers EORI number | String | Up to 20 characters long |
| eu_movement_risk | Indicates if orders are at risk of entering the EU, or not | Boolean | |
| marketplaces | An array of marketplaces that this customer belongs to - see [Customers Marketplaces](Customers_Marketplaces.md#view-customers-marketplaces) | Array | |
| primary_first_name | The first name of the primary account holder | String | |
| primary_full_name | The full name of the primary account holder | String | |
Expand All @@ -101,5 +112,6 @@ This allows you to list customers
| store_id | A valid Store ID | Integer | |
| tax_class | The name of the Tax Class | String | Up to 100 characters long |
| tax_class_id | A valid Tax Class ID | Integer | |
| ukims_number | The customers UKIMS number | String | Up to 40 characters long |
| updated_at | A UTC datetime of when the customer was updated | Datetime | |
| vat_number | The customers VAT number | String | Up to 50 characters long |
16 changes: 16 additions & 0 deletions API/Store/Customers_Addresses.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,6 +28,8 @@ This allows you to create customer addresses
| company_name | The company name of where the addressee can be found | String | Between 1 and 100 characters long | NULL | N | N |
| country_iso2 | A valid ISO 2 letter country code | String | Exactly 2 characters long | NULL | Y | N |
| email | An email address relating to the address | String | Between 1 and 100 characters long | NULL | N | N |
| eori_number | The EORI number to use for this address, where null is provided the value from the customer record is used | String | Up to 20 characters long | NULL | N | N |
| eu_movement_risk | Indicates if orders are at risk of entering the EU, or not, where null is provided the value from the customer record is used | Boolean | | NULL | N | N |
| first_name | The first name of the addressee | String | Between 1 and 100 characters long | NULL | Y | N |
| is_default | Indicates whether the address is the default for the given address type | Boolean | | false | N | N |
| last_name | The last name of the addressee | String | Between 1 and 100 characters long | NULL | Y | N |
Expand All @@ -44,7 +46,9 @@ This allows you to create customer addresses
| skip_picky_checks | Skip picky checks | Boolean | | false | N | N |
| skip_province_postcode_check | When true, will validate postcode on a country-level, where available | Boolean | | false | N | N |
| title | The title of the addressee | String | One of the following values: `dr`, `fr`, `lady`, `lord`, `madam`, `master`, `miss`, `mr`, `mrs`, `ms`, `mx`, `prof`, `rev`, `sir` | NULL | N | N |
| ukims_number | The UKIMS number to use for this address, where null is provided the value from the customer record is used | String | Up to 40 characters long | NULL | N | N |
| use_profile_name | Indicates whether a profile name can override the title, first_name, and last_name fields | Boolean | | false | N | N |
| vat_number | The VAT number to use for this address, where null is provided the value from the customer record is used | String | Up to 20 characters long | NULL | N | N |

## Delete Customer Address
This allows you to delete a specified customer address
Expand All @@ -69,6 +73,8 @@ This allows you to update customer addresses
| company_name | The company name of where the addressee can be found | String | Between 1 and 100 characters long | NULL | N | N |
| country_iso2 | A valid ISO 2 letter country code | String | Exactly 2 characters long | NULL | Y | N |
| email | An email address relating to the address | String | Between 1 and 100 characters long | NULL | N | N |
| eori_number | The EORI number to use for this address, where null is provided the value from the customer record is used | String | Up to 20 characters long | NULL | N | N |
| eu_movement_risk | Indicates if orders are at risk of entering the EU, or not, where null is provided the value from the customer record is used | Boolean | | NULL | N | N |
| first_name | The first name of the addressee | String | Between 1 and 100 characters long | NULL | Y | N |
| is_default | Indicates whether the address is the default for the given address type | Boolean | | false | N | N |
| last_name | The last name of the addressee | String | Between 1 and 100 characters long | NULL | Y | N |
Expand All @@ -85,7 +91,9 @@ This allows you to update customer addresses
| skip_picky_checks | Skip picky checks | Boolean | | false | N | N |
| skip_province_postcode_check | When true, will validate postcode on a country-level, where available | Boolean | | false | N | N |
| title | The title of the addressee | String | One of the following values: `dr`, `fr`, `lady`, `lord`, `madam`, `master`, `miss`, `mr`, `mrs`, `ms`, `mx`, `prof`, `rev`, `sir` | NULL | N | N |
| ukims_number | The UKIMS number to use for this address, where null is provided the value from the customer record is used | String | Up to 40 characters long | NULL | N | N |
| use_profile_name | Indicates whether a profile name can override the title, first_name, and last_name fields | Boolean | | false | N | N |
| vat_number | The VAT number to use for this address, where null is provided the value from the customer record is used | String | Up to 20 characters long | NULL | N | N |

## View Customer Addresses
This allows you to list customer addresses
Expand All @@ -105,10 +113,16 @@ This allows you to list customer addresses
| country_iso2 | A valid ISO 2 letter country code | String | Exactly 2 characters long |
| created_at | A UTC datetime of when the address was created | Datetime | |
| email | An email address relating to the address | String | Between 1 and 100 characters long |
| eori_number | The EORI number to use for this address | String | Up to 20 characters long |
| eu_movement_risk | Indicates if orders are at risk of entering the EU, or not, where null is provided the value from the customer record is used | Boolean | |
| first_name | The first name of the addressee | String | Between 1 and 100 characters long |
| full_name | The full name of the addressee | String | Between 3 and 201 characters long |
| hash | A hash of the address | String | Exactly 64 characters long |
| is_default | Indicates whether the address is the default for the given address type | Boolean | |
| is_eori_number_default | Indicates whether the default customer EORI number is used, or not | Boolean | |
| is_eu_movement_risk_default | Indicates whether the default customer EU movement risk flag is used, or not | Boolean | |
| is_ukims_number_default | Indicates whether the default customer UKIMS number is used, or not | Boolean | |
| is_vat_number_default | Indicates whether the default customer VAT number is used, or not | Boolean | |
| last_name | The last name of the addressee | String | Between 1 and 100 characters long |
| line1 | The first line of the address | String | Between 1 and 200 characters long |
| line2 | The second line of the address | String | Between 1 and 200 characters long |
Expand All @@ -122,5 +136,7 @@ This allows you to list customer addresses
| province_iso | An ISO code for the province/state/county | String | Up to 10 characters long |
| reference | A unique reference for this customer address | String | Exactly 10 characters long |
| title | The title of the addressee | String | One of the following values: `dr`, `miss`, `mr`, `mrs`, `ms`, `mx` |
| ukims_number | The UKIMS number to use for this address | String | Up to 40 characters long |
| updated_at | A UTC datetime of when the address was updated | Datetime | |
| use_profile_name | Indicates whether a profile name can override the title, first_name, and last_name fields | Boolean | |
| vat_number | The VAT number to use for this address | String | Up to 20 characters long |
Loading

0 comments on commit 100fc46

Please sign in to comment.