diff --git a/API/Store/ASNs.md b/API/Store/ASNs.md index ffa3d63aa..afe19f4b3 100644 --- a/API/Store/ASNs.md +++ b/API/Store/ASNs.md @@ -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 | @@ -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 @@ -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 | | diff --git a/API/Store/ASNs_Contents.md b/API/Store/ASNs_Contents.md index 9bef3ea56..5475392df 100644 --- a/API/Store/ASNs_Contents.md +++ b/API/Store/ASNs_Contents.md @@ -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 @@ -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 @@ -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 | diff --git a/API/Store/ASNs_Contents_Items.md b/API/Store/ASNs_Contents_Items.md index 7a24c192a..430200c6e 100644 --- a/API/Store/ASNs_Contents_Items.md +++ b/API/Store/ASNs_Contents_Items.md @@ -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) | @@ -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` @@ -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` diff --git a/API/Store/Customers.md b/API/Store/Customers.md index edf3f9565..0f61f5057 100644 --- a/API/Store/Customers.md +++ b/API/Store/Customers.md @@ -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 @@ -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 @@ -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 | | @@ -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 | diff --git a/API/Store/Customers_Addresses.md b/API/Store/Customers_Addresses.md index 14056023a..21e22a033 100644 --- a/API/Store/Customers_Addresses.md +++ b/API/Store/Customers_Addresses.md @@ -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 | @@ -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 @@ -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 | @@ -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 @@ -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 | @@ -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 | diff --git a/API/Store/Orders.md b/API/Store/Orders.md index 30381d574..d118401ee 100644 --- a/API/Store/Orders.md +++ b/API/Store/Orders.md @@ -35,6 +35,7 @@ This allows you to create an order | despatch_partorders | Indicates whether orders should be dispatched asap, regardless of if all items are available | Boolean | | 0 | N | N | | discount_tax | The total amount of tax the recipient saves, due to discounts | Float | Up to 2 decimal places and no larger than 99999999.99 | 0.00 | N | N | | gift_message | A gift message from the customer if the order is a gift order | String | Up to 255 characters long | NULL | N | N | +| globale_reference | Where an order is being sent via Global-e, provide the Global-e reference | String | Up to 20 characters long | NULL | N | N | | group_sameaddress | Indicates whether orders going to the same address should be grouped, or not | Boolean | | 0 | N | N | | groupings | An array of groupings belonging to this order - see [Orders Groupings](Orders_Groupings.md#create-orders-groupings) | Array | | NULL | N | N | | instructions | Any instructions for filtering | String | | NULL | N | N | @@ -42,9 +43,12 @@ This allows you to create an order | is_amazon_premium | Indicates whether an order is an Amazon Premium order, or not | Boolean | | 0 | N | N | | is_amazon_prime | Indicates whether an order is an Amazon Prime order, or not | Boolean | | 0 | N | N | | is_amazon_selflabeller | Indicates whether an order is an Amazon order that needs to be self labelled, or not | Boolean | | 0 | N | N | +| is_b2b | Indicates whether the order is a B2B order, or not | Boolean | | 0 | N | N | | is_fbaprep | Indicates whether an order is for FBA prep, or not | Boolean | | 0 | N | N | | is_gift | Indicates whether an order is a gift, or not | Boolean | | 0 | N | N | | is_priority | Indicates whether the order should be given priority over other orders, or not | Boolean | | 0 | N | N | +| is_resend | Indicates whether the order is an order that has been resent, or not | Boolean | | 0 | N | N | +| is_test | Indicates whether an order is a test order, or not | Boolean | | 0 | N | N | | marketplace_id | A valid Marketplace ID | Integer | | NULL | N | N | | marketplace_order_number | The Order Number as provided by the Marketplace | String | Between 1 and 255 characters long | NULL | N | N | | notes | Any extra notes pertaining to the order | String | | NULL | N | N | @@ -59,6 +63,7 @@ This allows you to create an order | reference_id | A reference that corresponds to a Marketplace Order ID | String | Between 1 and 255 characters long | NULL | N | N | | requires_booking | Indicates whether the order should be a booking or not | Boolean | | 0 | N | N | | resend_order_id | Where the order is a resend, the original Order ID | Integer | | NULL | N | N | +| resend_reason | The reason why a resend is being sent out, only when `is_resend` is true | String | One of the following values: `unknown`, `shipment not received`, `item not received`, `shipment damaged`, `item damaged`, `item defective` | unknown | N | Y | | risk_score | A score related to the risk an order contains - the lower the score, the lower the risk | Integer | Up to 4 digits long | 0 | N | N | | shipment_reference | A Shipment Reference that has been provided by the customer for the order | String | Up to 50 characters long | NULL | N | N | | shipping_method_code | The code of the shipping method | String | Up to 20 characters long | NULL | Y | N | @@ -104,13 +109,16 @@ This allows you to update a specific order | despatch_partorders | Indicates whether orders should be dispatched asap, regardless of if all items are available | Boolean | | 0 | N | N | | discount_tax | The total amount of tax the recipient saves, due to discounts | Float | Up to 2 decimal places and no larger than 99999999.99 | 0.00 | N | N | | gift_message | A gift message from the customer if the order is a gift order | String | Up to 255 characters long | NULL | N | N | +| globale_reference | Where an order is being sent via Global-e, provide the Global-e reference | String | Up to 20 characters long | NULL | N | N | | group_sameaddress | Indicates whether orders going to the same address should be grouped, or not | Boolean | | 0 | N | N | | groupings | An array of groupings belonging to this order - see [Orders Groupings](Orders_Groupings.md#update-orders-groupings) | Array | | NULL | N | N | | instructions | Any instructions for filtering | String | | NULL | N | N | | ioss_number | A valid IOSS number if the order will be sent this way | String | Exactly 12 characters long | NULL | N | N | +| is_b2b | Indicates whether the order is a B2B order, or not | Boolean | | 0 | N | N | | is_fbaprep | Indicates whether an order is for FBA prep, or not | Boolean | | 0 | N | N | | is_gift | Indicates whether an order is a gift, or not | Boolean | | 0 | N | N | | is_priority | Indicates whether the order should be given priority over other orders, or not | Boolean | | 0 | N | N | +| is_test | Indicates whether an order is a test order, or not | Boolean | | 0 | N | N | | notes | Any extra notes pertaining to the order | String | | NULL | N | N | | packing_instructions | The instructions for the packing of the order | String | | NULL | N | N | | processed_at | A valid UTC datetime of when the order was last processed | Datetime | | NULL | N | N | @@ -158,6 +166,7 @@ This allows you to list orders | first_name | The first name of the customer | String | Up to 255 characters long | | full_name | The full name of the customer | String | Up to 255 characters long | | gift_message | Message from the buyer if the order is a gift | String | Up to 255 characters long | +| globale_reference | Where an order is being sent via Global-e, provide the Global-e reference | String | Up to 20 characters long | | group_sameaddress | Indicates whether orders going to the same address should be grouped, or not | Boolean | | | groupings | An array of groupings belonging to this order - see [Orders Groupings](Orders_Groupings.md#view-orders-groupings) | Array | | | has_resends | Indicates whether the order has been resent | Boolean | | @@ -166,11 +175,13 @@ This allows you to list orders | is_amazon_premium | Indicates whether an order is an Amazon Premium order, or not | Boolean | | | is_amazon_prime | Indicates whether an order is an Amazon Prime order, or not | Boolean | | | is_amazon_selflabeller | Indicates whether an order is an Amazon order that needs to be self labelled, or not | Boolean | | +| is_b2b | Indicates whether the order is a B2B order, or not | Boolean | | | is_fbaprep | Indicates whether an order is for FBA prep, or not | Boolean | | | is_gift | Indicates whether an order is a gift, or not | Boolean | | | is_priority | Indicates whether the order should be given priority over other orders, or not | Boolean | | | is_resend | Indicates whether the order is an order that has been resent | Boolean | | | is_subscription | Indicates whether the order is part of a subscription | Boolean | | +| is_test | Indicates whether the order is a test order, or not | Boolean | | | last_name | The last name of the customer | String | Up to 255 characters long | | marketplace | The name of the marketplace from which the order came from | String | Up to 20 characters long | | marketplace_id | A valid Marketplace ID | Integer | | @@ -191,6 +202,7 @@ This allows you to list orders | reference_id | A reference that corresponds to a Marketplace Order ID | String | Between 1 and 255 characters long | | requires_booking | Indicates whether the order should be a booking or not | Boolean | | | resend_order_id | Where the order is a resend, the original Order ID | Integer | | +| resend_reason | The reason why a resend is being sent out | String | One of the following values: `unknown`, `shipment not received`, `item not received`, `shipment damaged`, `item damaged`, `item defective` | | risk_score | A score related to the risk an order contains - the lower the score, the lower the risk | Integer | Up to 4 digits long | | shipment_reference | A Shipment Reference that has been provided by the customer for the order | String | Up to 50 characters long | | shipping_method_code | The code of the shipping method | String | Up to 20 characters long | diff --git a/API/Store/Orders_Addresses.md b/API/Store/Orders_Addresses.md index 54cf83ccb..13c414db1 100644 --- a/API/Store/Orders_Addresses.md +++ b/API/Store/Orders_Addresses.md @@ -27,7 +27,10 @@ This allows you to create an address for an order | city | The city or town | String | Between 1 and 100 characters long | NULL | Y | N | | company_name | The name of the company where the recipient 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 | +| ebay_vtn | The ebay VTN number related to the address | String | Up to 11 characters long | NULL | N | N | | email | An email address to contact the recipient with | String | | NULL | N | N | +| eori_number | The EORI number related to this address | String | Up to 20 characters long | NULL | N | N | +| eu_movement_risk | Indicates if the order is at risk of entering the EU, or not | Boolean | | NULL | N | N | | first_name | The first name of the recipient | String | Between 1 and 100 characters long | NULL | Y | N | | last_name | The last name/family name of the recipient | String | Between 1 and 100 characters long | NULL | Y | N | | line1 | First line of addresses | String | Between 1 and 200 characters long | NULL | Y | N | @@ -43,6 +46,7 @@ This allows you to create an address for an order | skip_picky_checks | Skip picky checks - will not run if skip_checks is false | Boolean | | false | N | N | | skip_province_postcode_check | When true, will validate postcode on a country-level, where available - will not run if skip_checks is false | Boolean | | false | N | N | | title | The title of the recipient | 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 related to this address | String | Up to 40 characters long | NULL | N | N | | vat_number | The VAT number related to the address | String | Up to 20 characters long | NULL | N | N | ## Delete Order Addresses @@ -66,7 +70,10 @@ This allows you to update a specific address in an order | city | The city or town | String | Between 1 and 100 characters long | NULL | Y | N | | company_name | The name of the company where the recipient 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 | +| ebay_vtn | The ebay VTN number related to the address | String | Up to 11 characters long | NULL | Y | N | | email | An email address to contact the recipient with | String | | NULL | N | N | +| eori_number | The EORI number related to this address | String | Up to 20 characters long | NULL | N | N | +| eu_movement_risk | Indicates if the order is at risk of entering the EU, or not | Boolean | | NULL | N | N | | first_name | The first name of the recipient | String | Between 1 and 100 characters long | NULL | Y | N | | last_name | The last name/family name of the recipient | String | Between 1 and 100 characters long | NULL | Y | N | | line1 | First line of addresses | String | Between 1 and 200 characters long | NULL | Y | N | @@ -82,6 +89,7 @@ This allows you to update a specific address in an order | skip_picky_checks | Skip picky checks - will not run if skip_checks is false | Boolean | | false | N | N | | skip_province_postcode_check | When true, will validate postcode on a country-level, where available - will not run if skip_checks is false | Boolean | | false | N | N | | title | The title of the recipient | 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 related to this address | String | Up to 40 characters long | NULL | N | N | | vat_number | The VAT number related to the address | String | Up to 20 characters long | NULL | N | N | ## View Order Addresses @@ -100,7 +108,10 @@ This allows you to list the addresses belonging to the order | company_name | The name of the company where the recipient can be found | String | Between 1 and 100 characters long | | country | The name of the country | String | Up to 255 characters long | | country_iso2 | A ISO 2 letter country code | String | Exactly 2 characters long | +| ebay_vtn | The ebay VTN related to the address | String | Up to 11 characters long | | email | An email address to contact the recipient with | String | Up to 100 characters long | +| eori_number | The EORI number related to this address | String | Up to 20 characters long | +| eu_movement_risk | Indicates if the order is at risk of entering the EU, or not | Boolean | | | first_name | The first name of the recipient | String | Between 1 and 100 characters long | | full_name | The full name of the recipient | String | Between 3 and 201 characters long | | hash | A hash of the address | String | Exactly 64 characters long | @@ -115,4 +126,5 @@ This allows you to list the addresses belonging to the order | province_code | The code for the province/state/county | String | Up to 10 characters long | | province_iso | An ISO code for the province/state/county | String | Up to 10 characters long | | title | The title of the recipient | String | One of the following values: `Dr`, `Fr`, `Lady`, `Lord`, `Madam`, `Master`, `Miss`, `Mr`, `Mrs`, `Ms`, `Mx`, `Prof`, `Rev`, `Sir` | +| ukims_number | The UKIMS number related to this address | String | Up to 40 characters long | | vat_number | The VAT number related to the address | String | Up to 20 characters long | diff --git a/API/Store/Orders_Groupings_Items.md b/API/Store/Orders_Groupings_Items.md index 985bc0c63..5996c223d 100644 --- a/API/Store/Orders_Groupings_Items.md +++ b/API/Store/Orders_Groupings_Items.md @@ -44,6 +44,7 @@ This allows you to create an order grouping item | properties | A JSON encoded array of properties related to the item | String | | NULL | N | N | | quantity_ordered | The total number of this item ordered | Integer | Up to 10 digits long | 0 | Y | N | | reference_id | A reference that corresponds to a Marketplace Order Item ID | String | Between 1 and 255 characters long | NULL | N | N | +| requires_rework | Indicates whether the item requires rework, or not | Boolean | | false | N | N | | tax_rate | The rate of tax | Float | Up to 2 decimal places and no larger than 99999999.99 | 0.00 | N | N | | unit_discount | The total discount, including tax, given on one item, ignored if `is_unit_pricing` is false | Float | Up to 2 decimal places and no larger than 99999999.99 | 0.00 | N | Y | | unit_discount_tax | The amount of tax that has been discounted given on one item, ignored if `is_unit_pricing` is false | Float | Up to 2 decimal places and no larger than 99999999.99 | 0.00 | N | Y | @@ -112,6 +113,7 @@ This allows you to list the order grouping items | image_url | The relative URL to the product variant image | String | | | is_exchangeable | Indicates whether the item is exchangeable, or not | Boolean | | | is_gift | Indicates whether the item is a gift, or not | Boolean | | +| is_physical | Indicates whether the item is physical, or not | Boolean | | | is_returnable | Indicates whether the item is returnable, or not | Boolean | | | is_wrapped | Indicates whether the item should be wrapped, or not | Boolean | | | line_discount | The total discount, including tax, given on the line for the items | Float | Up to 2 decimal places and no larger than 99999999.99 | @@ -132,6 +134,7 @@ This allows you to list the order grouping items | quantity_returning | The total number units of this item being returned | Integer | Up to 10 digits long | | reference | A unique reference for this item | String | Exactly 10 characters long | | reference_id | A reference that corresponds to a Marketplace Order Item ID | String | Between 1 and 255 characters long | +| requires_rework | Indicates whether the item requires rework, or not | Boolean | | | sku | The original SKU of the ordered item | String | Up to 200 characters long | | status | The fulfillment status of the item | String | One of the following values: `closed`, `open` | | tax_rate | The rate of tax | Float | Up to 2 decimal places and no larger than 99999999.99 | diff --git a/API/Store/Products.md b/API/Store/Products.md index c6335f07c..79ee99fc8 100644 --- a/API/Store/Products.md +++ b/API/Store/Products.md @@ -173,6 +173,7 @@ This allows you to list products in the warehouse | is_liquid | Indicates whether the product is a liquid, or not | Boolean | | | is_physical | Indicates whether the product is a physical product, or not | Boolean | | | is_returnable | Indicates whether the product is returnable, or not | Boolean | | +| marketplace_ids | A list of Marketplace IDs that the product features within | String | | | media_id | A valid Media ID - this will be used for the featured product image, search results, etc | Integer | | | name | The name of the product | String | Up to 100 characters long | | page_description | Used for SEO, the description of the page - uses description when not set | String | | diff --git a/API/Store/Shipments.md b/API/Store/Shipments.md index 7f3df75c9..b07d8d197 100644 --- a/API/Store/Shipments.md +++ b/API/Store/Shipments.md @@ -31,9 +31,12 @@ This allows you to create a shipment | currency | The ISO 3 character currency code that the order was purchased in | String | Exactly 3 characters long | GBP | N | N | | customer_id | A valid Customer ID | Integer | | NULL | N | N | | customs_duty_terms | Customs duty terms | String | Up to 4 characters long | NULL | N | N | -| eori | EORI | String | Up to 20 characters long | NULL | N | N | +| eori | The EORI of the sender | String | Up to 20 characters long | NULL | N | N | +| eori_recipient | The EORI of the recipient | String | Up to 20 characters long | NULL | N | N | | est_delivery_date | The estimated delivery date of the shipment | Date | | NULL | N | N | +| eu_movement_risk | Indicates if the shipment is at risk of entering the EU, or not | Boolean | | false | N | N | | ioss_number | The IOSS Number used for the shipment | String | Exactly 12 characters long | NULL | N | N | +| is_b2b | Indicates whether the shipment is a B2B shipment, or not | Boolean | | 0 | N | N | | is_pallet | Indicates whether the shipment is a pallet shipment, or not | Boolean | | 0 | N | N | | is_returns | Indicates whether the shipment is a returns shipment, or not | Boolean | | 0 | N | N | | is_selflabelled | Indicates whether the shipment is self labelled, or not. | Boolean | | 0 | N | N | @@ -42,9 +45,13 @@ This allows you to create a shipment | owner_type | The type of Owner | String | One of the following values: `order`, `return` | NULL | Y | N | | pallets | An array of pallets for the shipment - see [Shipments Pallets](Shipments_Pallets.md#create-shipments-pallets) | Array | | NULL | N | N | | parcels | An array of parcels for the shipment - see [Shipments Parcels](Shipments_Parcels.md#create-shipments-parcels) | Array | | NULL | N | N | +| returnslabel_courier_name | The name of the courier providing the returns label | String | Up to 30 characters long | NULL | N | N | +| returnslabel_tracking_code | The tracking code of the returns label | String | Up to 100 characters long | NULL | N | N | | shipment_reference | The reference that was given to the shipment | String | Up to 50 characters long | NULL | N | N | | shipped_at | A UTC datetime of when the shipment was shipped | Datetime | | NULL | N | N | -| status | The status of the shipment | String | One of the following values: `despatched`, `open` | NULL | N | N | +| status | The status of the shipment | String | One of the following values: `despatched`, `labelled`, `open` | NULL | N | N | +| ukims_recipient | The UKIMS number of the recipient | String | Up to 40 characters long | NULL | N | N | +| ukims_sender | The UKIMS number of the sender | String | Up to 40 characters long | NULL | N | N | | updated_at | A UTC datetime of when the shipment was updated | Datetime | | NULL | N | N | | vat_recipient | The VAT number of the recipient | String | Up to 20 characters long | NULL | N | N | | vat_sender | The VAT number of the sender | String | Up to 20 characters long | NULL | N | N | @@ -73,9 +80,11 @@ This allows you to update a specific shipment | est_delivery_date | The estimated delivery date of the shipment | Date | | NULL | N | N | | pallets | An array of pallets for the shipment - see [Shipments Pallets](Shipments_Pallets.md#update-shipments-pallets) | Array | | NULL | N | N | | parcels | An array of parcels for the shipment - see [Shipments Parcels](Shipments_Parcels.md#update-shipments-parcels) | Array | | NULL | N | N | +| returnslabel_courier_name | The name of the courier providing the returns label | String | Up to 30 characters long | NULL | N | N | +| returnslabel_tracking_code | The tracking code of the returns label | String | Up to 100 characters long | NULL | N | N | | shipment_reference | The reference that was given to the shipment | String | Up to 50 characters long | NULL | N | N | | shipped_at | The date and time the order was marked as shipped | Datetime | | NULL | N | N | -| status | The status of the shipment | String | One of the following values: `open`, `despatched` | NULL | N | N | +| status | The status of the shipment | String | One of the following values: `cancelled`, `despatched`, `labelled`, `open` | NULL | N | N | ## View Shipments This allows you to list the shipments belonging to the fulfillment @@ -96,9 +105,13 @@ This allows you to list the shipments belonging to the fulfillment | currency | The ISO 3 character currency code that the order was purchased in | String | Exactly 3 characters long | | customer_id | A valid Customer ID | Integer | | | customs_duty_terms | Customs duty terms | String | Up to 4 characters long | -| eori | EORI | String | Up to 20 characters long | +| eori | The EORI of the sender | String | Up to 20 characters long | +| eori_recipient | The EORI of the recipient | String | Up to 20 characters long | | est_delivery_date | The estimated delivery date of the shipment | Date | | +| eu_movement_risk | Indicates if the shipment is at risk of entering the EU, or not | Boolean | | | ioss_number | The IOSS Number used for the shipment | String | Exactly 12 characters long | +| is_b2b | Indicates whether the shipment is a B2B shipment, or not | Boolean | | +| is_customer_notified | Indicates whether the customer has been fully notified about the shipment, or not | Boolean | | | is_pallet | Indicates whether the shipment is a pallet shipment, or not | Boolean | | | is_returns | Indicates whether the shipment is a returns shipment, or not | Boolean | | | is_selflabelled | Indicates whether the shipment is self labelled, or not | Boolean | | @@ -108,9 +121,11 @@ This allows you to list the shipments belonging to the fulfillment | pallets | An array of pallets for the shipment - see [Shipments Pallets](Shipments_Pallets.md#view-shipments-pallets) | Array | | | parcels | An array of parcels for the shipment - see [Shipments Parcels](Shipments_Parcels.md#view-shipments-parcels) | Array | | | reference | A unique reference for this shipment | String | Exactly 10 characters long | +| returnslabel_courier_name | The name of the courier providing the returns label | String | Up to 30 characters long | +| returnslabel_tracking_code | The tracking code of the returns label | String | Up to 100 characters long | | shipment_reference | The reference that was given to the shipment | String | Up to 50 characters long | | shipped_at | A UTC datetime of when the shipment was shipped | Datetime | | -| status | The status of the shipment | String | One of the following values: `despatched`, `open` | +| status | The status of the shipment | String | One of the following values: `cancelled`, `despatched`, `labelled`, `open` | | store_id | A valid Store ID | Integer | | | total_items | The total number of unique items in the shipment | Integer | Up to 10 digits long | | total_pallet_weight | The weight of all the pallets in the shipment, including packaging, in grams | Integer | Up to 10 digits long | @@ -123,6 +138,8 @@ This allows you to list the shipments belonging to the fulfillment | total_units | The total number of units in the shipment | Integer | Up to 10 digits long | | total_uom_units | The total number of units in the shipment, in Unit of Measure terms | Integer | Up to 10 digits long | | total_weight | The total weight of all the items in the shipment, in grams | Integer | Up to 10 digits long | +| ukims_recipient | The UKIMS number of the recipient | String | Up to 40 characters long | +| ukims_sender | The UKIMS number of the sender | String | Up to 40 characters long | | updated_at | A UTC datetime of when the shipment was updated | Datetime | | | vat_recipient | The VAT number of the recipient | String | Up to 20 characters long | | vat_sender | The VAT number of the sender | String | Up to 20 characters long | diff --git a/API/Store/Shipments_Pallets.md b/API/Store/Shipments_Pallets.md index d574ee25f..4610f929d 100644 --- a/API/Store/Shipments_Pallets.md +++ b/API/Store/Shipments_Pallets.md @@ -82,6 +82,7 @@ This allows you to list the pallets belonging to a shipment | has_itemwithbattery | Indicates whether the pallet contains an item with a battery, or not | Boolean | | | has_liquid | Indicates whether the pallet contains a liquid item, or not | Boolean | | | height | The height of the pallet, in millimetres | Integer | Up to 10 digits long | +| is_customer_notified | Indicates whether the customer has been notified about the pallet, or not | Boolean | | | label_file | The name of the saved file for the shipping label | String | | | length | The length of the pallet, in millimetres | Integer | Up to 10 digits long | | pallet_number | The pallet number, must be unique to the shipment | Integer | Up to 3 digits long | diff --git a/API/Store/Shipments_Parcels.md b/API/Store/Shipments_Parcels.md index ecf9f971a..a58e3e2e9 100644 --- a/API/Store/Shipments_Parcels.md +++ b/API/Store/Shipments_Parcels.md @@ -37,6 +37,8 @@ This allows you to add parcels to a shipment | label_data | A base 64 encoded string of the label. Maximum file size: 5MB. Accepted attachment extensions include: .gif, .jpg, & .png | String | | NULL | N | N | | length | The length of the parcel, in millimetres | Integer | Up to 10 digits long | NULL | Y | N | | parcel_number | The parcel number, must be unique to the shipment | Integer | Up to 3 digits long | 1 | N | N | +| returnslabel_courier_name | The name of the courier providing the returns label | String | Up to 30 characters long | NULL | N | N | +| returnslabel_tracking_code | The tracking code of the returns label | String | Up to 100 characters long | NULL | N | N | | tracking_code | The couriers tracking code, if the parcel can be tracked | String | Up to 100 characters long | NULL | N | N | | tracking_status | The current tracking status of the parcel - can only be provided when tracking_code has a value | String | Up to 100 characters long | NULL | N | Y | | weight | The weight of the parcel, including packaging, in grams | Integer | Up to 10 digits long | NULL | Y | N | @@ -70,6 +72,8 @@ This allows you to update a specific shipment parcel | has_liquid | Indicates whether the parcel contains a liquid item, or not | Boolean | | false | N | N | | items | An array of items for the shipment parcel - see [Shipments Parcels Items](Shipments_Parcels_Items.md#update-shipments-parcels-items) | Array | | NULL | N | N | | label_data | A base 64 encoded string of the label. Maximum file size: 5MB. Accepted attachment extensions include: .gif, .jpg, & .png | String | | NULL | N | N | +| returnslabel_courier_name | The name of the courier providing the returns label | String | Up to 30 characters long | NULL | N | N | +| returnslabel_tracking_code | The tracking code of the returns label | String | Up to 100 characters long | NULL | N | N | | status | The status of the parcel | String | One of the following values: `closed`, `open`, `packed` | NULL | Y | N | | tracking_code | The couriers tracking code, if the parcel can be tracked | String | Up to 100 characters long | NULL | N | N | | tracking_status | The current tracking status of the parcel - can only be provided when tracking_code has a value | String | Up to 100 characters long | NULL | N | Y | @@ -95,11 +99,14 @@ This allows you to list the parcels belonging to a shipment | has_hazardous | Indicates whether the parcel contains a hazardous item, or not | Boolean | | | has_itemwithbattery | Indicates whether the parcel contains an item with a battery, or not | Boolean | | | has_liquid | Indicates whether the parcel contains a liquid item, or not | Boolean | | +| is_customer_notified | Indicates whether the customer has been notified about the parcel, or not | Boolean | | | is_mixed | Indicates whether the parcel contains mixed items, or not | Boolean | | | items | An array of items for the shipment parcel - see [Shipments Parcels Items](Shipments_Parcels_Items.md#view-shipments-parcels-items) | Array | | | label_file | The name of the saved file for the shipping label | String | | | length | The length of the parcel, in millimetres | Integer | Up to 10 digits long | | parcel_number | The parcel number, must be unique to the shipment | Integer | Up to 3 digits long | +| returnslabel_courier_name | The name of the courier providing the returns label | String | Up to 30 characters long | +| returnslabel_tracking_code | The tracking code of the returns label | String | Up to 100 characters long | | shipment_reference | The unique reference for the shipment this parcel belongs to | String | Exactly 10 characters long | | status | The status of the parcel | String | One of the following values: `closed`, `open`, `packed` | | total_parcel_weight | The weight of all the items and packaging in the parcel, in grams | Integer | Up to 10 digits long | diff --git a/API/Store/Shipments_Parcels_Items.md b/API/Store/Shipments_Parcels_Items.md index 8b762e035..0968aa61d 100644 --- a/API/Store/Shipments_Parcels_Items.md +++ b/API/Store/Shipments_Parcels_Items.md @@ -30,6 +30,8 @@ This allows you to add items to a shipment parcel | product_type | The type of product, used for customs declarations | String | Up to 100 characters long | NULL | N | N | | properties | A JSON encoded array of properties related to the item | String | | NULL | N | N | | quantity | The quantity of units of this item within the parcel | Integer | Up to 10 digits long | NULL | Y | N | +| returnslabel_courier_name | The name of the courier providing the returns label | String | Up to 30 characters long | NULL | N | N | +| returnslabel_tracking_code | The tracking code of the returns label | String | Up to 100 characters long | NULL | N | N | | sku | The SKU of the item | String | Up to 255 characters long | NULL | N | N | | unit_price | The price of one unit of this item, inclusive of taxes, etc | Float | Up to 4 decimal places and no larger than 99999999.9999 | NULL | Y | N | | unit_tax | The tax of one unit of this item | Float | Up to 4 decimal places and no larger than 99999999.9999 | NULL | Y | N | @@ -53,6 +55,8 @@ This allows you to update a specific shipment parcel item | manufactured_country_iso2 | A valid ISO 2 Country Code showing where the item was manufactured, used for customs declarations | String | Exactly 2 characters long | NULL | N | N | | product_type | The type of product, used for customs declarations | String | Up to 100 characters long | NULL | N | N | | quantity | The quantity of units of this item within the parcel | Integer | Up to 10 digits long | NULL | Y | N | +| returnslabel_courier_name | The name of the courier providing the returns label | String | Up to 30 characters long | NULL | N | N | +| returnslabel_tracking_code | The tracking code of the returns label | String | Up to 100 characters long | NULL | N | N | | sku | The SKU of the item | String | Up to 255 characters long | NULL | N | N | ## View Shipment Parcel Items @@ -80,6 +84,8 @@ This allows you to list the items belonging to a shipment parcel | product_type | The type of product, used for customs declarations | String | Up to 100 characters long | | properties | A JSON encoded array of properties related to the item | String | | | quantity | The quantity of units of this item within the parcel | Integer | Up to 10 digits long | +| returnslabel_courier_name | The name of the courier providing the returns label | String | Up to 30 characters long | +| returnslabel_tracking_code | The tracking code of the returns label | String | Up to 100 characters long | | serial_number | A comma seperated list of serial numbers | String | | | sku | The SKU of the item | String | Up to 255 characters long | | total_price | The total price of all the units of this item, inclusive of taxes, etc | Float | Up to 2 decimal places and no larger than 99999999.99 | diff --git a/API/Store/Stores.md b/API/Store/Stores.md index 992a2d4f8..dca4843c8 100644 --- a/API/Store/Stores.md +++ b/API/Store/Stores.md @@ -25,7 +25,9 @@ This allows you to create a store | --- | --- | --- | --- | --- | --- | --- | | domain_id | The Domain ID that the store uses | Integer | | NULL | Y | N | | name | The name of the store | String | Up to 100 characters long | NULL | Y | N | +| offline_message | An offline message to show when the store is restricted | String | Up to 200 characters long | NULL | N | N | | settings | An array containing the stores settings - see [Stores Settings](Stores_Settings.md#create-stores-settings) | Array | | NULL | Y | N | +| status | The status of the store | String | One of the following values: `active`, `restricted` | active | N | N | | theme | The theme that the store uses | String | Up to 100 characters long | NULL | Y | N | | uses_domain | Indicates whether the Store uses a domain, or not | Boolean | | true | N | N | @@ -49,7 +51,9 @@ This allows you to update a specific store | --- | --- | --- | --- | --- | --- | --- | | domain_id | The Domain ID that the store uses | Integer | | NULL | Y | N | | name | The name of the store | String | Up to 100 characters long | NULL | Y | N | +| offline_message | An offline message to show when the store is restricted | String | Up to 200 characters long | NULL | N | N | | settings | An array containing the stores settings - see [Stores Settings](Stores_Settings.md#update-stores-settings) | Array | | NULL | Y | N | +| status | The status of the store | String | One of the following values: `active`, `restricted` | active | N | N | | theme | The theme that the store uses | String | Up to 100 characters long | NULL | Y | N | | uses_domain | Indicates whether the Store uses a domain, or not | Boolean | | true | N | N | @@ -71,13 +75,14 @@ This allows you to view a list of stores | domain_id | The Domain ID that the store uses | Integer | | | login_domain | The domain name for Login access | String | Up to 200 characters long | | name | The name of the store | String | Up to 100 characters long | +| offline_message | An offline message to show when the store is restricted | String | Up to 200 characters long | | pages | An array containing the stores pages - see [Stores Pages](Stores_Pages.md#view-stores-pages) | Array | | | paymentmethods | An array containing the stores payment methods - see [Stores Payment Methods](Stores_Payment_Methods.md#view-stores-payment-methods) | Array | | | reference | A unique reference for this store | String | Exactly 10 characters long | | returnsreasons | An array containing the stores returns reasons - see [Stores Returns Reasons](Stores_Returns_Reasons.md#view-stores-returns-reasons) | Array | | | settings | An array containing the stores settings - see [Stores Settings](Stores_Settings.md#view-stores-settings) | Array | | | shippingmethods | An array containing the stores shipping methods - see [Stores Shipping Methods](Stores_Shipping_Methods.md#view-stores-shipping-methods) | Array | | -| status | The status of the store | String | Must have the value: `active` | +| status | The status of the store | String | One of the following values: `active`, `restricted` | | supportmailboxes | An array containing the stores support mailboxes - see [Stores Support Mailboxes](Stores_Support_Mailboxes.md#view-stores-support-mailboxes) | Array | | | theme | The theme that the store uses | String | Up to 100 characters long | | uses_domain | Indicates whether the Store uses a domain, or not | Boolean | | diff --git a/API/Store/System_Order_Checks.md b/API/Store/System_Order_Checks.md new file mode 100644 index 000000000..cd4bd55be --- /dev/null +++ b/API/Store/System_Order_Checks.md @@ -0,0 +1,67 @@ +# System Order Checks +[Home](../../index.md) > [API](../index.md) > [Store](index.md) + +## Endpoints +The below endpoints are available with this API + +| Endpoint | Method | Description | | +| --- | --- | --- | --- | +| /system/orderchecks/ | POST | This allows you to manage system order checks | [Details](#create-system-order-checks) | +| /system/orderchecks/:ordercheck/ | DELETE | This allows you to delete a specified system order check | [Details](#delete-system-order-check) | +| /system/orderchecks/ | PUT | This allows you to update system order checks | [Details](#update-system-order-checks) | +| /system/orderchecks/:ordercheck/ | PUT | This allows you to update system order checks | [Details](#update-system-order-checks) | +| /system/orderchecks/ | GET | This allows you to list system order checks | [Details](#view-system-order-checks) | +| /system/orderchecks/:ordercheck/ | GET | This allows you to list system order checks | [Details](#view-system-order-checks) | + +## Create System Order Checks +This allows you to manage system order checks + +**URL** : `/system/orderchecks/` + +**Method** : `POST` + +| Field | Description | Type | Requirements | Default | Required? | Conditional? | +| --- | --- | --- | --- | --- | --- | --- | +| is_enabled | Indicates whether or not the check is enabled | Boolean | | false | N | N | +| marketplace_id | A valid Marketplace ID | Integer | | NULL | N | N | +| store_id | A valid Store ID | Integer | | NULL | N | N | +| type_id | A valid Order Screening Type ID | Integer | Up to 10 digits long | NULL | Y | N | + +## Delete System Order Check +This allows you to delete a specified system order check + +**URL** : `/system/orderchecks/:ordercheck/` + +**Method** : `DELETE` + +## Update System Order Checks +This allows you to update system order checks + +**URL** : `/system/orderchecks/` + +**URL** : `/system/orderchecks/:ordercheck/` + +**Method** : `PUT` + +| Field | Description | Type | Requirements | Default | Required? | Conditional? | +| --- | --- | --- | --- | --- | --- | --- | +| is_enabled | Indicates whether or not the check is enabled | Boolean | | false | N | N | + +## View System Order Checks +This allows you to list system order checks + +**URL** : `/system/orderchecks/` + +**URL** : `/system/orderchecks/:ordercheck/` + +**Method** : `GET` + +| Field | Description | Type | Validation | +| --- | --- | --- | --- | +| is_enabled | Indicates whether or not the administrator should be notified | Boolean | | +| marketplace_id | A valid Marketplace ID | Integer | | +| parent_type | The name of the Order Screening Parent Type | String | Up to 100 characters long | +| parent_type_id | A valid Order Screening Parent Type ID | Integer | Up to 10 digits long | +| store_id | A valid Store ID | Integer | | +| type | The name of the Order Screening Type | String | Up to 100 characters long | +| type_id | A valid Order Screening Type ID | Integer | Up to 10 digits long | diff --git a/API/Store/Webhook_Queue_Resend.md b/API/Store/Webhook_Queue_Resend.md new file mode 100644 index 000000000..6a021aaad --- /dev/null +++ b/API/Store/Webhook_Queue_Resend.md @@ -0,0 +1,24 @@ +# Webhook Queue Resend +[Home](../../index.md) > [API](../index.md) > [Store](index.md) +## Intro +Resends an item in the webhook queue +## Endpoints +The below endpoints are available with this API + +| Endpoint | Method | Description | | +| --- | --- | --- | --- | +| /webhooks/queue/:queue/resend/ | POST | This allows you to resend an item that is within the webhook queue | [Details](#schedules-an-item-in-the-webhook-queue-to-be-resent-with-the-latest-payload) | + +## Schedules an item in the webhook queue to be resent with the latest payload +This allows you to resend an item that is within the webhook queue + +**URL** : `/webhooks/queue/:queue/resend/` + +**Method** : `POST` + +| Field | Description | Type | Requirements | Default | Required? | Conditional? | +| --- | --- | --- | --- | --- | --- | --- | +| code | The public code that was originally used to despatch the webhook | String | | NULL | Y | N | +| hmac | The calculated HMAC that correspends to this request | String | | NULL | Y | N | +| scope | The scope of the webhook that was originally provided | String | | NULL | Y | N | +| timestamp | The timestamp that the request was made | Integer | | NULL | Y | N | diff --git a/API/Store/index.md b/API/Store/index.md index 4d4add795..ae363482e 100644 --- a/API/Store/index.md +++ b/API/Store/index.md @@ -114,6 +114,7 @@ The following APIs are available for Store | System Attribute Sets | Manages system attribute sets | [Details](System_Attribute_Sets.md) | | System Attribute Sets Groups | Manages system attribute set groups | [Details](System_Attribute_Sets_Groups.md) | | System Attribute Sets Groups Attributes | Manages system attribute set group attributes | [Details](System_Attribute_Sets_Groups_Attributes.md) | +| System Order Checks | | [Details](System_Order_Checks.md) | | Tags | Manages Tags | [Details](Tags.md) | | Tax Classes | Manages Tax Classes | [Details](Tax_Classes.md) | | Tax Rules | Manages Tax Rules | [Details](Tax_Rules.md) | @@ -124,3 +125,4 @@ The following APIs are available for Store | Teams Members | Manages Team Members | [Details](Teams_Members.md) | | Types | Manages Types | [Details](Types.md) | | Types Items | Manages Type Items | [Details](Types_Items.md) | +| Webhook Queue Resend | Resends an item in the webhook queue | [Details](Webhook_Queue_Resend.md) |