{"info":{"_postman_id":"a8cc246c-c041-47ca-8dc2-36b12c910ca4","name":"Ingenuity API","description":"

Welcome to THG Ingenuity API

Authentication

All THG Ingenuity APIs will require authentication. THG Ingenuity API is an OAuth 2.0 provider. It is highly recommended that you use one of the many OAuth 2.0 libraries to manage and do the heavy lifting for you.

To get started, you will need to get an ACCESS_TOKEN. In order to get an ACCESS_TOKEN, you will first need a registered application. If you've already registered, you would be supplied with a client ID and client SECRET. Many good OAuth libraries will be able to manage the ACCESS_TOKEN for you, you just need to supply the client ID and client SECRET.

Getting an Access Token

If you have a registered application, you will have been given a client ID and a client SECRET.
To test that you are able to get the ACCESS_TOKEN you can hit the provider URL that you've been provided with

    client_secret= {client-secret}\n    client_id= {client-id}\n    grant_type = \"client_credentials\"\n\n

You should expect a response like below for a successful response

    {\n        \"access_token\": \"eyJhbGciOiJSUzI1NiIsjvsoiejh\",\n        \"expires_in\": 0, //seconds\n        \"refresh_expires_in\": 0, //seconds\n        \"token_type\": \"Bearer\",\n        \"not-before-policy\": 0,\n        \"scope\": \"profile email\"\n    }\n\n

The expiry of the access token will be provided so you can build your system around this to minimise any issues.

Connectivity Testing

Once you've establish you're able to get an ACCESS_TOKEN you can proceed to test the connectivity based on what was provided with your \"On boarding Pack\". Hit the URL provided with the ACCESS_TOKEN supplemented as a Bearer Token in the Authorization header. The cURL version of the request should look something like this:

    curl --location --request GET 'https://api.thgingenuity.com/authentication/healthcheck' \\\n        --header 'Authorization: Bearer {ACCESS_TOKEN}'\n\n

Upon successful authentication check you will receive a response like so:

    Http Response : 200\n    Body : Authentication Check Successful.\n\n

Using The Access Token

Assuming you successfully tested your ACCESS_TOKEN with the connectivity test, it's time to test it with the API. Just like how you would supplement the ACCESS_TOKEN in the Authorization header during the connectivity test, you would do the same for every API call.

    curl --l'Authorization: Bearer {ACCESS_TOKEN}'\n\n

Should your token expire you will be presented with a 401 and you will either need to refresh the token or request a new one.

THG to Client

We expect the Client to have protected endpoints that THG will be calling for the THG to Client flow. The expectation is that the endpoints are protected under one of the following authentication mechanism:

Bearer Authentication(OAuth 2.0)
\n
Basic Authentication
\n

Bearer Authentication

A client id and client secret are exchanged for an access token that THG will pass in all calls via a request header.

Client should provide us with the authenticationURL and credentials for getting auth tokens.
\n
THG will call the authentication URL using these credentials to get an access token as shown below.
\n
THG will include this token in its subsequent requests to Client in an authorization header as a bearer token. The value field will leave a blank space between ‘Bearer’ and the access token.
\n
Once the token expires (specified in expires_in field) a new token is requested from the Client.
\n

Header example:

    Key: Authorization\n    Value: Bearer {token}\n\n

The request and response bodies below should be implemented as described below. Client authentication endpoint will be supplied by the Client and THG will call it to request the auth token.Authentication Request Model:Pass with header Content-Type: \"application/x-www-form-urlencoded”

    {\n        \"client_id\":\"{clientId}\",\n        \"client_secret\":\"{clientSecret}\",\n        \"grant_type\":\"client_credentials\"\n    }\n\n

Request example:

    curl --location --request POST\n        'https://{authServerBaseUrl}/auth/realms/{realmName}/protocol/openid-connect/token' \n        --header 'Content-Type: application/x-www-form-urlencoded'\n        --data-urlencode 'grant_type=client_credentials'\n        --data-urlencode 'client_id={clientId}'\n        --data-urlencode 'client_secret={clientSecret}'\n\n

Authentication Response Model:

    {\n        \"access_token\": \"{token}\", \n        \"expires_in\": 3600\n    }\n\n

Basic Authentication

A username and password are provided by 3PL that THG will pass in all calls via a request header.

3PL should provide us with username and password.
\n
THG will include encoded key derived from username and password in its subsequent requests to 3PL in an authorization header as a basic token. The value field will leave a blank space between ‘Basic’ and the token
\n
Basic Authentication is not supported for 3PL integrations.
\n

Header example:

    Key: Authorization\n    Value: Basic {encoded token}\n\n

Fulfil Sandbox

THG Ingenuity Fulfil Sandbox Documentation

v.2025-05-21

1. Introduction to the THG Fulfil Sandbox

Purpose of the Sandbox
\n
- Provides an environment to test integrations with the THG Ingenuity Fulfil APIs.
  \n
- Allows clients to simulate sending and receiving data without affecting production systems.
  \n
  - \"Clients\" refer to those integrating with the API
  \n
\n
What the Sandbox Provides
\n
- A collection of mocked API endpoints based on the THG Fulfil section of the Ingenuity API.
  \n
- Predefined responses to simulate successful and unsuccessful API calls.
  \n
- Simulation of key integration flows (e.g., Shipment or Order Creation, Shipment Dispatch, Returns Processing).
  \n
\n

2. Accessing and Authenticating with the Sandbox

Sandbox Base URL
\n
- The sandbox URL: https://sandbox.api.thgingenuity.com
\n
Authentication
\n
- The Authorization header is required for authentication using simple Bearer Token authentication.
  \n
- Bearer tokens are provided for clients to use; we haven't implemented a generic auth sequence to generate the sandbox token from the sandbox to prevent unknown access.
  \n
- 401 Unauthorized response will return if the wrong token or no authorization is used
  \n
\n
Request Headers
\n
- Use Content-Type: application/json as nearly all API endpoints return application/json and it's been keyed in some of the mocks.
  \n
  - This header doesn't appear as required on many of the THG Fulfil API calls so we don't enforce it at the moment but will do if verified to be needed.
  \n
- Other headers may be required and will be updated and communicated. These might be:
  \n
  - organisation header, which in UAT and production specifies the client name agreed upon during onboarding
    \n
  - client-order-reference to specify a specific order
    \n
  - X-THG-Channel to specify a particular fulfilment channel that is often 1:1 with the client's organization
    \n
  - X-THG-Client to specify a particular client that is often 1:1 with the client's organization
    \n
  \n
\n

3. Understanding Sandbox Mock Behavior

Differences from Production
\n
- No actual processing of orders, shipments, returns, stock movements, or other entities occurs.
  \n
- Inventory levels are not actually updated based on inbound/outbound calls.
  \n
- Mocks provide predefined responses, not dynamic behavior based on complex logic or external systems.
  \n
\n
Predefined Responses
\n
- Mocks return static or conditionally static responses based on the request.
  \n
- Example: The GET /v2/order/returns/paginated mock specifically responds to a request with pageSize=1 and returnStatus=CREATED.
  \n
\n
How to Identify and Use Specific Mocks
\n
- Clients may need to send specific request data (e.g., specific product IDs, order numbers, query parameters) to trigger certain mock responses (e.g., success vs. error).
  \n
- Consult the detailed mock configurations (if available) or trial-and-error based on expected API behavior.
  \n
\n
Simulating Flows
\n
- THG APIs in production and UAT may receive a message and start a sequence of processing that results later (such as warehousing operations) in additional messages back to the customer. For the sandbox, only direct request-response sequences happen.
  \n
- Outbound notifications (e.g., Order State Updates) are typically sent from THG to client-provided endpoints are only covered up to the inbound step. As an example, in the case of Order State Updates, the POSTed body and empty response is included but not any further messaging.
  \n
\n

4. Handling Errors in the Sandbox

Simulated HTTP Status Codes
\n
- Mocks are configured to return various HTTP status codes to simulate production errors (e.g., 200 Success, 202 Accepted, 400 Bad Request, 403 Forbidden, 404 Not Found, 500 Internal Server Error).
\n
Simulated Error Messages/Payloads
\n
- Mocks may return specific error codes and descriptions as defined in the API documentation
\n

5. Troubleshooting Common Sandbox Issues

Common authentication errors (e.g., invalid or missing token).
\n
Requests not triggering expected mock responses (check required parameters and headers).
\n
Issues related to asynchronous notification simulation.
\n
Validation errors based on predefined sandbox constraints.
\n

6. Available Mocked API Endpoints (THG Fulfil Section)

This section outlines the key API endpoints within the THG Fulfil scope that are available as mocks in the sandbox.

Examples from the API docs: https://postman.developer.thgingenuity.com/#5510d46d-a0a2-4171-9816-8d920c145f23
\n
D2C Orders
\n
- Additional Create Order PUT /v2/order mocks:
  \n
  - Repeated order lines for one product when the details are the same: Success 200
    \n
  - ClientOrderReference = ClientOrder99999 creates a 500 Server Error
    \n
  \n
- Cancel Order/Order Lines POST /v2/order/action with updates/additions:
  \n
  - 200 Success with correct body as in docs:
    \n
    - client-order-reference=ClientOrder00001 (as in docs)
      \n
    - client-order-reference=ClientOrder00001&platform-order-reference=AB_1234
      \n
    \n
  - 404 Not Found with correct body as in docs:
    \n
    - client-order-reference=ClientOrder00003
      \n
    - client-order-reference=ClientOrder11112233 (as in docs)
      \n
    \n
  - 410 Gone with correct body as in docs:
    \n
    - client-order-reference=ClientOrder00002
      \n
    - client-order-reference=ClientOrder332211
      \n
    \n
  - 500 Server Error with correct body as in docs:
    \n
    - client-order-reference=ClientOrder99999 (not 11112233 as in docs)
    \n
  \n
- Get Order Status GET /v2/order/status:
  \n
  - 200 Success:
    \n
    - client-order-reference=ClientOrder00001\"
      \n
    - platform-order-reference=AB_1234\"
      \n
    \n
  - 200 Success split shipment (one dispatched, other cancelled):
    \n
    - client-order-reference=ClientOrder00004\"
    \n
  - 400 Bad Request as in docs
    \n
  - 404 Not Found as in docs plus:
    \n
    - client-order-reference=unknown
      \n
    - client-order-reference=ClientOrder00003
      \n
    \n
  - 410 Gone:
    \n
    - client-order-reference=ClientOrder00002
    \n
  - 500 Server Error:
    \n
    - client-order-reference=ClientOrder99999
    \n
  \n
- Send Order State Update to client POST /v1/sendOrderStateUpdate - Outbound:
  \n
  - For Outbound calls, use a REST client to retrieve sample message from our sandbox API and then point at your system. We're investigating options to have it call your system directly
    \n
  - 200 Success Single shipment with body as in docs
    \n
  - 200 Success Split shipment with split shipment body as in docs with client-order-reference: \"ClientOrder00001\" or \"ClientOrder00004\"
    \n
  - 400 Bad Request as in docs or with a successful body but missing a header (client-order-reference, X-THG-Channel)
    \n
  - 404 Not Found with client-order-reference: \"ClientOrder00003\" - the example in the docs matches 200 Success so use this special client-order-reference
    \n
  - 500 Server Error as in docs or with client-order-reference: \"ClientOrder99999\" -the example in the docs matches a 200 Success so use this special client-order-reference
    \n
  \n
\n
Goods In - Being tested at the moment, these may change
\n
- Pre-Advice
  \n
  - Creating a Pre-Advice POST /goods-in/pre-advice as in docs, plus:
    \n
    - 400 Bad Request: \"warehouseID\": 90 or field missing
    \n
  - Querying Pre-Advice Status GET /goods-in/pre-advice/{pre_advice}/pre-advice-approval as in docs, plus:
    \n
    - note to use GET and not \"--data ''\" (POST will return a message to use GET)
      \n
    - 200 Success: /goods-in/pre-advice/f798c408-260d-467c-82f4-5fc6f2944ef4/pre-advice-approval
      \n
      - or any string not including unknown, reject, busy (case insensitive)
      \n
    - 200 Success UKNOWN_PRODUCT response: /goods-in/pre-advice/advicerejected/pre-advice-approval
      \n
      - or any string that includes unknown or reject (case insensitive)
      \n
    - 200 Success WAREHOUSE_BUSY response: /goods-in/pre-advice/advicebusyresp/pre-advice-approval
      \n
      - or any string that includes busy (case insensitive)
      \n
    - 400 Bad Request: /goods-in/pre-advice//pre-advice-approval - missing {pre-advice} field
      \n
    \n
  - Get Pre-Advice Status GET /goods-in/pre-advice/{pre_advice} as in docs - note to use GET and not \"--data ''\"
    \n
  \n
- ASN (Advanced Shipment Notification)
  \n
  - Creating ASN POST /goods-in/asn as in docs, plus:
    \n
    - 400 Bad Request: \"warehouseID\": 90 or field missing
    \n
  - On all of the GET commands below - note to use GET and not \"--data ''\" (POST will return a message to use GET)
    \n
    - Get Approval GET /goods-in/asn/{asn}/approval as in docs
      \n
    - Get Progress GET /goods-in/asn/{asn}/progress as in docs
      \n
    - Get GRN (Goods Receipt Note) GET /goods-in/asn/{asn}/grn as in docs
      \n
    - Get ASN GET /goods-in/asn/{asn}/asn as in docs
      \n
    \n
  \n
\n
Product
\n
- Create Product POST /v1/products
  \n
  - 201 Success as in doc examples
  \n
- Update Product PUT /v1/products/{{id}}
  \n
  - 200 Success as in doc examples
  \n
- Get Product GET /v1/products/{{id}}
  \n
  - 200 Success as in doc examples using 123456, for example
    \n
  - 404 Not Found example using id 99999
    \n
  \n
- Get THG Product ID GET /v1/products/{{id}}/mapping - note: this is likely to change
  \n
  - 200 Success as in doc examples using 123456, for example
    \n
  - 404 Not Found example using id 99999
    \n
  \n
- Get Multiple THG Product IDs POST /v1/products/mappings
  \n
  - 200 Success as in doc examples
  \n
- Get Multiple Client or THG ID Mappings POST /v1/products/idmaps
  \n
  - 200 Success as in doc examples
  - 400 Incomplete Request as in doc examples
  - 404 Not Found as in doc examples
  - 500 Internal Server Error as in doc examples
  \n
\n
Returns
\n
- Create Return POST /v2/order/returns
  \n
  - 200 Success as in doc examples
    \n
  - 422 Unprecessable as in doc examples
    \n
  - 404 Not Found use \"orderNumber\": \"11112233\" with normal body
    \n
  \n
- Cancel Return: PUT /v2/order/returns/{returnShipmentNumber}/cancel
  \n
  - As in docs
  \n
- Get Paginated Returns: Details on the GET /v2/order/returns/paginated endpoint mock.
  \n
  - As in the docs:
    \n
    - Get result set: GET /v2/order/returns/paginated?pageSize=1&returnStatus=CREATED with 200 Success
    \n
  - Except:
    \n
    - Get empty result set: GET /v2/order/returns/paginated with 200 Success
      \n
    - Failed query - invalid query parameter: GET http://localhost:8080/v2/order/returns/paginated?invalidParam=value - example in the doc needs updating
      \n
    \n
  \n
- Get Return by Shipment Number GET /v2/order/returns/{returnShipmentNumber} as in docs:
  \n
  - 200 Success with returnShipmentNumber 612
    \n
  - 404 Not Found with returnShipmentNumber 613
    \n
  - 400 Bad Request with returnShipmentNumber 710
    \n
  - 409 Conflict with returnShipmentNumber 713
    \n
  - 401 Unauthorized with returnShipmentNumber 711 or without the correct Authorization header
    \n
  - 500 Internal Server Error with returnShipmentNumber 712
    \n
  \n
\n
Stock
\n
- Get Stock Availability GET /v1/availability/productId/{{productId}}
  \n
  - 200 Success example with productId: 12345678
    \n
  - 404 Not Found example with productId: x123
    \n
  \n
- Get Stock Adjustment by ID GET /v1/stock/adjustments/stockadjustmentid/{{stockAdjustmentId}}
  \n
  - 200 Success using stockAdjustmentId: 123456
    \n
  - 404 Not Found using stockAdjustmentId: 222
    \n
  \n
- Get Stock GET /v1/stock/product/{{productId}}
  \n
  - 200 Success example with productId: 1234567 - should be 7 digit productId
    \n
  - 404 Not Found example with productId: x123 - non-digits
    \n
  - 404 Not Found example with productId: 91123
    \n
  - 500/504 Server Error/Gateway Timeout with productId: 99093
    \n
  \n
- Send Stock Adjustments POST /stockAdjustment - Outbound
  \n
  - For Outbound calls, use a REST client to retrieve sample message from our sandbox API and then point at your system. We're investigating options to have it call your system directly
    \n
  - 200 Success /stockAdjustment using example in docs with stock_adjustment_id:123456 and warehouse_reference:whRef1234
    \n
  - 400 Bad Request /stockAdjustment using example in docs with stock_adjustment_id:91234
    \n
  \n
- Not available in production: Get Stock Adjustments (time range) GET /v1/stock/adjustments/productId/{{productId}}/from/{{fromDate}}/to/{{toDate}} - postponed
  \n
  - 200 Success example: /v1/stock/adjustments/productId/1234567/from/2014-05-14T14:11:01Z/to/2015-05-14T14:11:01Z
    \n
  - 404 Not Found example: /v1/stock/adjustments/productId/91234/from/nineteen-dickety-six/to/2015-05-14T14:11:01Z
    \n
  \n
- Deprecated Stock Endpoint: Mention the GET /v2/stock/product/{productId} endpoint is deprecated and superseded by the v1 endpoint.
  \n
  - 200 Success /v2/stock/product/1234567 with status code 200
    \n
  - 404 Not Found /v2/stock/product/91234 with status code 404
    \n
  - 404 Not Found /v2/stock/product/invalidstringid with status code 404
    \n
  - 500 Internal Server Error /v2/stock/product/99093 with status code 500
    \n
  \n
\n

v.2025-05-21 changes:
\n
- Highlight Outbound calls and need for clients to use RESTclient to call their systems
  \n
- Update product endpoints
  \n
- Add stock by product endpoint
  \n
\n
v.2025-05-12 changes:
\n
- Clarify pre-advice approval success cases
\n
v.2025-07-31 changes:
\n
- Added Multiple Client or THG ID Mappings
\n

Rate Limiting

Inbound to the Ingenuity API

Calls to the Ingenuity API are subject to rate limiting. The limit is configured on a per endpoint basis. The default limit is 250 requests per minute, this can be changed depending on the need and use case for calling the endpoint.

When a rate limit is exceeded, the client will receive an HTTP 429 response. 429 Too Many Requests

Ordinarily, the rate limit is set per minute, therefore the call count resets every 60 seconds.

Outbound from the Ingenuity API

Calls made outwards from the Ingenuity API are not rate limited by the calling API. If the API received an HTTP 429 response, the standard behaviour is to retry. For synchronous outbound calls, the behaviour is handed over to the calling service and the HTTP 429 is passed onto the caller to handle.

The standard retry mechanism (for asynchronous calls) is a back-off and retry process which will retry messages in bursts at varying intervals up to around 19 hours in total duration, after which the call is deemed as failed and sent to a failure topic for the calling service.

\n","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[{"content":"Authentication","slug":"authentication"},{"content":"Fulfil Sandbox","slug":"fulfil-sandbox"},{"content":"Rate Limiting","slug":"rate-limiting"}],"owner":"21093843","collectionId":"a8cc246c-c041-47ca-8dc2-36b12c910ca4","publishedId":"Uz5AseFz","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"0d0d0d","highlight":"0065e0"},"publishDate":"2025-05-12T10:43:49.000Z"},"item":[{"name":"B2B Order Management","item":[{"name":"Delivery Address","item":[{"name":"Create Delivery Address","id":"1c12a88e-cdd9-4178-9bf2-d7633d8be1e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"[\n {\n \"addressId\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postCode\": \"\",\n \"incoTerm\": \"\"\n }\n]\n","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/b2b/delivery-address","description":"

Submit a list of delivery addresses for creation and return a request ID to track the request.

Note: A maximum of 25 addresses can be provided in a single request. Address fields have their length and format rules, unless they are overridden by Country Specific Rules.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Length	Description
addressId	string	Y	15	Must be unique.
addressLine1	string	Y	32
addressLine2	string	N	32
addressLine3	string	N	32
city	string	Y	40	Allowed characters: Letters (A-Z, a-z), space, period (.), apostrophe ('), and hyphen (-).
state	string	N	35	United States & Australia have a fixed list of accepted state codes. Allowed characters: Letters (A-Z, a-z), space, period (.), apostrophe ('), and hyphen (-).
country	string	Y	2	Two character country code - ISO 3166-1 alpha-2.
postCode	string	Y	10	Allowed characters: Letters (A-Z, a-z), digits (0-9), space, and hyphen (-).
incoTerm	string	Y	3	Inco terms ID for the address as taken from the Inco Terms table.

","urlObject":{"path":["b2b","delivery-address"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"09034baa-dea1-4928-870f-7580293e071c","name":"200 Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"[\n {\n \"addressId\": \"THGI123\",\n \"addressLine1\": \"THG ICON\",\n \"addressLine2\": \"7-9 Sunbank Lane\",\n \"city\": \"Altrincham\",\n \"country\": \"GB\",\n \"postCode\": \"WA15 0AF\",\n \"incoTerm\": \"DDP\"\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/b2b/delivery-address"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"requestId\": \"03e8f297-d3f3-4b68-be2f-c17bed38d6AQ\"\n}\n"}],"_postman_id":"1c12a88e-cdd9-4178-9bf2-d7633d8be1e2"},{"name":"Update Delivery Address","id":"1056de44-6da5-4774-963d-642ac0dc0983","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"addressId\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"country\": \"\",\n \"postCode\": \"\",\n \"incoTerm\": \"\"\n}\n","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/b2b/delivery-address/update","description":"

This endpoint allows for the request to update a Delivery Address based on the specified addressId already existing.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Length	Description
addressId	string	Y	15	An address must already exist with this value.
addressLine1	string	Y	32
addressLine2	string	N	32
addressLine3	string	N	32
city	string	Y	40	Allowed characters: Letters (A-Z, a-z), space, period (.), apostrophe ('), and hyphen (-).
state	string	N	35	United States & Australia have a fixed list of accepted state codes. Allowed characters: Letters (A-Z, a-z), space, period (.), apostrophe ('), and hyphen (-).
country	string	Y	2	Two character country code - ISO 3166-1 alpha-2.
postCode	string	Y	10	Allowed characters: Letters (A-Z, a-z), digits (0-9), space, and hyphen (-).
incoTerm	string	Y	3	Inco terms ID for the address as taken from the Inco Terms table.

","urlObject":{"path":["b2b","delivery-address","update"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"33bbf79c-702e-4cca-8c1d-15149816e388","name":"200 Updated","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"addressId\": \"THGI123\",\n \"addressLine1\": \"THG ICON\",\n \"addressLine2\": \"7-9 Sunbank Lane\",\n \"city\": \"Altrincham\",\n \"country\": \"GB\",\n \"postCode\": \"WA15 0AF\",\n \"incoTerm\": \"DDP\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/b2b/delivery-address/update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"requestId\": \"03e8f297-d3f3-4b68-be2f-c17bed38d7op\"\n}\n"}],"_postman_id":"1056de44-6da5-4774-963d-642ac0dc0983"},{"name":"Delete Delivery Address","id":"e90ec9aa-cfb7-4090-abcf-345610e7271a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"url":"{{baseUrl}}/b2b/delivery-address/:addressId","description":"

This endpoint deletes the Delivery Address based on the specified addressId already existing.

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
addressId	string	An address must already exist with this value.

","urlObject":{"path":["b2b","delivery-address",":addressId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"THGI123","key":"addressId"}]}},"response":[{"id":"f9255119-a0d7-4288-be0e-bcced73a7ba7","name":"200 Deleted","originalRequest":{"method":"DELETE","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"url":{"raw":"{{baseUrl}}/b2b/delivery-address/:addressId","host":["{{baseUrl}}"],"path":["b2b","delivery-address",":addressId"],"variable":[{"key":"addressId","value":"THGI123"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"requestId\": \"903e8f297-d3f3-4b68-be2f-c17bed38d9uy\"\n}\n"}],"_postman_id":"e90ec9aa-cfb7-4090-abcf-345610e7271a"},{"name":"Get Delivery Address","id":"cb89eb61-e4d9-45c2-86dc-bc5f50d8917d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"url":"{{baseUrl}}/b2b/delivery-address/addressId/:addressId","description":"

This endpoint retrieves the Delivery Address record for the given addressId.

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
addressId	string	An address must already exist with this value.

","urlObject":{"path":["b2b","delivery-address","addressId",":addressId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"THGI123","key":"addressId"}]}},"response":[{"id":"09851e5a-daba-4121-87a1-39c39359da62","name":"200 Found","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"url":{"raw":"{{baseUrl}}/b2b/delivery-address/addressId/:addressId","host":["{{baseUrl}}"],"path":["b2b","delivery-address","addressId",":addressId"],"variable":[{"key":"addressId","value":"THGI123"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"addressId\": \"THGI123\",\n \"addressLine1\": \"THG ICON\",\n \"addressLine2\": \"7-9 Sunbank Lane\",\n \"city\": \"Altrincham\",\n \"country\": \"GB\",\n \"postCode\": \"WA15 0AF\",\n \"incoTerm\": \"DDP\"\n}"}],"_postman_id":"cb89eb61-e4d9-45c2-86dc-bc5f50d8917d"},{"name":"Search Delivery Address","id":"f004c615-0768-4c10-a9d2-824a3ffc303d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"search\": \"\",\n \"size\": \"\",\n \"page\": \"\"\n}\n","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/b2b/delivery-address/search","description":"

This endpoint returns a paginated list of delivery addresses which match the search string.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
search	string	N	The search string to filter delivery addresses. If empty (\"\") or `null`, all addresses will be returned.
size	number	N	The number of addresses to return per page. Defaults to 10 if not specified.
page	number	N	The page number to return (0-indexed). Defaults to 0 if not specified.

Response Header

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Name	Type	Description
X-Pagination-Count	number	The total number of addresses that match the search query.

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
addressId	string
addressLine1	string
addressLine2	string
addressLine3	string
city	string
state	string
country	string
postCode	string
incoTerm	string

","urlObject":{"path":["b2b","delivery-address","search"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"a01f9701-8ae3-4cad-b804-3570edea9a27","name":"200 Results","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"search\": \"THGI1\",\n \"size\": 5,\n \"page\": 1\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/b2b/delivery-address/search"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"},{"key":"X-Pagination-Count","value":"2","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"addressId\": \"THGI123\",\n \"addressLine1\": \"THG ICON\",\n \"addressLine2\": \"7-9 Sunbank Lane\",\n \"city\": \"Altrincham\",\n \"country\": \"GB\",\n \"postCode\": \"WA15 0AF\",\n \"incoTerm\": \"DDP\"\n },\n {\n \"addressId\": \"THGI124\",\n \"addressLine1\": \"THG Omega\",\n \"addressLine2\": \"Skyline Drive\",\n \"addressLine3\": \"Burtonwood\",\n \"city\": \"Warrington\",\n \"country\": \"GB\",\n \"postCode\": \"WA5 3TP\",\n \"incoTerm\": \"DDP\"\n }\n]"}],"_postman_id":"f004c615-0768-4c10-a9d2-824a3ffc303d"}],"id":"9bfd7cf3-1a30-4b4a-b4a8-1184a6588dc7","description":"

This API allows for the administration of Delivery Addresses for B2B orders.

Country Specific Rules - Length and Format

The default length, format, and content rules apply if they are not overridden by country in the table below.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Country	Fields	Length	Format
Aland Islands	City	32	-
Angola	Address Line 1, 2, and 3	40	-
Australia	postCode	4	-
Bonaire, Saint Eustatius and Saba	City	32	-
Brazil	Address Line 1, 2, and 3	60	-
Canada	postCode	7	A letter (A-Z, a-z), followed by a digit (0-9), then a letter, a space, a digit, a letter, and a digit.
Finland	City	32	-
France	postCode	5	Digits (0-9)
France	City	27	-
Guernsey	City	32	-
Ireland	City	32	-
Isle of Man	City	32	-
Italy	postCode	5	Digits (0-9)
Japan	City	32	-
Jersey	City	32	-
Kuwait	City	32	-
Lebanon	City	32	-
Luxembourg	City	32	-
Malaysia	City	27	-
Malta	City	27	-
Mexico	City	27	-
Morocco	City	27	-
Netherlands	City	32	-
New Zealand	postCode	4	-
Poland	postCode	6	Two letters or digits, followed by a hyphen (-) and then three letters or digits.
Portugal	Address Line 1, 2, and 3	40	-
Portugal	postCode	8	Four digits followed by a hyphen and three digits.
Portugal	City	32	-
Slovenia	City	30	-
South Korea	City	32	-
Spain	Address Line 1, 2, and 3	30	-
Spain	postCode	5	Digits.
Switzerland	postCode	4	-
Tokelau	postCode	4	-
United Kingdom	City	32	-
United States	postCode	10	Five digits followed by a hyphen and then four digits.
United States	City	35	Starts with a letter, then optionally followed by characters consisting of letters, spaces, apostrophes ('), or hyphens. All other special characters are not allowed.

State Codes

United States

AA, AE, AK, AL, AP, AR, AS, AZ, CA, CO, CT, DC, DE, FL, FM, GA, GU, HI, IA, ID, IL, IN, KS, KY, LA, MA, MD, ME, MH, MI, MN, MO, MP, MS, MT, NC, ND, NE, NH, NJ, NM, NV, NY, OH, OK, OR, PA, PR, PW, RI, SC, SD, TN, TX, UT, VA, VI, VT, WA, WI, WV, WY

Australia

ACT, NSW, NT, QLD, SA, TAS, VIC, WA

Inco Terms

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

ID	Name
CFR	Cost and Freight
CIF	Cost Insurance and Freight
CIP	Carriage and Insurance paid to
CPT	Carriage paid to
DAP	Delivered at Place
DAT	Delivered at Terminal
DDP	Delivered Duty Paid
EXW	Ex Works
FAS	Free Alongside Ship
FCS	Free Carrier
FOB	Free On Board

","_postman_id":"9bfd7cf3-1a30-4b4a-b4a8-1184a6588dc7"},{"name":"Healthcheck","item":[{"name":"Returns health of the service (UP / DOWN)","id":"d0335a06-c364-43c5-a83d-be505291c7f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"*/*"}],"url":"{{baseUrl}}/status","urlObject":{"path":["status"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"f048d0d1-05b2-4db5-983d-c7262f4e3d47","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*"}],"url":"{{baseUrl}}/status"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d0335a06-c364-43c5-a83d-be505291c7f8"}],"id":"009b094c-a496-4a24-967b-eb8d510319e6","_postman_id":"009b094c-a496-4a24-967b-eb8d510319e6","description":""},{"name":"Inventory","item":[{"name":"/b2b/inventory/{productId}/level","id":"dfd77b01-b72a-4287-a34a-ff2daf07d908","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/b2b/inventory/:productId/level","description":"

The GET request returns the inventory levels of the givenproductId.

If found, the response provides the inventory level for the given productId by warehouse, by the following statuses:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Description
Total	Total inventory across all statuses
Available	GOOD stock which is not allocated and is available to sell
Allocated	GOOD stock which is allocated to an 'in-progress' order and is not available to sell
Held	Stock in a Held state
Damaged	Stock in a Damaged state
warehouseName	Name of warehouse

","urlObject":{"path":["b2b","inventory",":productId","level"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"62e541b9-c605-43ce-888e-b56e77651c8e","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"productId"}]}},"response":[{"id":"58cfe01f-0479-403f-b373-5798b4de5a02","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/b2b/inventory/:productId/level","host":["{{baseUrl}}"],"path":["b2b","inventory",":productId","level"],"variable":[{"key":"productId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"productId\": \"123456\",\n \"total\": \"10001\",\n \"available\": \"9900\",\n \"allocated\": \"100\",\n \"held\": \"0\",\n \"damaged\": \"1\",\n \"warehouseName\": \"Warehouse A\"\n },\n {\n \"productId\": \"123456\",\n \"total\": \"600\",\n \"available\": \"10\",\n \"allocated\": \"500\",\n \"held\": \"90\",\n \"damaged\": \"0\",\n \"warehouseName\": \"Warehouse B\"\n }\n]"}],"_postman_id":"dfd77b01-b72a-4287-a34a-ff2daf07d908"}],"id":"50d287bd-4fff-4b27-9783-7b280ff3cafd","_postman_id":"50d287bd-4fff-4b27-9783-7b280ff3cafd","description":""},{"name":"Orders","item":[{"name":"/b2b/order/request","id":"4f8b281a-b20f-40d0-a03c-49130d653678","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"orderNumber\": \"\",\n \"requestedDeliveryDate\": \"\",\n \"addressId\": \"\",\n \"addressLine1\": \"\",\n \"addressLine2\": \"\",\n \"addressLine3\": \"\",\n \"city\": \"\",\n \"state\": \"\",\n \"countryId\": \"\",\n \"postCode\": \"\",\n \"bookingReference\": \"\",\n \"orderNotes\": \"\",\n \"orderRequestLines\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\"\n }\n ],\n \"deliveryDateStart\": \"\",\n \"deliveryDateEnd\": \"\",\n \"customerPurchaseOrderNumber\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/b2b/order/request","description":"

This endpoint is the method by which B2B Order Requests can be created.

Note. Either the requestedDeliveryDate or deliveryDateStart/End values should be populated, not both. Also, duplicate product Ids on an order are not supported.

Request Body

Property	Type	Mandatory	Length	Description
orderNumber	String	Y	1-50	Subject to a uniqueness check.
requestedDeliveryDate	String	N		Date format: YYYY-MM-DD
addressId	String	Y	1-50	Identifier for the address. Mandatory unless `addressLine1` and `postCode` are provided.
addressLine1	String	Y	1-255	Customer address details
addressLine2	String	N	0-255
addressLine3	String	N	0-255
city	String	N	0-64
state	String	N	0-64
country	String	N	2	2 letter country code as described in ISO 3166-1 alpha-2.
postCode	String	Y	1-16	Post or zip code
bookingReference	String	N	0-32
orderNotes	String	N	0-500
stockStatus	String	N		Possible values: `AGED` `AVAILABLE` `DAMAGED` `EXPIRED` `KITTING` `QA` `QC`
orderRequestLines { clientOrderReference productId quantity unitPrice }	Object String String Integer BigDecimal	Y N Y Y N	0-64	The products and quantities that make up the order. Client order refernce is the order number when unique per order line. ProductId can be either the THG SKU order product barcode.
deliveryDateStart	String	N		Date format: yyyy-MM-dd'T'HH:mm:ss
deliveryDateEnd	String	N		Date format: yyyy-MM-dd'T'HH:mm:ss
customerPurchaseOrderNumber	String	N	0-64	The customer's PO Number for this order.

","urlObject":{"path":["b2b","order","request"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"7afaffc3-d9cd-45e5-9b9f-2a59ee46ee66","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"orderNumber\": \"THG-12345\",\n \"requestedDeliveryDate\": \"2025-02-01\",\n \"addressId\": \"1234\",\n \"addressLine1\": \"7-9 Sunbank Lane\",\n \"addressLine2\": \"Altrincham\",\n \"addressLine3\": \"\",\n \"city\": \"Trafford\",\n \"state\": \"Greater Manchester\",\n \"countryId\": \"GB\",\n \"postCode\": \"M90 5AA\",\n \"bookingReference\": \"AA1234\",\n \"orderNotes\": \"None.\",\n \"orderRequestLines\": [\n {\n \"productId\": \"123456\",\n \"quantity\": \"100\"\n },\n {\n \"productId\": \"654321\",\n \"quantity\": \"1200\"\n }\n ],\n \"deliveryDateStart\": \"2025-02-01T09:00:00\",\n \"deliveryDateEnd\": \"2025-03-01T10:00:00\",\n \"customerPurchaseOrderNumber\": \"PO1234\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/b2b/order/request"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""},{"id":"0b61f340-acc1-45cd-b5e0-8a4b498b7081","name":"400 Bad Request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"orderNumber\": \"THG-12345\",\n \"requestedDeliveryDate\": \"2025-02-01\",\n \"addressId\": \"1234\",\n \"addressLine1\": \"7-9 Sunbank Lane\",\n \"addressLine2\": \"Altrincham\",\n \"addressLine3\": \"\",\n \"city\": \"Trafford\",\n \"state\": \"Greater Manchester\",\n \"countryId\": \"GB\",\n \"postCode\": \"M90 5AA\",\n \"bookingReference\": \"AA1234\",\n \"orderNotes\": \"None.\",\n \"orderRequestLines\": [\n {\n \"productId\": \"123456\",\n \"quantity\": \"100\"\n },\n {\n \"productId\": \"654321\",\n \"quantity\": \"1200\"\n }\n ],\n \"deliveryDateStart\": \"2025-02-01\",\n \"deliveryDateEnd\": \"2025-03-01\",\n \"customerPurchaseOrderNumber\": \"PO1234\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/b2b/order/request"},"status":"Bad Request","code":400,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\"Cannot accept order request as order request with order number: THG-12345 already exists\""}],"_postman_id":"4f8b281a-b20f-40d0-a03c-49130d653678"},{"name":"/b2b/order/request/{orderNumber}","id":"0e400fe9-299e-446d-9183-77e8b1619d89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"*/*"}],"url":"{{baseUrl}}/b2b/order/request/:orderNumber","description":"

This GET endpoint returns the B2B Order Request for the provided orderNumber.

If found, the response provides the order request for the given orderNumber with the following data:

Property	Type	Length	Description
orderNumber	string	1-50
requestedDeliveryDate	string		Date format: YYYY-MM-DD
addressId	string	1-50
addressLine1	string	1-255	Customer address details
addressLine2	string	0-255
addressLine3	string	0-255
city	string	0-64
state	string	0-64
countryId	string	2	2 letter country code as described in ISO 3166-1 alpha-2.
postCode	string	1-16	Post or zip code
bookingReference	string
orderNotes	string
orderRequestLines { productId quantity }	Object string integer		The products and quantities that make up the order
deliveryDateStart	string		Date format: yyyy-MM-dd'T'HH:mm:ss
deliveryDateEnd	string		Date format: yyyy-MM-dd'T'HH:mm:ss
customerPurchaseOrderNumber	string	0-64	The customer's PO Number for this order.

","urlObject":{"path":["b2b","order","request",":orderNumber"],"host":["{{baseUrl}}"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"orderNumber"}]}},"response":[{"id":"87bd2879-83eb-42c7-a3f6-89f49496aaee","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*"}],"url":{"raw":"{{baseUrl}}/b2b/order/request/:orderNumber","host":["{{baseUrl}}"],"path":["b2b","order","request",":orderNumber"],"variable":[{"key":"orderNumber","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"orderNumber\": \"THG-12345\",\n \"requestedDeliveryDate\": \"2025-02-01\",\n \"addressId\": \"1234\",\n \"addressLine1\": \"7-9 Sunbank Lane\",\n \"addressLine2\": \"Altrincham\",\n \"addressLine3\": \"\",\n \"city\": \"Trafford\",\n \"state\": \"Greater Manchester\",\n \"countryId\": \"GB\",\n \"postCode\": \"M90 5AA\",\n \"bookingReference\": \"AA1234\",\n \"orderNotes\": \"None.\",\n \"orderRequestLines\": [\n {\n \"productId\": \"123456\",\n \"quantity\": \"100\"\n },\n {\n \"productId\": \"654321\",\n \"quantity\": \"1200\"\n }\n ],\n \"deliveryDateStart\": \"2025-02-01T09:00:00\",\n \"deliveryDateEnd\": \"2025-03-01T10:00:00\",\n \"customerPurchaseOrderNumber\": \"PO1234\"\n}"}],"_postman_id":"0e400fe9-299e-446d-9183-77e8b1619d89"},{"name":"/b2b/order/{orderNumber}","id":"ca0c1695-af8a-4052-a2e7-426d5a2fc51b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"*/*"}],"url":"{{baseUrl}}/b2b/order/:orderNumber","description":"

This GET endpoint returns the B2B Order for the provided orderNumber.

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
orderNumber	string	Y
thgOrderNumber	string	Y
deliveryAddressId	integer	N
deliveryAddress { addressId addressLine1 addressLine2 addressLine3 city state countryId postalCode }	Object	Y
expectedDispatchDate	string	N	Date format: YYYY-MM-DD
requestedDispatchDate	string	N	Date format: YYYY-MM-DD
readyByDate	string	N	Date format: YYYY-MM-DD
orderStatus	enum	Y	Allowed values:
			DRAFT DRAFT_DUPLICATE REQUESTED INVALID AWAITING_PRICE_VALIDATION PRICING_INVALID PRICING_VALID AWAITING_PROFORMA_CONFIRMATION PROFORMA_APPROVED PARTIALLY_RESERVED RESERVED PARTIALLY_RELEASED RELEASED PICKING PARTIALLY_PICKED PICKED PACKING PARTIALLY_PACKED PACKED PARTIALLY_DISPATCHED AWAITING_DISPATCH PROFORMA_REJECTED AWAITING_CREDIT_VALIDATION CREDIT_HELD AWAITING_CREDIT_APPROVAL AWAITING_PAYMENT CREDIT_REJECTED CREDIT_APPROVED PAYMENT_APPROVED PAYMENT_REJECTED READY_TO_RELEASE AWAITING_ORDER_CHANGE AWAITING_DISPATCH_UPLOAD HELD SUBMITTED_EXTERNAL CANCELLED DISPATCHED
notes	string	N
bookingReference	string	N
totalRequestedItems	integer	N
orderLines { productId productTitle quantity productQuantitySubmitted productQuantityDispatched deleted }	Object string string integer integer integer boolean	Y Y N N N N N	The products and quantities that make up the order
customerPurchaseOrderNumber	string	N	The customer's PO Number for this order.

","urlObject":{"path":["b2b","order",":orderNumber"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"615b3a09-0f29-433e-9b8d-b2b803a16c79","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"orderNumber"}]}},"response":[{"id":"59e4cb28-e915-4525-a634-0e537014bbab","name":"200 OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"*/*"}],"url":{"raw":"{{baseUrl}}/b2b/order/:orderNumber","host":["{{baseUrl}}"],"path":["b2b","order",":orderNumber"],"variable":[{"key":"orderNumber","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"orderNumber\": \"THG-12345\",\n \"deliveryAddressId\": 123,\n \"expectedDispatchDate\": \"2025-02-01\",\n \"requestedDispatchDate\": \"2025-02-02\",\n \"readyByDate\": \"2025-01-31\",\n \"orderStatus\": \"DRAFT\",\n \"notes\": \"None.\",\n \"bookingReference\": \"AA1234\",\n \"totalRequestedItems\": 1300,\n \"customerPurchaseOrderNumber\": \"PO1234\",\n \"orderLines\": [\n {\n \"productId\": \"123456\",\n \"quantity\": \"100\"\n },\n {\n \"productId\": \"654321\",\n \"quantity\": \"1200\"\n }\n ]\n}"}],"_postman_id":"ca0c1695-af8a-4052-a2e7-426d5a2fc51b"},{"name":"/b2b/order/cancel/{orderNumber}","id":"fca7ef9c-b851-4b3d-b60f-ce265a783b9d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"*/*"}],"url":"{{baseUrl}}/b2b/order/cancel/:orderNumber","description":"

This endpoint requests the cancellation of the given B2B Order orderNumber.

\n","urlObject":{"path":["b2b","order","cancel",":orderNumber"],"host":["{{baseUrl}}"],"query":[],"variable":[{"type":"any","value":"","key":"orderNumber"}]}},"response":[{"id":"4e16ac10-076f-4c78-a715-03d0ca8e51b2","name":"OK","originalRequest":{"method":"POST","header":[{"key":"Accept","value":"*/*"}],"url":{"raw":"{{baseUrl}}/b2b/order/:orderNumber/cancel","host":["{{baseUrl}}"],"path":["b2b","order",":orderNumber","cancel"],"variable":[{"key":"orderNumber","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"fca7ef9c-b851-4b3d-b60f-ce265a783b9d"},{"name":"/b2b/order/list","id":"cb95d871-18ec-4e02-91a6-7be8154add64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":" { \n \"search\": \"\",\n \"expectedDispatchDateFrom\": \"\",\n \"expectedDispatchDateTo\": \"\",\n \"requestedDispatchDateFrom\": \"\",\n \"requestedDispatchDateTo\": \"\",\n \"statuses\": [\"\"],\n \"sortBy\": \"\",\n \"sortDirection\": \"\",\n \"page\": \"\",\n \"size\": \"\"\n }","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/b2b/order/list?page=&size=&sort=","description":"

This POST endpoint is used to search for B2B orders.

Both the request parameters and request body are optional. Empty request body provided as {}.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
search	string	N	Search string, looks up by order number, THG order number, or booking reference number.
expectedDispatchDateFrom	string	N	eg. \"2026-03-01\"
expectedDispatchDateTo	string	N	eg. \"2026-03-02\"
requestedDispatchDateFrom	string	N	eg. \"2026-03-01\"
requestedDispatchDateTo	string	N	eg. \"2026-03-02\"
statuses	[\"string\"]	N	List of B2B order statuses. Allowed values: DRAFT DRAFT_DUPLICATE REQUESTED INVALID AWAITING_PRICE_VALIDATION PRICING_INVALID PRICING_VALID AWAITING_PROFORMA_CONFIRMATION PROFORMA_APPROVED PARTIALLY_RESERVED RESERVED PARTIALLY_RELEASED RELEASED PICKING PARTIALLY_PICKED PICKED PACKING PARTIALLY_PACKED PACKED PARTIALLY_DISPATCHED AWAITING_DISPATCH PROFORMA_REJECTED AWAITING_CREDIT_VALIDATION CREDIT_HELD AWAITING_CREDIT_APPROVAL AWAITING_PAYMENT CREDIT_REJECTED CREDIT_APPROVED PAYMENT_APPROVED PAYMENT_REJECTED READY_TO_RELEASE AWAITING_ORDER_CHANGE AWAITING_DISPATCH_UPLOAD HELD SUBMITTED_EXTERNAL CANCELLED DISPATCHED
sortBy	string	N	Accepted values: `CREATED_WHEN`, `ORDER_NUMBER` When status/date filters are active, then `ORDER_STATUS`, `EXPECTED_DISPATCH_DATE`, `REQUESTED_DISPATCH_DATE` are accepted as well.
sortDirection	string	N	`ASC` or `DESC`
page	integer	N	Page number, eg. `0`
size	integer	N	Number of entries per page, eg. `10` Max 100, default 10.

","urlObject":{"path":["b2b","order","list"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"

Page number. Optional and only applied if the request body 'page' is null.

\n","type":"text/plain"},"key":"page","value":""},{"description":{"content":"

Number of entries per page. Max 100, default 10. Only applied if the request body 'size' is null.

\n","type":"text/plain"},"key":"size","value":""},{"description":{"content":"

Format: fieldName,direction e.g. ORDER_NUMBER,DESC. Only applied if the request body 'sortBy' is null.

\n","type":"text/plain"},"key":"sort","value":""}],"variable":[]}},"response":[{"id":"cfec1c39-904d-42c2-b937-2152a8761f03","name":"OK","originalRequest":{"method":"POST","header":[{"key":"content-type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"search\": \"TEST-001\"\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/b2b/order/list"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"content\": [\n {\n \"orderNumber\": \"TEST-001\",\n \"thgOrderNumber\": \"DEM-20260305-1547616\",\n \"status\": \"RELEASED\",\n \"totalRequestedItems\": 10,\n \"bookingReference\": \"REF_001\",\n \"customerPurchaseOrderNumber\": \"TEST-001\",\n \"expectedDispatchDate\": \"2030-03-13\",\n \"requestedDispatchDate\": \"2030-03-13\",\n \"trackingNumber\": null\n }\n ],\n \"totalElements\": 1,\n \"totalPages\": 1,\n \"page\": 0,\n \"size\": 10\n}"}],"_postman_id":"cb95d871-18ec-4e02-91a6-7be8154add64"}],"id":"21c8ea1b-29b5-49e4-9468-74ca89887a1f","_postman_id":"21c8ea1b-29b5-49e4-9468-74ca89887a1f","description":""},{"name":"Subscriptions","item":[{"name":"/b2b/events/subscription/{subscription_id}","id":"6de29edb-d3ec-4dec-b1ac-e0595f9555d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"subscription_id\": \"\",\n \"subscription_detail\": [\n {\n \"organisation\": \"\",\n \"method\": \"\",\n \"entity_type\": \"\"\n },\n {\n \"organisation\": \"\",\n \"method\": \"\",\n \"entity_type\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/b2b/events/subscription/:subscription_id","description":"

Creates a subscription using the specified subscription_id to one or more entity_types. The entity_types represent the type of events to receive.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Length	Description
subscription_id	String	Y	1-128	Id of the subscription
organisation	String	Y	1-64	Name of the organisation. This must match the name of the organisation supplied with credentials
method	String	N		Not yet implemented
entity_type	String	Y	1-32	Valid entity_types: `order_acknowledgement` `ship_notice` `order_state_change` `delivery_address_response`

","urlObject":{"path":["b2b","events","subscription",":subscription_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"395a29a9-8495-412c-aadf-444b34e061a5","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"subscription_id"}]}},"response":[{"id":"18df3ea2-0f0f-40d5-992b-bfad9104c16e","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"subscription_id\": \"\",\n \"subscription_detail\": [\n {\n \"organisation\": \"\",\n \"method\": \"\",\n \"entity_type\": \"\"\n },\n {\n \"organisation\": \"\",\n \"method\": \"\",\n \"entity_type\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/b2b/events/subscription/:subscription_id","host":["{{baseUrl}}"],"path":["b2b","events","subscription",":subscription_id"],"variable":[{"key":"subscription_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"organisation\": \"\",\n \"method\": \"\",\n \"entity_type\": \"\"\n}"},{"id":"08e2e2cc-624d-4e0c-b148-4cc8878ec493","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"subscription_id\": \"\",\n \"subscription_detail\": [\n {\n \"organisation\": \"\",\n \"method\": \"\",\n \"entity_type\": \"\"\n },\n {\n \"organisation\": \"\",\n \"method\": \"\",\n \"entity_type\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/b2b/events/subscription/:subscription_id","host":["{{baseUrl}}"],"path":["b2b","events","subscription",":subscription_id"],"variable":[{"key":"subscription_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"53d6a29a-2bdd-478e-aad0-6c6c8c765ffd","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"subscription_id\": \"\",\n \"subscription_detail\": [\n {\n \"organisation\": \"\",\n \"method\": \"\",\n \"entity_type\": \"\"\n },\n {\n \"organisation\": \"\",\n \"method\": \"\",\n \"entity_type\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/b2b/events/subscription/:subscription_id","host":["{{baseUrl}}"],"path":["b2b","events","subscription",":subscription_id"],"variable":[{"key":"subscription_id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"6de29edb-d3ec-4dec-b1ac-e0595f9555d5"},{"name":"/b2b/events/subscription/{subscription_id}","id":"09615682-b191-49e7-bfe7-674469c96689","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/b2b/events/subscription/:subscription_id","description":"

Deletes the specified subscription

\n","urlObject":{"path":["b2b","events","subscription",":subscription_id"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"44f31220-dcee-4e03-bfd1-1eafc0a829bf","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"subscription_id"}]}},"response":[{"id":"eb1495ab-b79e-4a31-bb81-449f399e9b20","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/b2b/events/subscription/:subscription_id","host":["{{baseUrl}}"],"path":["b2b","events","subscription",":subscription_id"],"variable":[{"key":"subscription_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"f0dcc3e0-690d-4dfd-9476-4e7d70f28220","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/b2b/events/subscription/:subscription_id","host":["{{baseUrl}}"],"path":["b2b","events","subscription",":subscription_id"],"variable":[{"key":"subscription_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"75e0e480-6fa5-4d28-bd5f-b394d9f303e8","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/b2b/events/subscription/:subscription_id","host":["{{baseUrl}}"],"path":["b2b","events","subscription",":subscription_id"],"variable":[{"key":"subscription_id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"09615682-b191-49e7-bfe7-674469c96689"},{"name":"/b2b/events/subscription/{subscription_id}/listen","id":"9b6a1e82-e29c-4705-9fe6-4cda0ab138c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/b2b/events/subscription/:subscription_id/listen","description":"

Retrieves all events of the entity_type's specified when creating the subscription. This endpoint returns an array containing an object, detailed below, per entity_type subscribed to.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Description
organisation	Name of organisation
method	Name of method
events[] ..id ..data	Array of events of type: `{ \"id\": \"uuid\", \"data\": {} }`
entity_type	Name of entity type Possible values: `order_acknowledgement` `ship_notice` `order_state_change` `delivery_address_response`

The data objects vary depending on the entity_type:

order_acknowledgement

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Decription

{\n  \"lines\": [\n    {\n      \"acknowledgedQuantity\": \"\",\n      \"dcCode\": \"\",\n      \"measure\": \"\",\n      \"priceTotalNet\": \"\",\n      \"productId\": \"\",\n      \"rejectedReason\": \"\",\n      \"requestedQuantity\": \"\",\n      \"storeNumber\": \"\",\n      \"title\": \"\",\n      \"unitPrice\": \"\"\n    }\n  ],\n  \"orderNumber\": \"\",\n  \"requestedDeliveryDateEnd\": \"\",\n  \"requestedDeliveryDateStart\": \"\",\n  \"requestedDispatchDate\": \"\",\n  \"status\": \"\",\n  \"totalNet\": 70\n}\n\n

ship_notice

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
indentifierType	String	Possible values: `SERIAL_NUMBER` `IMEI` `IMEI2` `EID` `UPC`
identifierValue	String

{\n  \"allProducts\": [\n    {\n      \"barcode\": \"\",\n      \"batchNumber\": \"\",\n      \"customerProductId\": \"\",\n      \"expirationDate\": \"\",\n      \"productId\": \"\",\n      \"quantityDispatched\": \"\",\n      \"quantityOrdered\": \"\",\n      \"quantityPerTradedUnit\": \"\",\n      \"quantityShipped\": \"\",\n      \"quantityUnitOfMeasure\": \"\",\n      \"title\": \"\"\n    }\n  ],\n  \"billOfLading\": \"\",\n  \"customerPurchaseOrderNumber\": \"\",\n  \"carrierName\": \"\",\n  \"carrierTrackingNumber\": \"\",\n  \"dispatchAdviceNumber\": \"\",\n  \"dispatchDate\": \"\",\n  \"estimatedShippingDuration\": \"\",\n  \"orderCreatedDate\": \"\",\n  \"packagingType\": \"\",\n  \"purchaseOrderNumber\": \"\",\n  \"requestedDeliveryDate\": \"\",\n  \"scheduledDeliveryDate\": \"\",\n  \"shipNoticeLines\": [\n    {\n      \"cartonQuantity\": \"\",\n      \"children\": [\n        {\n          \"cartonQuantity\": \"\",\n          \"children\": [\n            {\n              \"cartonQuantity\": \"\",\n              \"children\": [],\n              \"height\": \"\",\n              \"lengthUnit\": \"\",\n              \"levelCode\": \"\",\n              \"quantity\": \"\",\n              \"shipNoticeProducts\": [\n                {\n                  \"barcode\": \"\",\n                  \"batchNumber\": \"\",\n                  \"customerProductId\": \"\",\n                  \"expirationDate\": \"\",\n                  \"productId\": \"\",\n                  \"productUnits\": [\n                    {\n                      \"identifiers\": [\n                        {\n                          \"identifierType\": \"\",\n                          \"identifierValue\": \"\"\n                        },\n                        {\n                          \"identifierType\": \"\",\n                          \"identifierValue\": \"\"\n                        }\n                      ]\n                    }\n                  ],\n                  \"quantityDispatched\": \"\",\n                  \"quantityOrdered\": \"\",\n                  \"quantityPerTradedUnit\": \"\",\n                  \"quantityShipped\": \"\",\n                  \"quantityUnitOfMeasure\": \"\",\n                  \"title\": \"\"\n                }\n              ],\n              \"sscc\": \"\",\n              \"totalGrossWeight\": \"\",\n              \"totalNetWeight\": \"\",\n              \"weightUnit\": \"\",\n              \"width\": \"\"\n            }\n          ],\n          \"height\": \"\",\n          \"lengthUnit\": \"\",\n          \"levelCode\": \"\",\n          \"quantity\": \"\",\n          \"shipNoticeProducts\": [],\n          \"sscc\": \"\",\n          \"totalGrossWeight\": \"\",\n          \"totalNetWeight\": \"\",\n          \"weightUnit\": \"\",\n          \"width\": \"\"\n        }\n      ],\n      \"height\": \"\",\n      \"lengthUnit\": \"\",\n      \"levelCode\": \"\",\n      \"quantity\": \"\",\n      \"shipNoticeProducts\": [],\n      \"sscc\": \"\",\n      \"totalGrossWeight\": \"\",\n      \"totalNetWeight\": \"\",\n      \"weightUnit\": \"\",\n      \"width\": \"\"\n    }\n  ],\n  \"totalQuantity\": \"\",\n  \"transportPaymentMethod\": \"\",\n  \"transportType\": \"\",\n  \"vehicleNumber\": \"\"\n}\n\n

order_state_change

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
createdWhen	String
customerIdentifier	String
externalOrderReference	String
orderNumber	String
orderStatus	String	Possible values: `DRAFT` = Order created `REQUESTED` = Order accepted `INVALID` = Order invalid `HELD` = Held `RELEASED` = Order accepted `AWAITING_DISPATCH` = Ready for dispatch `DISPATCHED` = Dispatched `CANCELLED` = Cancelled

{ \n    \"createdWhen\": \"\", \n    \"customerIdentifier\": \"\", \n    \"externalOrderReference\": \"\", \n    \"orderNumber\": \"\", \n    \"orderStatus\": \"\" \n}  \n\n

delivery_address_response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
actionType	String	Possible values: `CREATE, UPDATE, DELETE`
requestId	String
status	String	Possible values: `SUCCESS, FAILURE`
error	Object	addressId: String errors: Array[String]

{\n  \"actionType\": \"\",\n  \"error\": [\n    {\n      \"addressId\": \"\",\n      \"errors\": [\n        \"\"\n      ]\n    }\n  ],\n  \"requestId\": \"\",\n  \"status\": \"\"\n}\n\n

\n","urlObject":{"path":["b2b","events","subscription",":subscription_id","listen"],"host":["{{baseUrl}}"],"query":[],"variable":[{"description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"subscription_id"}]}},"response":[{"id":"925a8815-822d-4f0c-b55e-617ec91fb24e","name":"OK","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/b2b/events/subscription/:subscription_id/listen","host":["{{baseUrl}}"],"path":["b2b","events","subscription",":subscription_id","listen"],"variable":[{"key":"subscription_id","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"organisation\": \"\",\n \"method\": \"\",\n \"events\": [\n {\n \"id\": \"\",\n \"data\": {}\n },\n {\n \"id\": \"\",\n \"data\": {}\n }\n ],\n \"entity_type\": \"\"\n }\n]"}],"_postman_id":"9b6a1e82-e29c-4705-9fe6-4cda0ab138c2"},{"name":"/b2b/events/subscription/{subscription_id}/confirm","id":"9f82fd61-7603-46c4-82a7-2b10556b2c07","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"receipt-handle","value":""},{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/b2b/events/subscription/:subscription_id/confirm","description":"

Deletes the event from the queue based on the subscription_id in the url and receipt-handle in the request header. The receipt-handle must match the id from an event object.

\n","urlObject":{"path":["b2b","events","subscription",":subscription_id","confirm"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"4ac3e602-12f3-4153-80eb-452a9a21d35d","description":{"content":"

(Required)

\n","type":"text/plain"},"type":"any","value":"","key":"subscription_id"}]}},"response":[{"id":"5706ad03-3326-4a6a-adf2-46824252e1eb","name":"OK","originalRequest":{"method":"DELETE","header":[{"key":"receipt-handle","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/b2b/events/subscription/:subscription_id/confirm","host":["{{baseUrl}}"],"path":["b2b","events","subscription",":subscription_id","confirm"],"variable":[{"key":"subscription_id"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"37ce1290-9837-4179-846d-7faf642352d2","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[{"key":"receipt-handle","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/b2b/events/subscription/:subscription_id/confirm","host":["{{baseUrl}}"],"path":["b2b","events","subscription",":subscription_id","confirm"],"variable":[{"key":"subscription_id"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"45e70510-ff97-49a8-9273-9c3144e01b13","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[{"key":"receipt-handle","value":""},{"key":"Accept","value":"application/json"}],"url":{"raw":"{{baseUrl}}/b2b/events/subscription/:subscription_id/confirm","host":["{{baseUrl}}"],"path":["b2b","events","subscription",":subscription_id","confirm"],"variable":[{"key":"subscription_id"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"9f82fd61-7603-46c4-82a7-2b10556b2c07"}],"id":"e5fddce6-0aaf-434f-9bb5-1e6abaf2844b","_postman_id":"e5fddce6-0aaf-434f-9bb5-1e6abaf2844b","description":""}],"id":"32729255-abbc-4cc6-8a8e-13dfba96f938","description":"

The B2B Order Management API is a public-facing interface to allow Ingenuity clients to place or cancel orders and receive updates on order progress, including advance shipping notifications (ASNs).

This is a simplified diagram of the general B2B order flow and the key return events:

","_postman_id":"32729255-abbc-4cc6-8a8e-13dfba96f938"},{"name":"Customer Events","item":[{"name":"Outbound","item":[{"name":"Customer Created and updated ref: CUS.O.01","id":"33ddf33c-5b4f-4d20-96a3-9feb33361ceb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"evt_0df242a3-6ac2-4781-8449-cc94d0a941b0\",\n \"object\": \"event\",\n \"type\": \"customer.created\",\n \"created\": \"2022-09-15T14:30:36.0000783+0000\",\n \"data\": {\n \"object\": {\n \"id\": 16272,\n \"uuid\": \"441E5B3F-C4F6-4F0C-BAE0-1171D89D0E1E\",\n \"name\": \"Customer_16272\",\n \"title\": \"Mr\",\n \"registeredTime\": \"2022-09-15T14:26:24.0000003+0000\",\n \"siteRegistered\": \"Test_site_2\",\n \"localeRegistered\": \"en_GB\",\n \"isGuest\": false,\n \"marketingOptinStatus\": {\n \"email\": {\n \"updatedTimestamp\": \"2022-09-15T14:26:24.0000003+0000\",\n \"receiveMarketing\": false\n },\n \"sms\": null\n },\n \"metadata\": {\n },\n \"address\": [\n {\n \"addressId\": 2131,\n \"addressUuid\": \"941A5B3F-C4F6-4F0C-BAE0-0000D00D0E0E\",\n \"defaultAddressFlags\": [\n \"DELIVERY_ADDRESS\", \"BILLING_ADDRESS\"\n ],\n \"companyName\": \"THG Example Address 1\",\n \"houseNameNumber\": null,\n \"streetName\": null,\n \"addressLine2\": \"123\",\n \"addressLine3\": \"Portswood Road\",\n \"addressLine4\": \"Southampton\",\n \"postCode\": \"SO12 3NU\",\n \"countryCode\": \"GB\"\n },\n {\n \"addressId\": 3211,\n \"addressUuid\": \"321E5B3F-C4F6-4F0C-BAE0-0000D00D0E2D\",\n \"defaultAddressFlags\": [],\n \"companyName\": \"THG Example Address 2\",\n \"houseNameNumber\": null,\n \"streetName\": null,\n \"addressLine2\": \"121\",\n \"addressLine3\": \"Portswood Road\",\n \"addressLine4\": \"Southampton\",\n \"postCode\": \"SO17 3NP\",\n \"countryCode\": \"GB\"\n },\n {\n \"addressId\": 5555,\n \"addressUuid\": \"321E5B3F-C4F6-4F0C-BAE0-0000D00D0E2D\",\n \"defaultAddressFlags\": [],\n \"companyName\": \"THG BILLING\",\n \"houseNameNumber\": null,\n \"streetName\": null,\n \"addressLine2\": \"121\",\n \"addressLine3\": \"Portswood Road\",\n \"addressLine4\": \"Southampton\",\n \"postCode\": \"SO17 3NP\",\n \"countryCode\": \"GB\"\n }\n ],\n \"emailAddress\": \"David@thehutgroup.com\",\n \"emailVerified\": \"2022-09-15T15:26:24.0000003+0000\",\n \"mobileNumber\": null,\n \"referralCode\": \"ALASTAIR-RM\",\n \"numberOfReferrals\": 6,\n \"userDisabledTime\": \"2022-09-15T14:26:24.0000003+0000\",\n \"userDeletedTime\": null\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"/v1/customerCreated","description":"

Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Response Code	Meaning
2xx	Tells us you have successfully received and/or processed the request.
400-403,405	This will not be retried.
429	Too many requests. Use this if you have a rate limit in place. This will signal to us to retry.
5xx	This will signal to us to retry.
All other response code	Anything not covered above will default to a retry policy until all retries are exshausted

Json Schema

{\n  \"$schema\": \"https://json-schema.org/draft/2019-09/schema\",\n  \"$id\": \"http://example.com/example.json\",\n  \"type\": \"object\",\n  \"default\": {},\n  \"title\": \"Root Schema\",\n  \"required\": [\n    \"id\",\n    \"object\",\n    \"type\",\n    \"created\",\n    \"data\"\n  ],\n  \"properties\": {\n    \"id\": {\n      \"type\": \"string\",\n      \"default\": \"\",\n      \"title\": \"The id Schema\",\n      \"examples\": [\n        \"evt_0df242a3-6ac2-4781-8449-cc94d0a941b0\"\n      ]\n    },\n    \"object\": {\n      \"type\": \"string\",\n      \"default\": \"\",\n      \"title\": \"The object Schema\",\n      \"examples\": [\n        \"event\"\n      ]\n    },\n    \"type\": {\n      \"type\": \"string\",\n      \"default\": \"\",\n      \"title\": \"The type Schema\",\n      \"examples\": [\n        \"customer.created\"\n      ]\n    },\n    \"created\": {\n      \"type\": \"string\",\n      \"default\": \"\",\n      \"title\": \"The created Schema\",\n      \"examples\": [\n        \"2022-09-15T14:30:36.0000783+0000\"\n      ]\n    },\n    \"data\": {\n      \"type\": \"object\",\n      \"default\": {},\n      \"title\": \"The data Schema\",\n      \"required\": [\n        \"object\"\n      ],\n      \"properties\": {\n        \"object\": {\n          \"type\": \"object\",\n          \"default\": {},\n          \"title\": \"The object Schema\",\n          \"required\": [\n            \"id\",\n            \"uuid\",\n            \"name\",\n            \"title\",\n            \"registeredTime\",\n            \"siteRegistered\",\n            \"localeRegistered\",\n            \"isGuest\",\n            \"marketingOptinStatus\",\n            \"metadata\",\n            \"address\",\n            \"emailAddress\",\n            \"referralCode\",\n            \"numberOfReferrals\"\n          ],\n          \"properties\": {\n            \"id\": {\n              \"type\": \"integer\",\n              \"default\": 0,\n              \"title\": \"The id Schema\",\n              \"examples\": [\n                16272\n              ]\n            },\n            \"uuid\": {\n              \"type\": [\"string\"],\n              \"default\": \"\",\n              \"title\": \"The uuid Schema\",\n              \"examples\": [\n                \"441E5B3F-C4F6-4F0C-BAE0-1171D89D0E1E\"\n              ]\n            },\n            \"name\": {\n              \"type\": \"string\",\n              \"default\": \"\",\n              \"title\": \"The name Schema\",\n              \"examples\": [\n                \"Customer_16272\"\n              ]\n            },\n            \"title\": {\n              \"type\": \"string\",\n              \"default\": \"\",\n              \"title\": \"The title Schema\",\n              \"examples\": [\n                \"Mr\"\n              ]\n            },\n            \"registeredTime\": {\n              \"type\": \"string\",\n              \"default\": \"\",\n              \"title\": \"The registeredTime Schema\",\n              \"examples\": [\n                \"2022-09-15T14:26:24.0000003+0000\"\n              ]\n            },\n            \"siteRegistered\": {\n              \"type\": \"string\",\n              \"default\": \"\",\n              \"title\": \"The siteRegistered Schema\",\n              \"examples\": [\n                \"Test_site_2\"\n              ]\n            },\n            \"localeRegistered\": {\n              \"type\": [\"string\"],\n              \"default\": \"\",\n              \"title\": \"The localeRegistered Schema\",\n              \"examples\": [\n                \"en_GB\"\n              ]\n            },\n            \"isGuest\": {\n              \"type\": [\"boolean\"],\n              \"default\": false,\n              \"title\": \"The isGuest Schema\",\n              \"examples\": [\n                false\n              ]\n            },\n            \"marketingOptinStatus\": {\n              \"type\": \"object\",\n              \"default\": {},\n              \"title\": \"The marketingOptinStatus Schema\",\n              \"required\": [\n                \"email\"\n              ],\n              \"properties\": {\n                \"email\": {\n                  \"type\": \"object\",\n                  \"default\": {},\n                  \"title\": \"The email Schema\",\n                  \"required\": [\n                    \"updatedTimestamp\",\n                    \"receiveMarketing\"\n                  ],\n                  \"properties\": {\n                    \"updatedTimestamp\": {\n                      \"type\": [\"string\", \"null\"],\n                      \"default\": null,\n                      \"title\": \"The updatedTimestamp Schema\",\n                      \"examples\": [\n                        \"2022-09-15T14:26:24.0000003+0000\",\n                        null\n                      ]\n                    },\n                    \"receiveMarketing\": {\n                      \"type\": \"boolean\",\n                      \"default\": false,\n                      \"title\": \"The receiveMarketing Schema\",\n                      \"examples\": [\n                        false\n                      ]\n                    }\n                  },\n                  \"examples\": [{\n                    \"updatedTimestamp\": \"2022-09-15T14:26:24.0000003+0000\",\n                    \"receiveMarketing\": false\n                  }]\n                },\n                \"sms\": {\n                  \"type\": [\"object\", \"null\"],\n                  \"default\": null,\n                  \"title\": \"The sms Schema\",\n                  \"required\": [\n                    \"updatedTimestamp\",\n                    \"receiveMarketing\"\n                  ],\n                  \"properties\": {\n                    \"updatedTimestamp\": {\n                      \"type\": \"string\",\n                      \"default\": null,\n                      \"title\": \"The updatedTimestamp Schema\"\n                    },\n                    \"receiveMarketing\": {\n                      \"type\": \"boolean\",\n                      \"default\": false,\n                      \"title\": \"The receiveMarketing Schema\"\n                    }\n                  },\n                  \"examples\": [{\n                    \"updatedTimestamp\": \"2022-09-15T14:26:24.0000003+0000\",\n                    \"receiveMarketing\": false\n                  },\n                    null\n                  ]\n                }\n              },\n              \"examples\": [{\n                \"email\": {\n                  \"updatedTimestamp\": \"2022-09-15T14:26:24.0000003+0000\",\n                  \"receiveMarketing\": false\n                },\n                \"sms\": null\n              }]\n            },\n            \"metadata\": {\n              \"type\": \"object\",\n              \"default\": {},\n              \"title\": \"The metadata Schema\",\n              \"additionalProperties\": {\n                \"type\": \"string\"\n              },\n              \"examples\": [\n                {\n                  \"gender\": \"Male\",\n                  \"rewardCardNumber\": \"123456\",\n                  \"dateOfBirth\": \"01/01/1970\"\n                },\n                {\n                  \"gender\": \"Male\",\n                  \"dateOfBirth\": \"01/01/1970\"\n                },\n                {\n                  \"rewardCardNumber\": \"123456\"\n                },\n                {\n                }\n              ]\n            },\n            \"address\": {\n              \"type\": \"array\",\n              \"default\": [],\n              \"title\": \"The address Schema\",\n              \"items\": {\n                \"type\": \"object\",\n                \"default\": {},\n                \"title\": \"A Schema\",\n                \"required\": [\n                  \"addressId\",\n                  \"addressUuid\",\n                  \"defaultAddressFlags\",\n                  \"houseNameNumber\",\n                  \"postCode\",\n                  \"countryCode\"\n                ],\n                \"properties\": {\n                  \"addressId\": {\n                    \"type\": \"integer\",\n                    \"default\": 0,\n                    \"title\": \"The addressId Schema\",\n                    \"examples\": [\n                      999\n                    ]\n                  },\n                  \"addressUuid\": {\n                    \"type\": \"string\",\n                    \"default\": \"\",\n                    \"title\": \"The addressUuid Schema\",\n                    \"examples\": [\n                      \"941E5B3F-C4F6-4F0C-BAE0-0000D00D0E0E\"\n                    ]\n                  },\n                  \"defaultAddressFlags\": {\n                    \"type\": \"array\",\n                    \"default\": [],\n                    \"items\": [\n                      {\n                        \"type\": [\"string\", \"null\"],\n                        \"default\": null,\n                        \"title\": \"The defaultAddressFlags schema\",\n                        \"examples\": [\n                          [\"DELIVERY_ADDRESS\"],\n                          [\"DELIVERY_ADDRESS\", \"BILLING_ADDRESS\"],\n                          []\n                        ]\n                      }\n                    ]\n                  },\n                  \"companyName\": {\n                    \"type\": [\"string\", \"null\"],\n                    \"default\": null,\n                    \"title\": \"The companyName Schema\",\n                    \"examples\": [\n                      \"THG\"\n                    ]\n                  },\n                  \"houseNameNumber\": {\n                    \"type\": [\"string\"],\n                    \"default\": \"\",\n                    \"title\": \"The houseNameNumber Schema\",\n                    \"examples\": [\n                      null\n                    ]\n                  },\n                  \"streetName\": {\n                    \"type\": [\"string\",\"null\"],\n                    \"default\": null,\n                    \"title\": \"The streetName Schema\",\n                    \"examples\": [\n                      null\n                    ]\n                  },\n                  \"addressLine2\": {\n                    \"type\": [\"string\", \"null\"],\n                    \"default\": null,\n                    \"title\": \"The addressLine2 Schema\",\n                    \"examples\": [\n                      \"119\"\n                    ]\n                  },\n                  \"addressLine3\": {\n                    \"type\": [\"string\", \"null\"],\n                    \"default\": null,\n                    \"title\": \"The addressLine3 Schema\",\n                    \"examples\": [\n                      \"Portswood Road\"\n                    ]\n                  },\n                  \"addressLine4\": {\n                    \"type\": [\"string\", \"null\"],\n                    \"default\": null,\n                    \"title\": \"The addressLine4 Schema\",\n                    \"examples\": [\n                      \"Southampton\"\n                    ]\n                  },\n                  \"postCode\": {\n                    \"type\": \"string\",\n                    \"default\": \"\",\n                    \"title\": \"The postCode Schema\",\n                    \"examples\": [\n                      \"SO17 3NU\"\n                    ]\n                  },\n                  \"countryCode\": {\n                    \"type\": \"string\",\n                    \"default\": \"\",\n                    \"title\": \"The countryCode Schema\",\n                    \"examples\": [\n                      \"GB\"\n                    ]\n                  }\n                },\n                \"examples\": [{\n                  \"addressId\": 999,\n                  \"addressUuid\": \"941E5B3F-C4F6-4F0C-BAE0-0000D00D0E0E\",\n                  \"defaultAddressFlags\": [\"DEFAULT_BILLING\"],\n                  \"companyName\": \"THG\",\n                  \"houseNameNumber\": null,\n                  \"streetName\": null,\n                  \"addressLine2\": \"119\",\n                  \"addressLine3\": \"Portswood Road\",\n                  \"addressLine4\": \"Southampton\",\n                  \"postCode\": \"SO17 3NU\",\n                  \"countryCode\": \"GB\"\n                }]\n              },\n              \"examples\": [\n                [{\n                  \"addressId\": 999,\n                  \"addressUuid\": \"941E5B3F-C4F6-4F0C-BAE0-0000D00D0E0E\",\n                  \"defaultAddressFlags\": [\"DEFAULT_BILLING\"],\n                  \"companyName\": \"THG\",\n                  \"houseNameNumber\": null,\n                  \"streetName\": null,\n                  \"addressLine2\": \"119\",\n                  \"addressLine3\": \"Portswood Road\",\n                  \"addressLine4\": \"Southampton\",\n                  \"postCode\": \"SO17 3NU\",\n                  \"countryCode\": \"GB\"\n                }]\n              ]\n            },\n            \"emailAddress\": {\n              \"type\": \"string\",\n              \"default\": \"\",\n              \"title\": \"The emailAddress Schema\",\n              \"examples\": [\n                \"David@thehutgroup.com\"\n              ]\n            },\n            \"emailVerified\": {\n              \"type\": [\"string\", \"null\"],\n              \"default\": null,\n              \"title\": \"The emailVerified Schema\",\n              \"examples\": [\n                \"2022-09-15T15:26:24.0000003+0000\",\n                null\n              ]\n            },\n            \"mobileNumber\": {\n              \"type\": [\"string\",\"null\"],\n              \"default\": null,\n              \"title\": \"The mobileNumber Schema\",\n              \"examples\": [\n                \"+447746292312\",\n                null\n              ]\n            },\n            \"referralCode\": {\n              \"type\": \"string\",\n              \"default\": \"\",\n              \"title\": \"The referralCode Schema\",\n              \"examples\": [\n                \"ALASTAIR-RM\"\n              ]\n            },\n            \"numberOfReferrals\": {\n              \"type\": [\"integer\"],\n              \"default\": 0,\n              \"title\": \"The numberOfReferrals Schema\",\n              \"examples\": [\n                6\n              ]\n            },\n            \"userDisabledTime\": {\n              \"type\": [\"string\", \"null\"],\n              \"default\": null,\n              \"title\": \"The userDisabledTime Schema\",\n              \"examples\": [\n                \"2022-09-15T14:26:24.0000003+0000\",\n                null\n              ]\n            },\n            \"userDeletedTime\": {\n              \"type\": [\"string\", \"null\"],\n              \"default\": null,\n              \"title\": \"The userDeletedTime Schema\",\n              \"examples\": [\n                \"2022-09-15T14:26:24.0000003+0000\",\n                null\n              ]\n            }\n          },\n          \"examples\": [{\n            \"id\": 16272,\n            \"uuid\": \"441E5B3F-C4F6-4F0C-BAE0-1171D89D0E1E\",\n            \"name\": \"Customer_16272\",\n            \"title\": \"Mr\",\n            \"registeredTime\": \"2022-09-15T14:26:24.0000003+0000\",\n            \"siteRegistered\": \"Test_site_2\",\n            \"localeRegistered\": \"en_GB\",\n            \"isGuest\": false,\n            \"marketingOptinStatus\": {\n              \"email\": {\n                \"updatedTimestamp\": \"2022-09-15T14:26:24.0000003+0000\",\n                \"receiveMarketing\": false\n              },\n              \"sms\": null\n            },\n            \"metadata\": {\n              \"gender\": \"Male\",\n              \"rewardCardNumber\": \"123456\",\n              \"dateOfBirth\": \"01/01/1970\"\n            },\n            \"address\": [{\n              \"addressId\": 999,\n              \"addressUuid\": \"941E5B3F-C4F6-4F0C-BAE0-0000D00D0E0E\",\n              \"companyName\": \"THG\",\n              \"defaultAddressFlags\": [\"DEFAULT_BILLING\"],\n              \"houseNameNumber\": null,\n              \"streetName\": null,\n              \"addressLine2\": \"119\",\n              \"addressLine3\": \"Portswood Road\",\n              \"addressLine4\": \"Southampton\",\n              \"postCode\": \"SO17 3NU\",\n              \"countryCode\": \"GB\"\n            }],\n            \"emailAddress\": \"David@thehutgroup.com\",\n            \"emailVerified\": \"2022-09-15T15:26:24.0000003+0000\",\n            \"mobileNumber\": null,\n            \"referralCode\": \"ALASTAIR-RM\",\n            \"numberOfReferrals\": 6,\n            \"userDisabledTime\": null,\n            \"userDeletedTime\": null\n          }]\n        }\n      },\n      \"examples\": [\n        {\n          \"object\": {\n            \"id\": 16272,\n            \"uuid\": \"441E5B3F-C4F6-4F0C-BAE0-1171D89D0E1E\",\n            \"name\": \"Customer_16272\",\n            \"title\": \"Mr\",\n            \"registeredTime\": \"2022-09-15T14:26:24.0000003+0000\",\n            \"siteRegistered\": \"Test_site_2\",\n            \"localeRegistered\": \"en_GB\",\n            \"isGuest\": false,\n            \"marketingOptinStatus\": {\n              \"email\": {\n                \"updatedTimestamp\": \"2022-09-15T14:26:24.0000003+0000\",\n                \"receiveMarketing\": false\n              },\n              \"sms\": null\n            },\n            \"metadata\": {\n              \"gender\": \"Male\",\n              \"rewardCardNumber\": \"123456\",\n              \"dateOfBirth\": \"01/01/1970\"\n            },\n            \"address\": [\n              {\n                \"addressId\": 999,\n                \"addressUuid\": \"941E5B3F-C4F6-4F0C-BAE0-0000D00D0E0E\",\n                \"companyName\": \"THG\",\n                \"defaultAddressFlags\": [\"DEFAULT_BILLING\"],\n                \"houseNameNumber\": null,\n                \"streetName\": null,\n                \"addressLine2\": \"119\",\n                \"addressLine3\": \"Portswood Road\",\n                \"addressLine4\": \"Southampton\",\n                \"postCode\": \"SO17 3NU\",\n                \"countryCode\": \"GB\"\n              }\n            ],\n            \"emailAddress\": \"David@thehutgroup.com\",\n            \"emailVerified\": \"2022-09-15T15:26:24.0000003+0000\",\n            \"mobileNumber\": null,\n            \"referralCode\": \"ALASTAIR-RM\",\n            \"numberOfReferrals\": 6,\n            \"userDisabledTime\": \"2022-09-15T14:26:24.0000003+0000\",\n            \"userDeletedTime\": \"2022-09-15T14:26:24.0000003+0000\"\n          }\n        },\n        {\n          \"object\": {\n            \"id\": 16272,\n            \"uuid\": \"441E5B3F-C4F6-4F0C-BAE0-1171D89D0E1E\",\n            \"name\": \"Customer_16272\",\n            \"title\": \"Mr\",\n            \"registeredTime\": \"2022-09-15T14:26:24.0000003+0000\",\n            \"siteRegistered\": \"Test_site_2\",\n            \"localeRegistered\": \"en_GB\",\n            \"isGuest\": false,\n            \"marketingOptinStatus\": {\n              \"email\": {\n                \"updatedTimestamp\": \"2022-09-15T14:26:24.0000003+0000\",\n                \"receiveMarketing\": false\n              },\n              \"sms\": null\n            },\n            \"metadata\": {\n              \"gender\": \"Male\",\n              \"dateOfBirth\": \"01/01/1970\"\n            },\n            \"address\": [\n              {\n                \"addressId\": 999,\n                \"addressUuid\": \"941E5B3F-C4F6-4F0C-BAE0-0000D00D0E0E\",\n                \"defaultAddressFlags\": [\"DEFAULT_BILLING\"],\n                \"companyName\": \"THG\",\n                \"houseNameNumber\": null,\n                \"streetName\": null,\n                \"addressLine2\": \"119\",\n                \"addressLine3\": \"Portswood Road\",\n                \"addressLine4\": \"Southampton\",\n                \"postCode\": \"SO17 3NU\",\n                \"countryCode\": \"GB\"\n              }\n            ],\n            \"emailAddress\": \"David@thehutgroup.com\",\n            \"emailVerified\": \"2022-09-15T15:26:24.0000003+0000\",\n            \"mobileNumber\": null,\n            \"referralCode\": \"ALASTAIR-RM\",\n            \"numberOfReferrals\": 6,\n            \"userDisabledTime\": \"2022-09-15T14:26:24.0000003+0000\",\n            \"userDeletedTime\": \"2022-09-15T14:26:24.0000003+0000\"\n          }\n        },\n        {\n          \"object\": {\n            \"id\": 16272,\n            \"uuid\": \"441E5B3F-C4F6-4F0C-BAE0-1171D89D0E1E\",\n            \"name\": \"Customer_16272\",\n            \"title\": \"Mr\",\n            \"registeredTime\": \"2022-09-15T14:26:24.0000003+0000\",\n            \"siteRegistered\": \"Test_site_2\",\n            \"localeRegistered\": \"en_GB\",\n            \"isGuest\": false,\n            \"marketingOptinStatus\": {\n              \"email\": {\n                \"updatedTimestamp\": \"2022-09-15T14:26:24.0000003+0000\",\n                \"receiveMarketing\": false\n              },\n              \"sms\": null\n            },\n            \"metadata\": {\n              \"rewardCardNumber\": \"123456\"\n            },\n            \"address\": [\n              {\n                \"addressId\": 999,\n                \"addressUuid\": \"941E5B3F-C4F6-4F0C-BAE0-0000D00D0E0E\",\n                \"defaultAddressFlags\": [\"DEFAULT_BILLING\"],\n                \"companyName\": \"THG\",\n                \"houseNameNumber\": null,\n                \"streetName\": null,\n                \"addressLine2\": \"119\",\n                \"addressLine3\": \"Portswood Road\",\n                \"addressLine4\": \"Southampton\",\n                \"postCode\": \"SO17 3NU\",\n                \"countryCode\": \"GB\"\n              }\n            ],\n            \"emailAddress\": \"David@thehutgroup.com\",\n            \"emailVerified\": \"2022-09-15T15:26:24.0000003+0000\",\n            \"mobileNumber\": null,\n            \"referralCode\": \"ALASTAIR-RM\",\n            \"numberOfReferrals\": 6,\n            \"userDisabledTime\": \"2022-09-15T14:26:24.0000003+0000\",\n            \"userDeletedTime\": \"2022-09-15T14:26:24.0000003+0000\"\n          }\n        }\n      ]\n    }\n  },\n  \"examples\": [\n    {\n      \"id\": \"evt_0df242a3-6ac2-4781-8449-cc94d0a941b0\",\n      \"object\": \"event\",\n      \"type\": \"customer.created\",\n      \"created\": \"2022-09-15T14:30:36.0000783+0000\",\n      \"data\": {\n        \"object\": {\n          \"id\": 16272,\n          \"uuid\": \"441E5B3F-C4F6-4F0C-BAE0-1171D89D0E1E\",\n          \"name\": \"Customer_16272\",\n          \"title\": \"Mr\",\n          \"registeredTime\": \"2022-09-15T14:26:24.0000003+0000\",\n          \"siteRegistered\": \"Test_site_2\",\n          \"localeRegistered\": \"en_GB\",\n          \"isGuest\": false,\n          \"marketingOptinStatus\": {\n            \"email\": {\n              \"updatedTimestamp\": \"2022-09-15T14:26:24.0000003+0000\",\n              \"receiveMarketing\": false\n            },\n            \"sms\": null\n          },\n          \"metadata\": {\n            \"gender\": \"Male\",\n            \"rewardCardNumber\": \"123456\",\n            \"dateOfBirth\": \"01/01/1970\"\n          },\n          \"address\": [{\n            \"addressId\": 999,\n            \"addressUuid\": \"941E5B3F-C4F6-4F0C-BAE0-0000D00D0E0E\",\n            \"defaultAddressFlags\": [\"DEFAULT_BILLING\"],\n            \"companyName\": \"THG\",\n            \"houseNameNumber\": null,\n            \"streetName\": null,\n            \"addressLine2\": \"119\",\n            \"addressLine3\": \"Portswood Road\",\n            \"addressLine4\": \"Southampton\",\n            \"postCode\": \"SO17 3NU\",\n            \"countryCode\": \"GB\"\n          }],\n          \"emailAddress\": \"David@thehutgroup.com\",\n          \"emailVerified\": \"2022-09-15T15:26:24.0000003+0000\",\n          \"mobileNumber\": null,\n          \"referralCode\": \"ALASTAIR-RM\",\n          \"numberOfReferrals\": 6,\n          \"userDisabledTime\": null,\n          \"userDeletedTime\": null\n        }\n      }\n    },\n    {\n      \"id\": \"evt_0df242a3-6ac2-4781-8449-cc94d0a941b0\",\n      \"object\": \"event\",\n      \"type\": \"customer.created\",\n      \"created\": \"2022-09-15T14:30:36.0000783+0000\",\n      \"data\": {\n        \"object\": {\n          \"id\": 16272,\n          \"uuid\": \"441E5B3F-C4F6-4F0C-BAE0-1171D89D0E1E\",\n          \"name\": \"Customer_16272\",\n          \"title\": \"Mr\",\n          \"registeredTime\": \"2022-09-15T14:26:24.0000003+0000\",\n          \"siteRegistered\": \"Test_site_2\",\n          \"localeRegistered\": \"en_GB\",\n          \"isGuest\": false,\n          \"marketingOptinStatus\": {\n            \"email\": {\n              \"updatedTimestamp\": \"2022-09-15T14:26:24.0000003+0000\",\n              \"receiveMarketing\": false\n            },\n            \"sms\": null\n          },\n          \"metadata\": {\n            \"gender\": \"Male\",\n            \"dateOfBirth\": \"01/01/1970\"\n          },\n          \"address\": [{\n            \"addressId\": 999,\n            \"addressUuid\": \"941E5B3F-C4F6-4F0C-BAE0-0000D00D0E0E\",\n            \"defaultAddressFlags\": [\"DEFAULT_BILLING\"],\n            \"companyName\": \"THG\",\n            \"houseNameNumber\": null,\n            \"streetName\": null,\n            \"addressLine2\": \"119\",\n            \"addressLine3\": \"Portswood Road\",\n            \"addressLine4\": \"Southampton\",\n            \"postCode\": \"SO17 3NU\",\n            \"countryCode\": \"GB\"\n          }],\n          \"emailAddress\": \"David@thehutgroup.com\",\n          \"emailVerified\": \"2022-09-15T15:26:24.0000003+0000\",\n          \"mobileNumber\": null,\n          \"referralCode\": \"ALASTAIR-RM\",\n          \"numberOfReferrals\": 6,\n          \"userDisabledTime\": null,\n          \"userDeletedTime\": null\n        }\n      }\n    },\n    {\n      \"id\": \"evt_0df242a3-6ac2-4781-8449-cc94d0a941b0\",\n      \"object\": \"event\",\n      \"type\": \"customer.created\",\n      \"created\": \"2022-09-15T14:30:36.0000783+0000\",\n      \"data\": {\n        \"object\": {\n          \"id\": 16272,\n          \"uuid\": \"441E5B3F-C4F6-4F0C-BAE0-1171D89D0E1E\",\n          \"name\": \"Customer_16272\",\n          \"title\": \"Mr\",\n          \"registeredTime\": \"2022-09-15T14:26:24.0000003+0000\",\n          \"siteRegistered\": \"Test_site_2\",\n          \"localeRegistered\": \"en_GB\",\n          \"isGuest\": false,\n          \"marketingOptinStatus\": {\n            \"email\": {\n              \"updatedTimestamp\": \"2022-09-15T14:26:24.0000003+0000\",\n              \"receiveMarketing\": false\n            },\n            \"sms\": null\n          },\n          \"metadata\": {\n            \"rewardCardNumber\": \"123456\"\n          },\n          \"address\": [{\n            \"addressId\": 999,\n            \"addressUuid\": \"941E5B3F-C4F6-4F0C-BAE0-0000D00D0E0E\",\n            \"defaultAddressFlags\": [\"DEFAULT_BILLING\"],\n            \"companyName\": \"THG\",\n            \"houseNameNumber\": null,\n            \"streetName\": null,\n            \"addressLine2\": \"119\",\n            \"addressLine3\": \"Portswood Road\",\n            \"addressLine4\": \"Southampton\",\n            \"postCode\": \"SO17 3NU\",\n            \"countryCode\": \"GB\"\n          }],\n          \"emailAddress\": \"David@thehutgroup.com\",\n          \"emailVerified\": null,\n          \"mobileNumber\": null,\n          \"referralCode\": \"ALASTAIR-RM\",\n          \"numberOfReferrals\": 6,\n          \"userDisabledTime\": null,\n          \"userDeletedTime\": null\n        }\n      }\n    }\n  ]\n}\n\n

\n","urlObject":{"path":["v1","customerCreated"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"33ddf33c-5b4f-4d20-96a3-9feb33361ceb"},{"name":"Customer Deleted ref: CUS.O.02","id":"4ce20a75-c8f3-4add-8ce7-312ccf7ed8a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"id\": \"evt_122145458edh3uhjw\",\n \"object\": \"event\",\n \"type\": \"customer.deleted\",\n \"created\": \"2022-09-15T14:30:36.0000783+0000\",\n \"data\": {\n \"object\": {\n \"id\": 12345678,\n \"uuid\": \"a22964c0-3574-41c4-bc58-f8634c9d33e9\",\n \"userDisabledTime\": \"2022-09-15T14:30:36.0000783+0000\",\n \"userDeletedTime\": \"2022-09-15T14:30:36.0000783+0000\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"/v1/customerDeleted","description":"

Response

StartFragment

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Response Code	Meaning
2xx	Tells us you have successfully received and/or processed the request.
400-403,405	This will not be retried.
429	Too many requests. Use this if you have a rate limit in place. This will signal to us to retry.
5xx	This will signal to us to retry.
All other response code	Anything not covered above will default to a retry policy until all retries are exshausted

JSON Schema

{\n  \"$schema\": \"https://json-schema.org/draft/2019-09/schema\",\n  \"$id\": \"http://example.com/example.json\",\n  \"type\": \"object\",\n  \"default\": {},\n  \"title\": \"Root Schema\",\n  \"required\": [\n    \"id\",\n    \"object\",\n    \"type\",\n    \"created\",\n    \"data\"\n  ],\n  \"properties\": {\n    \"id\": {\n      \"type\": \"string\",\n      \"default\": \"\",\n      \"title\": \"The id Schema\",\n      \"examples\": [\n        \"evt_122145458edh3uhjw\"\n      ]\n    },\n    \"object\": {\n      \"type\": \"string\",\n      \"default\": \"\",\n      \"title\": \"The object Schema\",\n      \"examples\": [\n        \"event\"\n      ]\n    },\n    \"type\": {\n      \"type\": \"string\",\n      \"default\": \"\",\n      \"title\": \"The type Schema\",\n      \"examples\": [\n        \"customer.deleted\"\n      ]\n    },\n    \"created\": {\n      \"type\": \"string\",\n      \"default\": \"\",\n      \"title\": \"The created Schema\",\n      \"examples\": [\n        \"2022-09-15T14:30:36.0000783+0000\"\n      ]\n    },\n    \"data\": {\n      \"type\": \"object\",\n      \"default\": {},\n      \"title\": \"The data Schema\",\n      \"required\": [\n        \"object\"\n      ],\n      \"properties\": {\n        \"object\": {\n          \"type\": \"object\",\n          \"default\": {},\n          \"title\": \"The object Schema\",\n          \"required\": [\n            \"id\",\n            \"uuid\",\n            \"userDisabledTime\"\n          ],\n          \"properties\": {\n            \"id\": {\n              \"type\": \"integer\",\n              \"default\": 0,\n              \"title\": \"The id Schema\",\n              \"examples\": [\n                12345678\n              ]\n            },\n            \"uuid\": {\n              \"type\": [\"string\"],\n              \"default\": \"\",\n              \"title\": \"The uuid Schema\",\n              \"examples\": [\n                \"a22964c0-3574-41c4-bc58-f8634c9d33e9\"\n              ]\n            },\n            \"userDisabledTime\": {\n              \"type\": [\"string\", \"null\"],\n              \"default\": null,\n              \"title\": \"The userDisabledTime Schema\",\n              \"examples\": [\n                \"2022-09-15T14:30:36.0000783+0000\"\n              ]\n            },\n            \"userDeletedTime\": {\n              \"type\": [\"string\", \"null\"],\n              \"default\": null,\n              \"title\": \"The userDeletedTime Schema\",\n              \"examples\": [\n                \"2022-09-15T14:30:36.0000783+0000\"\n              ]\n            }\n          },\n          \"examples\": [{\n            \"id\": 12345678,\n            \"uuid\": \"a22964c0-3574-41c4-bc58-f8634c9d33e9\",\n            \"userDisabledTime\": \"2022-09-15T14:30:36.0000783+0000\",\n            \"userDeletedTime\": \"2022-09-15T14:30:36.0000783+0000\"\n          }]\n        }\n      },\n      \"examples\": [{\n        \"object\": {\n          \"id\": 12345678,\n          \"uuid\": \"a22964c0-3574-41c4-bc58-f8634c9d33e9\",\n          \"userDisabledTime\": \"2022-09-15T14:30:36.0000783+0000\",\n          \"userDeletedTime\": \"2022-09-15T14:30:36.0000783+0000\"\n        }\n      }]\n    }\n  },\n  \"examples\": [\n    {\n      \"id\": \"evt_122145458edh3uhjw\",\n      \"object\": \"event\",\n      \"type\": \"customer.deleted\",\n      \"created\": \"2022-09-15T14:30:36.0000783+0000\",\n      \"data\": {\n        \"object\": {\n          \"id\": 12345678,\n          \"uuid\": \"a22964c0-3574-41c4-bc58-f8634c9d33e9\",\n          \"userDisabledTime\": \"2022-09-15T14:30:36.0000783+0000\",\n          \"userDeletedTime\": \"2022-09-15T14:30:36.0000783+0000\"\n        }\n      }\n    },\n    {\n      \"id\": \"evt_122145458edh3uhjw\",\n      \"object\": \"event\",\n      \"type\": \"customer.deleted\",\n      \"created\": \"2022-09-15T14:30:36.0000783+0000\",\n      \"data\": {\n        \"object\": {\n          \"id\": 12345678,\n          \"uuid\": \"a22964c0-3574-41c4-bc58-f8634c9d33e9\",\n          \"userDisabledTime\": \"2022-09-15T14:30:36.0000783+0000\"\n        }\n      }\n    }\n  ]\n}\n\n

\n","urlObject":{"path":["v1","customerDeleted"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"4ce20a75-c8f3-4add-8ce7-312ccf7ed8a8"}],"id":"7b1c3c6f-1682-4718-befd-001d937f3156","_postman_id":"7b1c3c6f-1682-4718-befd-001d937f3156","description":""}],"id":"d6d66985-af61-4363-80b3-81b75f40ffdd","_postman_id":"d6d66985-af61-4363-80b3-81b75f40ffdd","description":""},{"name":"Customer Lists","item":[{"name":"Ovewrite entries of a customer list ref: CL.I.01","id":"e7a13282-7ce4-4f65-a83e-ae4284ff5f51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\n \"identifierType\": \"EMAIL\",\n \"entries\": [\n \"email1@test.com\",\n \"email2@test.com\",\n \"email3@test.com\",\n \"email4@test.com\",\n \"email5@test.com\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v1/customer-list/{{customerListId}}","description":"

This endpoint will overwrite the specified entries to an already existent customer list

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Response Code	Meaning
200	Customer List has been updated
400	There was some validation errors, response body will include validation errors . *A list can only contain a maximum of 10,000 entries
404	The customer list you are trying to update doesn't exist
500	Any other server error

Valid values for identifierType: \"EMAIL, \"CUSTOMER_ID\"

\n","urlObject":{"path":["v1","customer-list","{{customerListId}}"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"e7a13282-7ce4-4f65-a83e-ae4284ff5f51"},{"name":"Append entries to a customer list ref: CL.I.02","id":"b7a3ca53-2436-4335-8ac0-49b10f43d4e5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PATCH","header":[],"body":{"mode":"raw","raw":"{\n \"identifierType\": \"EMAIL\",\n \"entries\": [\n \"email1@test.com\",\n \"email2@test.com\",\n \"email3@test.com\",\n \"email4@test.com\",\n \"email5@test.com\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v1/customer-list/{{customerListId}}","description":"

This endpoint will append the specified entries to an already existent customer list

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Response Code	Meaning
200	Customer List has been updated
400	There was some validation errors, response body will include validation errors . *A list can only contain a maximum of 10,000 entries
404	The customer list you are trying to update doesn't exist
500	Any other server error

Valid values for identifierType: \"EMAIL, \"CUSTOMER_ID\"

\n","urlObject":{"path":["v1","customer-list","{{customerListId}}"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"b7a3ca53-2436-4335-8ac0-49b10f43d4e5"},{"name":"Delete entries from a customer list ref: CL.I.03","id":"66d1506c-6593-4b85-bff2-8d21a5511b3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"body":{"mode":"raw","raw":"{\n \"identifierType\": \"EMAIL\",\n \"entries\": [\n \"email1@test.com\",\n \"email2@test.com\",\n \"email3@test.com\",\n \"email4@test.com\",\n \"email5@test.com\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v1/customer-list/{{customerListId}}","description":"

This endpoint will deleted the specified entries from an already existent customer list

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Response Code	Meaning
200	Entries from Customer List have been deleted
400	There was some validation errors, response body will include validation errors . *A list can only contain a maximum of 10,000 entries
404	The customer list you are trying to update doesn't exist
500	Any other server error

Valid values for identifierType: \"EMAIL, \"CUSTOMER_ID\"

\n","urlObject":{"path":["v1","customer-list","{{customerListId}}"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"66d1506c-6593-4b85-bff2-8d21a5511b3f"}],"id":"bbb2b857-018c-48ad-86d1-6dbad3670732","description":"

This API allows the creation and manipulation of customer lists, which can then be used to leverage several on-site capabilities (VIP pricing, restricted special offers, restricted list pages, etc.)

\n","_postman_id":"bbb2b857-018c-48ad-86d1-6dbad3670732"},{"name":"Delivered","item":[{"name":"Inbound","item":[{"name":"Courier Allocation ref: COU.I.01","id":"e055c6e2-8c2d-4355-ab3a-3c2bc30e66cc","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"deliveryAddress\": {\n \"address\": {\n \"name\": \"string\",\n \"companyName\": \"string\",\n \"houseNameNumber\": \"string\",\n \"streetName\": \"string\",\n \"line2\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\",\n \"emailAddress\": \"string\",\n \"phoneNumber\": \"string\"\n }\n },\n \"returnAddress\": {\n \"name\": \"string\",\n \"companyName\": \"string\",\n \"houseNameNumber\": \"string\",\n \"streetName\": \"string\",\n \"line2\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\",\n \"emailAddress\": \"string\",\n \"phoneNumber\": \"string\"\n },\n \"order\": {\n \"orderId\": \"string\",\n \"currencyCode\": \"string\",\n \"clientName\": \"string\",\n \"citizenID\": \"string\",\n \"replacement\": false\n },\n \"shipment\": {\n \"shipmentId\": \"string\",\n \"height\": 0,\n \"length\": 0,\n \"width\": 0,\n \"weight\": 0,\n \"currency\": \"string\",\n \"value\": 0.00,\n \"shippingCost\": 0.00,\n \"shippingTax\": null,\n \"incoTerms\": \"string\",\n \"contentDescription\": \"\",\n \"ssccBarcode\": \"string\",\n \"shipmentIndex\": \"string\",\n \"deliveryTypeIds\": [\n 0\n ],\n \"products\": [\n {\n \"productIdString\": \"string\",\n \"quantity\": 0,\n \"unitValue\": 0.00,\n \"unitUnDiscountedValueIncTax\": 0,\n \"unitTax\": 0,\n \"unitWeight\": 0,\n \"description\": \"string\",\n \"type\": \"string\",\n \"harmonisationCode\": null,\n \"hazardous\": false\n }\n ]\n },\n \"warehouse\": {\n \"id\": 0,\n \"address\": {\n \"name\": \"string\",\n \"companyName\": \"string\",\n \"houseNameNumber\": \"string\",\n \"streetName\": \"string\",\n \"line2\": \"string\",\n \"city\": \"string\",\n \"state\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\",\n \"emailAddress\": \"string\",\n \"phoneNumber\": \"string\"\n }\n },\n \"requestDateTime\": {\n \"localDateTime\": \"2023-05-24T08:09:29.128\"\n },\n \"fxRates\": {\n \"baseCurrency\": \"GBP\",\n \"fxRates\": {\n \"EUR\": 0.0,\n \"USD\": 0.0\n }\n },\n \"expectedDespatchDate\": \"2023-05-24\"\n}","options":{"raw":{"language":"json"}}},"url":"/v1/courier/allocate","description":"

To allocate a courier to a shipment some required configurations must exist within THG Courier platform so that the system can intelligently decide the courier to use based on the allocation details provided.

After a shipment is sent to a courier service for delivery the shipment must be marked as dispatched so that the system may trigger any other required step after the dispatch, depending on the courier service used for allocation. If a shipment will no longer be dispatched to a customer then the cancel endpoint can be used, so that, the courier used during allocation may be informed of this action.

Alongside courier allocation, the API also returns a base 64 encoded courier label which can be converted to PDF.

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
deliveryAddress	Object	Yes	Delivery Address (details below)
returnAddress	Object	No	Return Address (details below)
order	Object	Yes	Order Data (details below)
shipment	Object	Yes	Shipment Data (details below)
warehouse	Object	Yes	DC/Warehouse (details below)
requestDateTime	Object	Yes	Date of request for courier allocation. Expected format: yyyy-MM-dd'T'HH:mm:ss.SSS
fxRates	Object	No	Required if order currency is needed to convert into a different currency as mandated by courier.
expectedDespatchDate	Date	No	This is an optional field for an estimated value of when the shipment would need to be despatched by the warehouse. Expected format: yyyy-MM-dd

Address Details (Delivery Address, Returns Address etc)

(Please note if using DHL express, address details must be in english. i.e. address details must not contain non-english characters)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
name	String	Yes	Customer Name
companyName	String	No	Company Name
houseNameNumber	String	Yes	House Number
streetName	String	Yes	Street Name
line2	String	No	Address Line 2
city	String	Yes	City
state	String	No	County/state/province Mandatory for US, CA, and AU. Expected 2/3 letter state code e.g. \"AZ\".
countryCode	String	Yes	Two-character country code eg GB. ISO 3166-1 alpha-2 format
postCode	String	Yes	Delivery Postcode
emailAddress	String	Yes	Email address
phoneNumber	String	No	Contact number Required by some couriers on certain routes for customer communication

Shipment Details

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
shipmentId	String	Yes	Unique identifier. This should only be Alphanumeric and only contains allowed special characters (- , _, @, ., /, #, &, +)
height length width	Integer Integer Integer	No No No	Dimensions of the package to be shipped. Measured in millimetres
weight	Integer	Yes	Package weight in grams
currency	String	Yes	3 character ISO 4217 currency code
value	BigDecimal	Yes	The total value of the shipment. This is the total Basket Price, including unit Tax and exclusive of the Shipping charge.
shippingCost	BigDecimal	Yes	Shipping Cost including tax
shippingTax	BigDecimal	No
incoTerms	String	Yes	International Commercial Terms used for this shipment, eg. DDP, DDU
contentDescription	String	Yes	Summary for all the products in the shipment. Max length varies by courier
ssccBarcode	String	No	Barcode for B2B shipment
shipmentIndex	String	No	Index to the shipping label for B2B shipments
deliveryTypeIds	List(Integer)	Yes	This identifies the delivery type for this shipment e.g. Standard, Tracked, Next Day. These are created as per client requirements.
products	List of Product Objects	Yes	List of product objects. See Product Data for more details

Request Date Time

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
localDateTime	Date	Yes	Date of request for courier allocation. Expected format: yyyy-MM-dd'T'HH:mm:ss.SSS

Click and collect Details

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
serviceId	String	Yes for PUDO shipments	The unique identifier for shop given by courier
clickAndCollectLocationId	String	Yes for PUDO shipments	Unique identifier representing courier service (depends on country and chosen courier)

Product Details

Property	Type	Mandatory	Description
productId	Integer	Yes	Unique identifier
productIdString	String	No	Unique identifier for the product in case its alphanumeric. Replaces productId
quantity	Integer	Yes	Quantity of ordered items
unitValue	BigDecimal	Yes	Value of 1 item paid by customer
unitUnDiscountedValueIncTax	BigDecimal	No	Undiscounted Value including Tax
unitTax	BigDecimal	No	Tax per unit. This is only needed for UK to EU.
unitWeight	Integer	Yes	Weight per unit in grams
description	String	Yes
type	String	No	Type /Category of Item e.f Clothing, Nutrition etc required by customs declaration process
harmonisationCode	String	Yes for cross border deliveries	Hscode of an item which is required for customs declaration
battery	Boolean	DEPRECATED - Field not required	Required if you wish to ship Lithium Battery product
hazardous	Boolean	No	For Hazmat Items
dgUNId	String	No	UN identifier for the dangerous goods
url	String	No	URL of the product page on the website
countryOfOrigin	String	Yes for cross border deliveries
productVatRate	Integer	DEPRECATED - Field not required	Vat rate applicable for destination country for this item
typeGroup	String	No	Type of the product. ex - \"Health and Beauty\"
volume	BigDecimal	No	Product volume in millilitres. E.g \"100.00\"

Order Data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
orderId	String	Yes	Unique identifier for an order.This should only be Alphanumeric and only contains allowed special characters (- , _, @, ., /, #, &, +)
currencyCode	String	Yes	ISO 3 Char
clientName	String	No	Pre-agreed client name, some couriers use to print on lanel
citizenID	String	No	For asian commercial routes only
replacement	String	No	Shows if its replacement order

Warehouse Data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
address	Address Object	No	Sender Address See Address Data for details
id	Integer	Yes	Unique identifier for warehouse. Pre configured value based on client warehouses.

JSON Schema

{\n    \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n    \"type\": \"object\",\n    \"properties\": {\n        \"deliveryAddress\": {\n            \"type\": \"object\",\n            \"properties\": {\n                \"clickAndCollect\": {\n                    \"type\": \"object\",\n                    \"properties\": {\n                        \"clickAndCollectLocationId\": {\n                            \"type\": \"string\"\n                        },\n                        \"serviceId\": {\n                            \"type\": \"integer\"\n                        }\n                    },\n                    \"required\": [\n                        \"clickAndCollectLocationId\",\n                        \"serviceId\"\n                    ]\n                },\n                \"address\": {\n                    \"type\": \"object\",\n                    \"properties\": {\n                        \"name\": {\n                            \"type\": \"string\"\n                        },\n                        \"companyName\": {\n                            \"type\": \"string\"\n                        },\n                        \"houseNameNumber\": {\n                            \"type\": \"string\"\n                        },\n                        \"streetName\": {\n                            \"type\": \"string\"\n                        },\n                        \"line2\": {\n                            \"type\": \"string\"\n                        },\n                        \"city\": {\n                            \"type\": \"string\"\n                        },\n                        \"state\": {\n                            \"type\": \"string\"\n                        },\n                        \"postcode\": {\n                            \"type\": \"string\"\n                        },\n                        \"countryCode\": {\n                            \"type\": \"string\"\n                        },\n                        \"emailAddress\": {\n                            \"type\": \"string\"\n                        },\n                        \"phoneNumber\": {\n                            \"type\": \"string\"\n                        }\n                    },\n                    \"required\": [\n                        \"name\",\n                        \"houseNameNumber\",\n                        \"streetName\",\n                        \"city\",\n                        \"state\",\n                        \"postcode\",\n                        \"countryCode\",\n                        \"emailAddress\",\n                        \"phoneNumber\"\n                    ]\n                },\n                \"consigneeAddress\": {\n                    \"type\": \"object\",\n                    \"properties\": {\n                        \"name\": {\n                            \"type\": \"string\"\n                        },\n                        \"companyName\": {\n                            \"type\": \"string\"\n                        },\n                        \"houseNameNumber\": {\n                            \"type\": \"string\"\n                        },\n                        \"streetName\": {\n                            \"type\": \"string\"\n                        },\n                        \"line2\": {\n                            \"type\": \"string\"\n                        },\n                        \"city\": {\n                            \"type\": \"string\"\n                        },\n                        \"state\": {\n                            \"type\": \"string\"\n                        },\n                        \"postcode\": {\n                            \"type\": \"string\"\n                        },\n                        \"countryCode\": {\n                            \"type\": \"string\"\n                        },\n                        \"emailAddress\": {\n                            \"type\": \"string\"\n                        },\n                        \"phoneNumber\": {\n                            \"type\": \"string\"\n                        }\n                    },\n                    \"required\": [\n                        \"name\",\n                        \"houseNameNumber\",\n                        \"streetName\",\n                        \"city\",\n                        \"state\",\n                        \"postcode\",\n                        \"countryCode\",\n                        \"emailAddress\",\n                        \"phoneNumber\"\n                    ]\n                }\n            },\n            \"required\": [\n                \"clickAndCollect\",\n                \"address\",\n                \"consigneeAddress\"\n            ]\n        },\n        \"returnAddress\": {\n            \"type\": \"object\",\n            \"properties\": {\n                \"name\": {\n                    \"type\": \"string\"\n                },\n                \"companyName\": {\n                    \"type\": \"string\"\n                },\n                \"houseNameNumber\": {\n                    \"type\": \"string\"\n                },\n                \"streetName\": {\n                    \"type\": \"string\"\n                },\n                \"line2\": {\n                    \"type\": \"string\"\n                },\n                \"city\": {\n                    \"type\": \"string\"\n                },\n                \"state\": {\n                    \"type\": \"string\"\n                },\n                \"postcode\": {\n                    \"type\": \"string\"\n                },\n                \"countryCode\": {\n                    \"type\": \"string\"\n                },\n                \"emailAddress\": {\n                    \"type\": \"string\"\n                },\n                \"phoneNumber\": {\n                    \"type\": \"string\"\n                }\n            },\n            \"required\": [\n                \"name\",\n                \"houseNameNumber\",\n                \"streetName\",\n                \"city\",\n                \"state\",\n                \"postcode\",\n                \"countryCode\",\n                \"emailAddress\",\n                \"phoneNumber\"\n            ]\n        },\n        \"order\": {\n            \"type\": \"object\",\n            \"properties\": {\n                \"orderId\": {\n                    \"type\": \"string\"\n                },\n                \"currencyCode\": {\n                    \"type\": \"string\"\n                },\n                \"clientName\": {\n                    \"type\": \"string\"\n                },\n                \"citizenID\": {\n                    \"type\": \"string\"\n                },\n                \"replacement\": {\n                    \"type\": \"boolean\"\n                }\n            },\n            \"required\": [\n                \"orderId\",\n                \"currencyCode\"\n            ]\n        },\n        \"shipment\": {\n            \"type\": \"object\",\n            \"properties\": {\n                \"shipmentId\": {\n                    \"type\": \"string\"\n                },\n                \"height\": {\n                    \"type\": \"integer\"\n                },\n                \"length\": {\n                    \"type\": \"integer\"\n                },\n                \"width\": {\n                    \"type\": \"integer\"\n                },\n                \"weight\": {\n                    \"type\": \"integer\"\n                },\n                \"currency\": {\n                    \"type\": \"string\"\n                },\n                \"value\": {\n                    \"type\": \"number\"\n                },\n                \"shippingCost\": {\n                    \"type\": \"number\"\n                },\n                \"shippingTax\": {\n                    \"type\": \"number\"\n                },\n                \"incoTerms\": {\n                    \"type\": \"string\"\n                },\n                \"contentDescription\": {\n                    \"type\": \"string\"\n                },\n                \"palletId\": {\n                    \"type\": \"string\"\n                },\n                \"deliveryTypeIds\": {\n                    \"type\": \"array\",\n                    \"items\": [\n                        {\n                            \"type\": \"integer\"\n                        }\n                    ]\n                },\n                \"products\": {\n                    \"type\": \"array\",\n                    \"items\": [\n                        {\n                            \"type\": \"object\",\n                            \"properties\": {\n                                \"productId\": {\n                                    \"type\": \"integer\"\n                                },\n                                \"productIdString\": {\n                                    \"type\": \"string\"\n                                },\n                                \"quantity\": {\n                                    \"type\": \"integer\"\n                                },\n                                \"unitValue\": {\n                                    \"type\": \"number\"\n                                },\n                                \"unitUnDiscountedValueIncTax\": {\n                                    \"type\": \"integer\"\n                                },\n                                \"unitTax\": {\n                                    \"type\": \"integer\"\n                                },\n                                \"unitWeight\": {\n                                    \"type\": \"integer\"\n                                },\n                                \"description\": {\n                                    \"type\": \"string\"\n                                },\n                                \"type\": {\n                                    \"type\": \"string\"\n                                },\n                                \"harmonisationCode\": {\n                                    \"type\": \"string\"\n                                },\n                                \"battery\": {\n                                    \"type\": \"boolean\"\n                                },\n                                \"hazardous\": {\n                                    \"type\": \"boolean\"\n                                },\n                                \"dgUNId\": {\n                                    \"type\": \"string\"\n                                },\n                                \"url\": {\n                                    \"type\": \"string\"\n                                },\n                                \"countryOfOrigin\": {\n                                    \"type\": \"string\"\n                                },\n                                \"productVatRate\": {\n                                    \"type\": \"number\"\n                                },\n                                \"volume\": {\n                                    \"type\": \"number\"\n                                }\n                            },\n                            \"required\": [\n                                \"productId\",\n                                \"quantity\",\n                                \"unitValue\",\n                                \"unitWeight\",\n                                \"description\",\n                                \"harmonisationCode\",\n                                \"countryOfOrigin\"\n                            ]\n                        }\n                    ]\n                }\n            },\n            \"required\": [\n                \"shipmentId\",\n                \"weight\",\n                \"currency\",\n                \"value\",\n                \"shippingCost\",\n                \"incoTerms\",\n                \"deliveryTypeIds\",\n                \"products\"\n            ]\n        },\n        \"warehouse\": {\n            \"type\": \"object\",\n            \"properties\": {\n                \"id\": {\n                    \"type\": \"integer\"\n                },\n                \"address\": {\n                    \"type\": \"object\",\n                    \"properties\": {\n                        \"name\": {\n                            \"type\": \"string\"\n                        },\n                        \"companyName\": {\n                            \"type\": \"string\"\n                        },\n                        \"houseNameNumber\": {\n                            \"type\": \"string\"\n                        },\n                        \"streetName\": {\n                            \"type\": \"string\"\n                        },\n                        \"line2\": {\n                            \"type\": \"string\"\n                        },\n                        \"city\": {\n                            \"type\": \"string\"\n                        },\n                        \"state\": {\n                            \"type\": \"string\"\n                        },\n                        \"postcode\": {\n                            \"type\": \"string\"\n                        },\n                        \"countryCode\": {\n                            \"type\": \"string\"\n                        },\n                        \"emailAddress\": {\n                            \"type\": \"string\"\n                        },\n                        \"phoneNumber\": {\n                            \"type\": \"string\"\n                        }\n                    },\n                    \"required\": [\n                        \"name\",\n                        \"houseNameNumber\",\n                        \"streetName\",\n                        \"city\",\n                        \"state\",\n                        \"postcode\",\n                        \"countryCode\",\n                        \"emailAddress\",\n                        \"phoneNumber\"\n                    ]\n                }\n            },\n            \"required\": [\n                \"id\",\n                \"address\"\n            ]\n        },\n        \"requestDateTime\": {\n            \"type\": \"object\",\n            \"properties\": {\n                \"localDateTime\": {\n                    \"type\": \"string\"\n                }\n            },\n            \"required\": [\n                \"localDateTime\"\n            ]\n        },\n        \"fxRates\": {\n            \"type\": \"object\",\n            \"properties\": {\n                \"baseCurrency\": {\n                    \"type\": \"string\"\n                },\n                \"fxRates\": {\n                    \"type\": \"object\",\n                    \"additionalProperties\": {\n                        \"type\": \"number\"\n                    }\n                }\n            },\n            \"required\": [\n                \"baseCurrency\"\n            ]\n        },\n        \"expectedDespatchDate\": {\n            \"type\": \"string\"\n        }\n    },\n    \"required\": [\n        \"deliveryAddress\",\n        \"order\",\n        \"shipment\",\n        \"warehouse\",\n        \"requestDateTime\",\n        \"expectedDespatchDate\"\n    ]\n}\n\n

Response

Courier Allocation Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
status	String	Yes	The status of the allocation request. \"SUCCESS\" or \"FAILURE\"
courierService	Object	Yes	Details of the courier and service
trackingDetails	Object	Yes	Tracking information for the shipment
label	Object	Yes	The shipping label content
labelBarcode	String	No	THG + 9-digit-padded-shipment-number + 00
sortCode	String	No	Sort code
requiredDispatchDate	String	No	Indicates to the warehouse system the exact date when the shipment needs to be dispatched
isPremiumDelivery	Boolean	No	Set to `true` if the shipment is allocated to premium services such as next-day or overnight delivery
failureMessages	Array of objects	No	Array of error messages if status is FAILURE, null otherwise

Courier Service

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
courierName	String	Yes	Name of the courier. Example: \"OSM\"
courierId	Integer	Yes	Unique identifier for the courier. Example: 124
serviceName	String	Yes	Name of the specific courier service. Example: \"OSM Global Priority Parcel\"
serviceId	Integer	Yes	Unique identifier for the service. Example: 442

Tracking Details

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
trackingNumber	String	Yes	Unique tracking number for the shipment
trackingUrl	String	Yes	Courier tracking url

Label

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
mediaType	String	Yes	Type of the shipping label. \"application/pdf\"
base64Label	String	Yes	Base64 encoded shipping label content

Failure Message

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
courierId	Integer	No	Unique identifier for the courier
serviceName	String	No	Name of the specific courier service
errorMessage	String	No	Description of the error

Response JSON schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"status\": {\n      \"type\": \"string\"\n    },\n    \"courierService\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"courierName\": {\n          \"type\": \"string\"\n        },\n        \"courierId\": {\n          \"type\": \"integer\"\n        },\n        \"serviceName\": {\n          \"type\": \"string\"\n        },\n        \"serviceId\": {\n          \"type\": \"integer\"\n        }\n      }\n    },\n    \"trackingDetails\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"trackingNumber\": {\n          \"type\": \"string\"\n        },\n        \"trackingUrl\": {\n          \"type\": \"string\"\n        }\n      }\n    },\n    \"label\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"mediaType\": {\n          \"type\": \"string\"\n        },\n        \"base64Label\": {\n          \"type\": \"string\"\n        }\n      }\n    },\n    \"labelBarcode\": {\n      \"type\": \"string\"\n    },\n    \"sortCode\": {\n      \"type\": \"string\"\n    },\n    \"requiredDispatchDate\": {\n      \"type\": \"string\",\n      \"format\": \"date\"\n    },\n    \"isPremiumDelivery\": {\n      \"type\": \"boolean\"\n    },\n    \"failureMessages\":{\n      \"type\": [\"array\", \"null\"],\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"courierId\": {\n            \"type\": \"integer\"\n          },\n          \"serviceName\": {\n            \"type\": \"string\"\n          },\n          \"errorMessage\": {\n            \"type\": \"string\"\n          }\n        }\n      }\n    }\n  }\n}\n\n

\n","urlObject":{"path":["v1","courier","allocate"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"a4e28ef9-4344-48cd-8c9f-a1d2afd3059f","name":"Courier Allocation (Success)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"deliveryAddress\": {\n \"address\": {\n \"name\": \"Joe Bloggs\",\n \"companyName\": \"THG\",\n \"houseNameNumber\": \"5th Floor Voyager House\",\n \"streetName\": \"Chicago Avenue\",\n \"line2\": \"\",\n \"city\": \"Manchester\",\n \"state\": \"\",\n \"postcode\": \"M90 3DQ\",\n \"countryCode\": \"GB\",\n \"emailAddress\": \"joe.bloggs@thehutgroup.com\",\n \"phoneNumber\": \"0712345678\"\n }\n },\n \"returnAddress\": {\n \"name\": \"THG - Returns\",\n \"companyName\": \"THG\",\n \"houseNameNumber\": \"Omega\",\n \"streetName\": \"Warehouse Way\",\n \"line2\": \"\",\n \"city\": \"Manchester\",\n \"state\": \"\",\n \"postcode\": \"M15 5QG\",\n \"countryCode\": \"GB\",\n \"emailAddress\": \"test@thg\",\n \"phoneNumber\": \"0123455678\"\n },\n \"order\": {\n \"orderId\": \"206569469\",\n \"currencyCode\": \"GBP\",\n \"clientName\": \"Imagination\",\n \"citizenID\": \"1.1\",\n \"replacement\": false\n },\n \"shipment\": {\n \"shipmentId\": \"306569471\",\n \"height\": 0,\n \"length\": 0,\n \"width\": 0,\n \"weight\": 100,\n \"currency\": \"GBP\",\n \"value\": 2.00,\n \"shippingCost\": 3.99,\n \"shippingTax\": null,\n \"incoTerms\": \"DAP\",\n \"contentDescription\": \"\",\n \"deliveryTypeIds\": [\n 66\n ],\n \"products\": [\n {\n \"productIdString\": \"S2706950_C101_ONE\",\n \"quantity\": 1,\n \"unitValue\": 2.00,\n \"unitUnDiscountedValueIncTax\": 0,\n \"unitTax\": 0,\n \"unitWeight\": 100,\n \"description\": \"SUPERVALUE TRAINER LINER BLACK\",\n \"type\": \"Clothing\",\n \"harmonisationCode\": null,\n \"hazardous\": false\n }\n ]\n },\n \"warehouse\": {\n \"id\": 181,\n \"address\": {\n \"name\": \"THG - Returns\",\n \"companyName\": \"THG\",\n \"houseNameNumber\": \"Omega\",\n \"streetName\": \"Warehouse Way\",\n \"line2\": \"\",\n \"city\": \"Manchester\",\n \"state\": \"\",\n \"postcode\": \"M15 5QG\",\n \"countryCode\": \"GB\",\n \"emailAddress\": \"test@thg\",\n \"phoneNumber\": \"0123455678\"\n }\n },\n \"requestDateTime\": {\n \"localDateTime\": \"2023-05-24T08:09:29.128\"\n },\n \"fxRates\": {\n \"baseCurrency\": \"GBP\",\n \"fxRates\": {\n \"EUR\": 1.2,\n \"USD\": 1.2\n }\n },\n \"expectedDespatchDate\": \"2023-05-24\"\n}","options":{"raw":{"language":"json"}}},"url":"/v1/courier/allocate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\",\n \"courierService\": {\n \"courierName\": \"OSM\",\n \"courierId\": 124,\n \"serviceName\": \"OSM Global Priority Parcel\",\n \"serviceId\": 442\n },\n \"trackingDetails\": {\n \"trackingNumber\": \"104201220225GB00000005\",\n \"trackingUrl\": \"https://www.osmworldwide.com/tracking/?trackingNumbers=104201220225GB00000005\"\n },\n \"label\": {\n \"mediaType\": \"application/pdf\",\n \"base64Label\": \"...\"\n },\n \"labelBarcode\": \"THG123456789\",\n \"sortCode\": \"MAN01\",\n \"requiredDispatchDate\": \"2024-01-28\",\n \"isPremiumDelivery\": false,\n \"failureMessages\": null\n}"},{"id":"62a86361-22b4-4899-b75f-a7a0701d85ed","name":"Courier Allocation (Failure)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"deliveryAddress\": {\n \"address\": {\n \"name\": \"Joe Bloggs\",\n \"companyName\": \"THG\",\n \"houseNameNumber\": \"5th Floor Voyager House\",\n \"streetName\": \"Chicago Avenue\",\n \"line2\": \"\",\n \"city\": \"Manchester\",\n \"state\": \"\",\n \"postcode\": \"M90 3DQ\",\n \"countryCode\": \"GB\",\n \"emailAddress\": \"joe.bloggs@thehutgroup.com\",\n \"phoneNumber\": \"0712345678\"\n }\n },\n \"returnAddress\": {\n \"name\": \"THG - Returns\",\n \"companyName\": \"THG\",\n \"houseNameNumber\": \"Omega\",\n \"streetName\": \"Warehouse Way\",\n \"line2\": \"\",\n \"city\": \"Manchester\",\n \"state\": \"\",\n \"postcode\": \"M15 5QG\",\n \"countryCode\": \"GB\",\n \"emailAddress\": \"test@thg\",\n \"phoneNumber\": \"0123455678\"\n },\n \"order\": {\n \"orderId\": \"206569469\",\n \"currencyCode\": \"GBP\",\n \"clientName\": \"Imagination\",\n \"citizenID\": \"1.1\",\n \"replacement\": false\n },\n \"shipment\": {\n \"shipmentId\": \"306569471\",\n \"height\": 0,\n \"length\": 0,\n \"width\": 0,\n \"weight\": 100,\n \"currency\": \"GBP\",\n \"value\": 2.00,\n \"shippingCost\": 3.99,\n \"shippingTax\": null,\n \"incoTerms\": \"DAP\",\n \"contentDescription\": \"\",\n \"deliveryTypeIds\": [\n 66\n ],\n \"products\": [\n {\n \"productIdString\": \"S2706950_C101_ONE\",\n \"quantity\": 1,\n \"unitValue\": 2.00,\n \"unitUnDiscountedValueIncTax\": 0,\n \"unitTax\": 0,\n \"unitWeight\": 100,\n \"description\": \"SUPERVALUE TRAINER LINER BLACK\",\n \"type\": \"Clothing\",\n \"harmonisationCode\": null,\n \"hazardous\": false\n }\n ]\n },\n \"warehouse\": {\n \"id\": 181,\n \"address\": {\n \"name\": \"THG - Returns\",\n \"companyName\": \"THG\",\n \"houseNameNumber\": \"Omega\",\n \"streetName\": \"Warehouse Way\",\n \"line2\": \"\",\n \"city\": \"Manchester\",\n \"state\": \"\",\n \"postcode\": \"M15 5QG\",\n \"countryCode\": \"GB\",\n \"emailAddress\": \"test@thg\",\n \"phoneNumber\": \"0123455678\"\n }\n },\n \"requestDateTime\": {\n \"localDateTime\": \"2023-05-24T08:09:29.128\"\n },\n \"fxRates\": {\n \"baseCurrency\": \"GBP\",\n \"fxRates\": {\n \"EUR\": 1.2,\n \"USD\": 1.2\n }\n },\n \"expectedDespatchDate\": \"2023-05-24\"\n}","options":{"raw":{"language":"json"}}},"url":"/v1/courier/allocate"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"FAILURE\",\n \"courierService\": null,\n \"trackingDetails\": null,\n \"label\": null,\n \"failureMessages\": [\n {\n \"courierId\": 123,\n \"serviceName\": \"Courier Service Name\",\n \"errorMessage\": \"Client error when requesting delivery for shipment.\"\n }\n ]\n}"}],"_postman_id":"e055c6e2-8c2d-4355-ab3a-3c2bc30e66cc"},{"name":"Courier Dispatch ref: COU.I.02","id":"8f025b59-ea22-4a40-95f1-42adcafd8503","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"deliveryAddress\": {\n \"address\": {\n \"name\": \"Joe Bloggs\",\n \"companyName\": \"THG\",\n \"houseNameNumber\": \"The Stables\",\n \"streetName\": \"Manchester Way\",\n \"line2\": \"\",\n \"city\": \"Manchester\",\n \"state\": \"Greater Manchester\",\n \"postcode\": \"M15 4QG\",\n \"countryCode\": \"GB\",\n \"emailAddress\": \"zakona@thehutgroup.com\",\n \"phoneNumber\": \"+447492757572\"\n }\n },\n \"returnAddress\": {\n \"name\": \"Returns Warehouse\",\n \"companyName\": \"THG\",\n \"houseNameNumber\": \"Omega\",\n \"streetName\": \"Warehouse Way\",\n \"line2\": \"\",\n \"city\": \"Manchester\",\n \"state\": \"Greater Manchester\",\n \"postcode\": \"M15 5QG\",\n \"countryCode\": \"GB\",\n \"emailAddress\": \"zakona@thehutgroup.com\",\n \"phoneNumber\": \"447492757572\"\n },\n \"order\": {\n \"orderId\": \"orderId22\",\n \"currencyCode\": \"GBP\",\n \"clientName\": \"Imagination\"\n },\n \"shipment\": {\n \"shipmentId\": 5,\n \"height\": 10,\n \"length\": 10,\n \"width\": 10,\n \"weight\": 10,\n \"currency\": \"GBP\",\n \"value\": 5,\n \"shippingCost\": 2.5,\n \"shippingTax\": 5.2,\n \"incoTerms\": \"DDU\",\n \"contentDescription\": \"description\",\n \"deliveryTypeIds\": [\n 2\n ],\n \"products\": [\n {\n \"productId\": 11353517,\n \"quantity\": 1,\n \"unitValue\": 5,\n \"unitTax\": 5,\n \"unitWeight\": 5,\n \"countryOfOrigin\": \"GB\",\n \"description\": \"description\",\n \"type\": \"beauty\",\n \"typeGroup\": \"lifestyle\",\n \"harmonisationCode\": \"12345\",\n \"hazardous\": true,\n \"url\": \"product/url\"\n }\n ]\n },\n \"warehouse\": {\n \"address\": {\n \"name\": \"Warehouse\",\n \"companyName\": \"THG\",\n \"houseNameNumber\": \"Omega\",\n \"streetName\": \"Warehouse Way\",\n \"line2\": \"\",\n \"city\": \"Manchester\",\n \"state\": \"Greater Manchester\",\n \"postcode\": \"M15 5QG\",\n \"countryCode\": \"GB\",\n \"emailAddress\": \"test@thg\",\n \"phoneNumber\": \"0123455678\"\n },\n \"id\": 31\n }\n}","options":{"raw":{"language":"json"}}},"url":"/v1/shipment/dispatch","description":"

When a shipment is physically dispatched, THG needs to be notified about the shipment being dispatched. This endpoint will provide a way to notify THG to update the state of the shipment and to propagate the information internally.

More specifically, this dispatches the shipment via courier and activates its tracking.

Note: After a shipment is marked as dispatched it can no longer be cancelled.

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
dispatchDetails	DispatchDetails Object	No	This is an optional field to get trailer id. Currently only for Direct Link courier.
deliveryAddress	DeliveryAddress Object	No	Delivery Address Details. See Delivery Address Data below.
returnAddress	Address Object	No	Return Address Details. See Address Data below.
initialiseTracking	Boolean	No	Should tracking be initialised with THG Tracking Platform (Not Parcellab). This is True by default .
order	Order Object	Yes	Order Details. See Order Data below.
shipment	Shipment Object	Yes	Shipment Details. See Shipment Data below.
warehouse	Warehouse Object	Yes	Warehouse Details. See Warehouse Data below.

Shipment Details

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
shipmentId	String	Yes	Unique identifier.This should only be Alphanumeric and only contains allowed special characters (- , _, @, ., /, #, &, +)
height length width	Integer Integer Integer	No No No	Dimensions of the package to be shipped
weight	Integer	Yes	Total weight in grams
currency	String	No	3 character ISO 4217 currency code
value	BigDecimal	Yes	The total value of the shipment. This is the total Basket Price, including unit Tax and exclusive of the Shipping charge.
shippingCost	BigDecimal	Yes	Shipping Cost including tax
shippingTax	BigDecimal	Yes
incoTerms	String	Yes	International Commercial Terms used for this shipment, eg. DDP, DDU
contentDescription	Long	Yes	Summary for all the products in the shipment
palletId	String	No	Required by certain couriers. This is a unique container identification barcode provided by the warehouse at the time of despatch.
deliveryTypeIds	List(Integer)	Yes	This identifies the delivery type for this shipment e.g. Standard, Tracked, Next Dat. These are created as per client requirements.
products	List of Product Objects	Yes	List of product objects. See Product Data for more details

Product Data

Property	Type	Mandatory	Description
productId	Integer	Yes	Unique identifier
productIdString	String	No	Unique identifier for the product in case its alphanumeric.Replaces productId
quantity	String	Yes	Quantity of ordered items
unitValue	String	Yes	Value of 1 item paid by customer
unitUnDiscountedValueIncTax	String	No	Undiscounted Value including Tax
unitTax	String	No	Tax per unit
unitWeight	String	Yes	Weight per unit
description	String	Yes
type	String	No	Type /Category of Item e.f Clothing, Nutrition etc required by customs declaration process
harmonisationCode	String	Yes for cross border deliveries	Hscode of an item which is required for customs declaration
battery	Boolean	DEPRECATED - Field not required	Required if you wish to ship Lithium Battery product
hazardous	Boolean	No	For Hazmat Items
dgUNId	String	No	UN identifier for the dangerous goods
url	String	No	URL of the product page on the website
countryOfOrigin	String	Yes for cross border deliveries
productVatRate	Integer	DEPRECATED - Field not required	Vat rate applicable for destination country for this item
typeGroup	String	No	Type of the product . ex - \"Health and Beauty\"
volume	BigDecimal	No	Product volume in millilitres E.g \"100.00\"

Address Details (Delivery Address, Returns Address etc)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
name	String	Yes	Customer Name
companyName	String	No	Company Name
houseNameNumber	String	Yes	House Number
streetName	String	Yes	Street Name
line2	String	No	Address Line 2
city	String	Yes	City
state	String	No	County/state/province Mandatory for US and AU
countryCode	String	Yes	Two-character country code eg GB
postCode	String	Yes	Delivery Postcode
emailAddress	String	Yes	Email Id
phoneNumber	String	Yes	Contact number

Order Data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
orderId	String	Yes	Unique identifier for an order.This should only be Alphanumeric and only contains allowed special characters (- , _, @, ., /, #, &, +)
currencyCode	String	Yes	ISO 3 Char
clientName	String	No	Pre-agreed client name, some couriers use to print on lanel
citizenID	String	No	For asian commercial routes only
replacement	Boolean	No	Shows if its replacement order

Warehouse Data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
address	Address Object	No	Sender Address See Address Data for details
id	Integer	Yes	Unique identifier for warehouse. Pre configured value based on client warehouses.

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"shipmentNumber\": {\n      \"type\": \"string\"\n    },\n    \"orderId\": {\n      \"type\": \"string\"\n    },\n    \"orderCreatedDate\": {\n      \"type\": \"string\"\n    },\n    \"fulfilmentChannel\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"locationId\": {\n          \"type\": \"integer\"\n        },\n        \"locationName\": {\n          \"type\": \"string\"\n        }\n      },\n      \"required\": [\n        \"locationId\",\n        \"locationName\"\n      ]\n    },\n    \"address\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"name\": {\n          \"type\": \"string\"\n        },\n        \"companyName\": {\n          \"type\": \"string\"\n        },\n        \"houseNameNumber\": {\n          \"type\": \"string\"\n        },\n        \"streetName\": {\n          \"type\": \"string\"\n        },\n        \"line2\": {\n          \"type\": \"string\"\n        },\n        \"line3\": {\n          \"type\": \"string\"\n        },\n        \"line4\": {\n          \"type\": \"string\"\n        },\n        \"country\": {\n          \"type\": \"string\"\n        },\n        \"postCode\": {\n          \"type\": \"string\"\n        },\n        \"emailId\": {\n          \"type\": \"string\"\n        },\n        \"mobileNumber\": {\n          \"type\": \"string\"\n        }\n      },\n      \"required\": [\n        \"name\",\n        \"houseNameNumber\",\n        \"streetName\",\n        \"line3\",\n        \"country\",\n        \"postCode\",\n        \"emailId\",\n        \"mobileNumber\"\n      ]\n    },\n    \"shipmentLines\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"skuId\": {\n              \"type\": \"string\"\n            },\n            \"barcode\": {\n              \"type\": \"string\"\n            },\n            \"barcodes\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"EAN\": {\n                  \"type\": \"array\",\n                  \"items\": [\n                    {\n                      \"type\": \"string\"\n                    }\n                  ]\n                },\n                \"UPC\": {\n                  \"type\": \"array\",\n                  \"items\": [\n                    {\n                      \"type\": \"string\"\n                    }\n                  ]\n                }\n              },\n              \"anyOf\" : [\n                {\"required\": [\n                \"EAN\",\n              ]},\n                {\"required\": [\n                \"UPC\"\n              ]}\n              ]\n            },\n            \"quantity\": {\n              \"type\": \"integer\"\n            },\n            \"expectedDispatchDate\": {\n              \"type\": \"string\"\n            },\n            \"totalAmount\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"currency\": {\n                  \"type\": \"string\"\n                },\n                \"value\": {\n                  \"type\": \"number\"\n                },\n                \"vat\": {\n                  \"type\": \"number\"\n                }\n              },\n              \"required\": [\n                \"currency\",\n                \"value\"\n              ]\n            },\n            \"productPricePerUnit\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"currency\": {\n                  \"type\": \"string\"\n                },\n                \"value\": {\n                  \"type\": \"number\"\n                }\n              },\n              \"required\": [\n                \"currency\",\n                \"value\"\n              ]\n            },\n            \"shipmentLineId\": {\n              \"type\": \"integer\"\n            }\n          },\n          \"required\": [\n            \"barcode\",\n            \"quantity\",\n            \"expectedDispatchDate\",\n            \"totalAmount\",\n            \"productPricePerUnit\",\n            \"shipmentLineId\"\n          ]\n        }\n      ]\n    },\n    \"deliveryType\": {\n      \"type\": \"string\"\n    },    \n    \"shipmentType\": {\n      \"type\": \"string\"\n    },\n    \"shippingCost\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"currency\": {\n          \"type\": \"string\"\n        },\n        \"value\": {\n          \"type\": \"number\"\n        }\n      },\n      \"required\": [\n        \"currency\",\n        \"value\"\n      ]\n    },\n    \"labelBarcode\": {\n      \"type\": \"string\"\n    },\n    \"trackingNumber\": {\n      \"type\": \"string\"\n    },\n    \"trackingUrl\": {\n      \"type\": \"string\"\n    },\n    \"site\": {\n      \"type\": \"string\"\n    }\n  },\n  \"required\": [\n    \"shipmentNumber\",\n    \"orderId\",\n    \"orderCreatedDate\",\n    \"fulfilmentChannel\",\n    \"address\",\n    \"shipmentLines\",\n    \"shipmentType\",\n    \"shippingCost\",\n    \"site\",\n    \"locale\"\n  ]\n}\n\n

\n","urlObject":{"path":["v1","shipment","dispatch"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"aa713e5b-4e77-4575-91b2-b0e010ec934a","name":"Courier Dispatch (Success)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"deliveryAddress\": {\n \"address\": {\n \"name\": \"Joe Bloggs\",\n \"companyName\": \"THG\",\n \"houseNameNumber\": \"The Stables\",\n \"streetName\": \"Manchester Way\",\n \"line2\": \"\",\n \"city\": \"Manchester\",\n \"state\": \"Greater Manchester\",\n \"postcode\": \"M15 4QG\",\n \"countryCode\": \"GB\",\n \"emailAddress\": \"zakona@thehutgroup.com\",\n \"phoneNumber\": \"+447492757572\"\n }\n },\n \"returnAddress\": {\n \"name\": \"Returns Warehouse\",\n \"companyName\": \"THG\",\n \"houseNameNumber\": \"Omega\",\n \"streetName\": \"Warehouse Way\",\n \"line2\": \"\",\n \"city\": \"Manchester\",\n \"state\": \"Greater Manchester\",\n \"postcode\": \"M15 5QG\",\n \"countryCode\": \"GB\",\n \"emailAddress\": \"zakona1@thehutgroup.com\",\n \"phoneNumber\": \"447492757572\"\n },\n \"order\": {\n \"orderId\": \"orderId22\",\n \"currencyCode\": \"GBP\",\n \"clientName\": \"Imagination\"\n },\n \"shipment\": {\n \"shipmentId\": 5,\n \"height\": 10,\n \"length\": 10,\n \"width\": 10,\n \"weight\": 10,\n \"currency\": \"GBP\",\n \"value\": 5,\n \"shippingCost\": 2.5,\n \"shippingTax\": 5.2,\n \"incoTerms\": \"DDU\",\n \"contentDescription\": \"description\",\n \"deliveryTypeIds\": [\n 2\n ],\n \"products\": [\n {\n \"productId\": 11353517,\n \"quantity\": 1,\n \"unitValue\": 5,\n \"unitTax\": 5,\n \"unitWeight\": 5,\n \"countryOfOrigin\": \"GB\",\n \"description\": \"description\",\n \"type\": \"beauty\",\n \"typeGroup\": \"lifestyle\",\n \"harmonisationCode\": \"12345\",\n \"hazardous\": true,\n \"url\": \"product/url\"\n }\n ]\n },\n \"warehouse\": {\n \"address\": {\n \"name\": \"Warehouse\",\n \"companyName\": \"THG\",\n \"houseNameNumber\": \"Omega\",\n \"streetName\": \"Warehouse Way\",\n \"line2\": \"\",\n \"city\": \"Manchester\",\n \"state\": \"Greater Manchester\",\n \"postcode\": \"M15 5QG\",\n \"countryCode\": \"GB\",\n \"emailAddress\": \"test@thg\",\n \"phoneNumber\": \"0123455678\"\n },\n \"id\": 31\n }\n}","options":{"raw":{"language":"json"}}},"url":"/v1/shipment/dispatch"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{}"},{"id":"65191489-2ed9-41e5-b757-6cceb3b7c0d4","name":"Courier Dispatch (Failure)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"deliveryAddress\": {\n \"address\": {\n \"name\": \"Joe Bloggs\",\n \"companyName\": \"THG\",\n \"houseNameNumber\": \"The Stables\",\n \"streetName\": \"Manchester Way\",\n \"line2\": \"\",\n \"city\": \"Manchester\",\n \"state\": \"Greater Manchester\",\n \"postcode\": \"M15 4QG\",\n \"countryCode\": \"GB\",\n \"emailAddress\": \"zakona@thehutgroup.com\",\n \"phoneNumber\": \"+447492757572\"\n }\n },\n \"returnAddress\": {\n \"name\": \"Returns Warehouse\",\n \"companyName\": \"THG\",\n \"houseNameNumber\": \"Omega\",\n \"streetName\": \"Warehouse Way\",\n \"line2\": \"\",\n \"city\": \"Manchester\",\n \"state\": \"Greater Manchester\",\n \"postcode\": \"M15 5QG\",\n \"countryCode\": \"GB\",\n \"emailAddress\": \"zakona@thehutgroup.com\",\n \"phoneNumber\": \"447492757572\"\n },\n \"order\": {\n \"orderId\": \"orderId22\",\n \"currencyCode\": \"GBP\",\n \"clientName\": \"Imagination\"\n },\n \"shipment\": {\n \"shipmentId\": 5,\n \"height\": 10,\n \"length\": 10,\n \"width\": 10,\n \"weight\": 10,\n \"currency\": \"GBP\",\n \"value\": 5,\n \"shippingCost\": 2.5,\n \"shippingTax\": 5.2,\n \"incoTerms\": \"DDU\",\n \"contentDescription\": \"description\",\n \"deliveryTypeIds\": [\n 2\n ],\n \"products\": [\n {\n \"productId\": 11353517,\n \"quantity\": 1,\n \"unitValue\": 5,\n \"unitTax\": 5,\n \"unitWeight\": 5,\n \"countryOfOrigin\": \"GB\",\n \"description\": \"description\",\n \"type\": \"beauty\",\n \"typeGroup\": \"lifestyle\",\n \"harmonisationCode\": \"12345\",\n \"hazardous\": true,\n \"url\": \"product/url\"\n }\n ]\n },\n \"warehouse\": {\n \"address\": {\n \"name\": \"Warehouse\",\n \"companyName\": \"THG\",\n \"houseNameNumber\": \"Omega\",\n \"streetName\": \"Warehouse Way\",\n \"line2\": \"\",\n \"city\": \"Manchester\",\n \"state\": \"Greater Manchester\",\n \"postcode\": \"M15 5QG\",\n \"countryCode\": \"GB\",\n \"emailAddress\": \"test@thg\",\n \"phoneNumber\": \"0123455678\"\n },\n \"id\": 31\n }\n}","options":{"raw":{"language":"json"}}},"url":"/v1/shipment/dispatch"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"apierror\": {\n \"status\": \"BAD_REQUEST\",\n \"timestamp\": \"25-02-2022 10:41:49\",\n \"message\": \"Shipment already dispatched or cancelled\"\n }\n}"}],"_postman_id":"8f025b59-ea22-4a40-95f1-42adcafd8503"},{"name":"Courier Cancellation ref: COU.I.03","id":"12b82a96-bd86-43d5-8f8b-c57a8e365f6b","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"shipmentNumber\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"/v1/shipment/cancel","description":"

Capability to cancel a shipment that has already been allocated to a courier. THG may also forward the cancellation notification to the courier depending on the courier use and if the courier has the capability to accept a cancellation request.

Furthermore, a shipment cannot be cancelled if the current state of the shipment is ‘cancelled’ or ‘dispatched.

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"shipmentNumber\": {\n      \"type\": \"string\"\n    }\n  },\n  \"required\": [\n    \"shipmentNumber\"\n  ]\n}\n\n

\n","urlObject":{"path":["v1","shipment","cancel"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"b0629f9c-3f74-40ea-81dc-d149291da38c","name":"Courier Cancellation (Success)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"shipmentNumber\": \"40102030405\"\n}","options":{"raw":{"language":"json"}}},"url":"/v1/shipment/cancel"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"f3fc24d2-0ae8-4b1f-991b-086cc33cdafb","name":"Courier Cancellation (Failure - 400)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"shipmentNumber\": \"40102030405\"\n}","options":{"raw":{"language":"json"}}},"url":"/v1/shipment/cancel"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"apierror\": {\n \"status\": \"BAD_REQUEST\",\n \"timestamp\": \"25-02-2022 10:41:49\",\n \"message\": \"Shipment already cancelled or dispatched \"\n }\n}"},{"id":"2f638829-ee82-40e4-a564-29d2c2247a4c","name":"Courier Cancellation (Failure - 401)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"shipmentNumber\": \"40102030405\"\n}","options":{"raw":{"language":"json"}}},"url":"/v1/shipment/cancel"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"apierror\": {\n \"status\": \"UNAUTHORIZED\",\n \"timestamp\": \"17-02-2022 01:15:25\",\n \"message\": \"Invalid account details\"\n }\n}"},{"id":"e30532ce-0ef4-4187-bd3b-d00a608cdebe","name":"Courier Cancellation (Failure - 500)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"shipmentNumber\": \"40102030405\"\n}","options":{"raw":{"language":"json"}}},"url":"/v1/shipment/cancel"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"apierror\": {\n \"status\": \"INTERNAL_SERVER_ERROR\",\n \"timestamp\": \"17-02-2022 01:15:25\",\n \"message\": \"Something unexpected happened\"\n }\n}"}],"_postman_id":"12b82a96-bd86-43d5-8f8b-c57a8e365f6b"},{"name":"Initialise Tracking ref: TRA.I.01","id":"f1313d4e-d3ee-45ad-b200-62f9cdf6e1ca","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"trackings\": [\n {\n \"orderNumber\": \"string\",\n \"shipmentNumber\": \"string\",\n \"trackingNumber\": \"string\",\n \"serviceId\": 0,\n \"warehouseId\": 0,\n \"expectedDeliveryDate\": \"string\",\n \"notifyCustomer\": false,\n \"trackingType\": \"DISPATCH || RETURN\",\n \"customerNotificationData\": {\n \"orderDate\": \"string\",\n \"orderLocale\": {\n \"language\": \"string\",\n \"script\": \"string\",\n \"country\": \"string\",\n \"variant\": \"string\",\n \"extensionKeys\": [\n \"string\"\n ],\n \"unicodeLocaleAttributes\": [\n \"string\"\n ],\n \"unicodeLocaleKeys\": [\n \"string\"\n ],\n \"iso3Language\": \"string\",\n \"iso3Country\": \"string\",\n \"displayLanguage\": \"string\",\n \"displayScript\": \"string\",\n \"displayCountry\": \"string\",\n \"displayVariant\": \"string\",\n \"displayName\": \"string\"\n },\n \"siteDomain\": \"string\",\n \"siteName\": \"string\",\n \"address\": {\n \"name\": \"string\",\n \"companyName\": \"string\",\n \"houseNameNumber\": \"string\",\n \"streetName\": \"string\",\n \"line2\": \"string\",\n \"line3\": \"string\",\n \"line4\": \"string\",\n \"postcode\": \"string\",\n \"countryCode\": \"string\",\n \"email\": \"string\",\n \"contactNumber\": \"string\"\n }\n },\n \"articles\": [\n {\n \"articleNo\": \"string\",\n \"articleName\": \"string\",\n \"articleImage\": \"string\",\n \"articleUrl\": \"string\",\n \"quantity\": 0\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/tracking/initialise","description":"

To commence tracking with THG Tracking Platform, and our integrated couriers, you can initialise tracking with customer notifications enabled or not, just select your serviceId to track with. Our system will fetch constant updates from the courier providers, tracking events, and map them to an internal THG status for simplification. If you do not provide a 'Shipment_Number' we will take the order reference, and store as the same. You do not need to provide 'trackingType' field, but if you wish to monitor returns verse dispatch tracking, for reporting benefits, this is supported.

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
orderNumber	String	Yes	Unique customer order reference identifier
shipmentNumber	String	No	Optional order level (if more than one shipment)
trackingNumber	String	Yes	Tracking reference provided by courier to track
serviceId	Integer	Yes	Service Ids unique to THG to identify courier service to track
warehouseId	Integer	No	Optional client warehouse Id for reporting options
expectedDeliveryDate	String	No	Latest expected delivery date. Formats accepted ('yyyy-MM-dd', 'yyyy-MM-dd HH:mm')
notifyCustomer	boolean	No	Send customer notification updates on new tracking events
trackingType	String (ENUM)	No	Tracking type, either DISPATCH or RETURN, if not provided assume to be outbound dispatch (WH → Customer)
customerNotificationData	List (Object CustomerNotificationData)	No	Must be provided if NotifyCustomer boolean option true. Contains critical customer details
articles	List (Object Articles)	Yes	Product Items in the order

CustomerNotificationData

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
orderDate	String	No	Original order date (format: yyyy-MM-dd HH:mm:ss)
orderLocale	Locale (Java ISO)	No	Locale of site, order was placed on, used for translation language in messages
siteDomain	String	No	Full website domain url
siteName	String	No	Site name of order
address	Object (Address)	No	Customer delivery address

Address

Note: At least one address line from CompanyName, HouseNameNumber, StreetName, AddressLine2, AddressLine3 must be provided.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
name	String	Yes	Customer contact name
companyName	String	No
houseNameNumber	String	No
streetname	String	No
line2	String	No
line3	String	No
line4	String	No
postcode	String	Yes
countrycode	String ( ISO 3166-1 alpha-2 format)	Yes
email	String	Yes
contactNumber	String	No

Articles

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
articleNo	String	Yes	Product SKU
articleName	String	Yes	Product Name
articleImage	String	Yes	Link to THG product image on public CDN
articleUrl	String	Yes	Link to product on site where ordered
quantity	Integer	Yes	Product quantity ordered

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"trackings\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"orderNumber\": {\n              \"type\": \"string\"\n            },\n            \"shipmentNumber\": {\n              \"type\": \"string\"\n            },\n            \"trackingNumber\": {\n              \"type\": \"string\"\n            },\n            \"serviceId\": {\n              \"type\": \"integer\"\n            },\n            \"warehouseId\": {\n              \"type\": \"integer\"\n            },\n            \"expectedDeliveryDate\": {\n              \"type\": \"string\"\n            },\n            \"trackingType\": {\n              \"type\": \"string\"\n            },\n            \"notifyCustomer\": {\n              \"type\": \"boolean\"\n            },\n            \"customerNotificationData\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"orderDate\": {\n                  \"type\": \"string\"\n                },\n                \"orderLocale\": {\n                  \"type\": \"string\"\n                },\n                \"siteDomain\": {\n                  \"type\": \"string\"\n                },\n                \"siteName\": {\n                  \"type\": \"string\"\n                },\n                \"address\": {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"name\": {\n                      \"type\": \"string\"\n                    },\n                    \"companyName\": {\n                      \"type\": \"string\"\n                    },\n                    \"houseNameNumber\": {\n                      \"type\": \"string\"\n                    },\n                    \"streetName\": {\n                      \"type\": \"string\"\n                    },\n                    \"line2\": {\n                      \"type\": \"string\"\n                    },\n                    \"line3\": {\n                      \"type\": \"string\"\n                    },\n                    \"line4\": {\n                      \"type\": \"string\"\n                    },\n                    \"postcode\": {\n                      \"type\": \"string\"\n                    },\n                    \"countryCode\": {\n                      \"type\": \"string\"\n                    },\n                    \"email\": {\n                      \"type\": \"string\"\n                    },\n                    \"contactNumber\": {\n                      \"type\": \"string\"\n                    }\n                  },\n                  \"required\": [\n                    \"name\",\n                    \"companyName\",\n                    \"houseNameNumber\",\n                    \"streetName\",\n                    \"line2\",\n                    \"line3\",\n                    \"line4\",\n                    \"postcode\",\n                    \"countryCode\",\n                    \"email\"\n                  ]\n                }\n              },\n              \"required\": [\n                \"orderDate\",\n                \"orderLocale\",\n                \"siteDomain\",\n                \"siteName\",\n                \"address\"\n              ]\n            },\n            \"products\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"sku\": {\n                      \"type\": \"string\"\n                    },\n                    \"productName\": {\n                      \"type\": \"string\"\n                    },\n                    \"imageURLToCDN\": {\n                      \"type\": \"string\"\n                    },\n                    \"siteLinkToProduct\": {\n                      \"type\": \"string\"\n                    },\n                    \"quantity\": {\n                      \"type\": \"integer\"\n                    }\n                  },\n                  \"required\": [\n                    \"sku\",\n                    \"productName\",\n                    \"imageURLToCDN\",\n                    \"siteLinkToProduct\",\n                    \"quantity\"\n                  ]\n                }\n              ],\n              \"additionalItems\": true\n            }\n          },\n          \"required\": [\n            \"orderNumber\",\n            \"trackingNumber\",\n            \"serviceId\"\n          ]\n        }\n      ],\n      \"additionalItems\": true\n    }\n  },\n  \"required\": [\n    \"trackings\"\n  ]\n}\n\n

\n","urlObject":{"path":["v2","tracking","initialise"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"d8f6afba-12c0-465a-bcc7-4b21891e4df2","name":"Initialise Tracking (Success)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"},{"key":"accountId","value":"20","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"trackings\": [\n {\n \"orderNumber\": \"ORDER123456\",\n \"trackingNumber\": \"TRACK12345\",\n \"serviceId\": 456\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/tracking/initialise"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\",\n \"message\": \"All records have been initialised successfully.\",\n \"response\": [\n {\n \"orderNumber\": \"ORDER123456\",\n \"trackingNumber\": \"TRACK12345\",\n \"serviceId\": 456,\n \"status\": \"SUCCESS_TRACKING_WITHOUT_CUSTOMER_NOTIFICATIONS\",\n \"message\": \"Successfully initialised new tracking record\",\n \"trackingType\": \"DISPATCH\",\n \"customerNotifications\": {\n \"requested\": false\n }\n }\n ]\n}"},{"id":"0c5f0e74-5344-4e35-be03-41bd4071b9d9","name":"Get Tracking (Failure - 400)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"},{"key":"accountId","value":"20","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"trackings\": [\n {\n \"orderNumber\": \"ORDER123456\",\n \"trackingNumber\": \"TRACK12345\",\n \"serviceId\": 456\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/tracking/initialise"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"apierror\": {\n \"status\": \"BAD_REQUEST\",\n \"timestamp\": \"17-02-2022 01:15:25\",\n \"message\": \"Your request is out of bounds. Min size is 1000, Max size is %d, but received 100000.\"\n }\n}"},{"id":"07379eff-3898-46b2-87a3-8c182725ab5b","name":"Initialise Tracking (Failure - 500)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"},{"key":"accountId","value":"20","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"trackings\": [\n {\n \"orderNumber\": \"ORDER123456\",\n \"trackingNumber\": \"TRACK12345\",\n \"serviceId\": 456\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/tracking/initialise"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"apierror\": {\n \"status\": \"INTERNAL_SERVER_ERROR\",\n \"timestamp\": \"17-02-2022 01:15:25\",\n \"message\": \"Something unexpected happened\"\n }\n}"}],"_postman_id":"f1313d4e-d3ee-45ad-b200-62f9cdf6e1ca"},{"name":"Get Tracking ref: TRA.I.02","id":"633ca295-dc4f-4685-a90d-3d33a5ad9b74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"shipments\": [\n {\n \"orderNumber\": \"string\",\n \"trackingNumber\": \"string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/tracking/retrieve","description":"

If you wish to receive updates on tracking initialised via THG Tracking Platform, use the tracking and order number provided in original initialisation request for a given shipment

\n","urlObject":{"path":["v2","tracking","retrieve"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"1d137feb-af98-4c94-ae5a-0e0c3aafd1ea","name":"Get Tracking (Success)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"},{"key":"accountId","value":"0","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"shipments\": [\n {\n \"orderNumber\": \"CAT1188\",\n \"trackingNumber\": \"DG10543000000\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/tracking/retrieve"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\",\n \"message\": \"All tracking records have been found.\",\n \"trackings\": [\n {\n \"trackingId\": 903,\n \"createdDate\": \"2022-01-26 11:31:02.807\",\n \"lastUpdateDate\": \"2022-01-26 11:31:02.807\",\n \"orderNumber\": \"CAT1188\",\n \"shipmentNumber\": \"16258751\",\n \"trackingNumber\": \"DG10543000000\",\n \"tracking\": true,\n \"delivered\": false,\n \"customerNotified\": true,\n \"trackingType\": \"DISPATCH\",\n \"courierService\": {\n \"id\": 436,\n \"courier\": \"ProCarrier\",\n \"service\": \"Pro Carrier Plus\"\n },\n \"events\": [\n {\n \"utcEventDate\": \"2022-01-26 11:31:02.807\",\n \"id\": \"140\",\n \"code\": \"DELIVERED\",\n \"description\": \"The shipment has been delivered\",\n \"eventMessage\": \"Delivered to recipient\"\n }\n ]\n }\n ]\n}"},{"id":"a6072395-9afa-418b-bf9c-d2ddf95af631","name":"Get Tracking Response Schema","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"},{"key":"accountId","value":"0","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"shipments\": [\n {\n \"orderNumber\": \"CAT1188\",\n \"trackingNumber\": \"DG10543000000\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/tracking/retrieve"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"required\": [\n \"message\",\n \"status\",\n \"trackings\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"status\": {\n \"type\": \"string\",\n \"description\": \"Request status: SUCCESS, BAD_REQUEST, INTERNAL_SYSTEM_ERROR\",\n \"enum\": [\n \"SUCCESS\",\n \"BAD_REQUEST\",\n \"INTERNAL_SYSTEM_ERROR\"\n ]\n },\n \"message\": {\n \"type\": \"string\",\n \"description\": \"THG detailed description of request success status\"\n },\n \"trackings\": {\n \"type\": \"array\",\n \"description\": \"List of trackings requested\",\n \"items\": {\n \"required\": [\n \"courierService\",\n \"createdDate\",\n \"customerNotified\",\n \"delivered\",\n \"events\",\n \"lastUpdateDate\",\n \"orderNumber\",\n \"shipmentNumber\",\n \"tracking\",\n \"trackingNumber\",\n \"trackingType\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"createdDate\": {\n \"type\": \"string\",\n \"description\": \"Tracking record created at datetime 'yyyy-MM-dd HH:mm:ss'\"\n },\n \"lastUpdateDate\": {\n \"type\": \"string\",\n \"description\": \"Last scan or event captured at datetime 'yyyy-MM-dd HH:mm:ss'\"\n },\n \"orderNumber\": {\n \"type\": \"string\",\n \"description\": \"The clients unique order identifier\"\n },\n \"shipmentNumber\": {\n \"type\": \"string\",\n \"description\": \"The clients optional shipment identifier\"\n },\n \"trackingNumber\": {\n \"type\": \"string\",\n \"description\": \"The clients tracking reference\"\n },\n \"tracking\": {\n \"type\": \"boolean\",\n \"description\": \"Is actively tracking the shipment? True if tracking\"\n },\n \"delivered\": {\n \"type\": \"boolean\",\n \"description\": \"Is tracking delivered? True if delivered\"\n },\n \"customerNotified\": {\n \"type\": \"boolean\",\n \"description\": \"Is the customer notified on tracking event updates? True if notified\"\n },\n \"trackingType\": {\n \"type\": \"string\",\n \"description\": \"Tracking DISPATCH or RETURN\",\n \"enum\": [\n \"DISPATCH\",\n \"RETURN\"\n ]\n },\n \"courierService\": {\n \"required\": [\n \"courier\",\n \"id\",\n \"service\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"id\": {\n \"type\": \"integer\",\n \"description\": \"THG courier service Id to track with\"\n },\n \"courier\": {\n \"type\": \"string\",\n \"description\": \"Courier name\"\n },\n \"service\": {\n \"type\": \"string\",\n \"description\": \"Service used\"\n }\n },\n \"description\": \"Courier and service details used for tracking\"\n },\n \"events\": {\n \"type\": \"array\",\n \"description\": \"List tracking events captured\",\n \"items\": {\n \"required\": [\n \"description\",\n \"eventMessage\",\n \"code\",\n \"id\",\n \"utcEventDate\"\n ],\n \"type\": \"object\",\n \"properties\": {\n \"utcEventDate\": {\n \"type\": \"string\",\n \"description\": \"UTC datetime string of tracking event\"\n },\n \"id\": {\n \"type\": \"integer\",\n \"description\": \"THG internal enum constraint for code and message\"\n },\n \"code\": {\n \"type\": \"string\",\n \"description\": \"THG internal short form code\"\n },\n \"eventMessage\": {\n \"type\": \"string\",\n \"description\": \"Courier event message description. As displayed on web portal\"\n },\n \"description\": {\n \"type\": \"string\",\n \"description\": \"THG internal event simple description\"\n }\n },\n \"description\": \"List tracking events captured\"\n }\n }\n },\n \"description\": \"List of trackings requested\"\n }\n }\n }\n}"},{"id":"e3f019f7-0159-4f9b-a8c9-2f55dec1b9fb","name":"Get Tracking (Failure - 400)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"},{"key":"accountId","value":"20","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"shipments\": [\n {\n \"orderNumber\": \"CAT1188\",\n \"trackingNumber\": \"DG10543000000\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/tracking/retrieve"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"apierror\": {\n \"status\": \"BAD_REQUEST\",\n \"timestamp\": \"17-02-2022 01:15:25\",\n \"message\": \"Your request is out of bounds. Min size is 1000, Max size is %d, but received 100000.\"\n }\n}"},{"id":"c7f19ffd-5b1e-44a3-bd27-d032589e2f34","name":"Get Tracking (Failure - 500)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"},{"key":"accountId","value":"20","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"shipments\": [\n {\n \"orderNumber\": \"CAT1188\",\n \"trackingNumber\": \"DG10543000000\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/tracking/retrieve"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"apierror\": {\n \"status\": \"INTERNAL_SERVER_ERROR\",\n \"timestamp\": \"17-02-2022 01:15:25\",\n \"message\": \"Something unexpected happened\"\n }\n}"}],"_postman_id":"633ca295-dc4f-4685-a90d-3d33a5ad9b74"},{"name":"Stop Tracking ref: TRA.I.03","id":"af99cd95-c52a-43b3-a6bd-df86839797e2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"shipments\": [\n {\n \"orderNumber\": \"string\",\n \"trackingNumber\": \"string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/tracking/stop","description":"

In the event you wish to override our natural tracking logic, you stop fetching a single, or multiple records. This maybe due to courier error, or system error, etc.

\n","urlObject":{"path":["v2","tracking","stop"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"ee331933-7a85-45b3-bf06-7fc6859dce36","name":"Stop Tracking (Success)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"},{"key":"accountId","value":"0","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"shipments\": [\n {\n \"orderNumber\": \"CAT1188\",\n \"trackingNumber\": \"DG10543000000\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/tracking/stop"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"SUCCESS\",\n \"message\": \"All records have been updated to stop tracking successfully.\",\n \"response\": [\n {\n \"trackingId\": 905,\n \"status\": \"SUCCESS_STOPPED_TRACKING_RECORD\",\n \"message\": \"Successfully stopped tracking record\"\n }\n ]\n}"},{"id":"942817d5-8cae-404e-93de-4a39ffd428bc","name":"Stop Tracking (Failure - 400)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"},{"key":"accountId","value":"20","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"shipments\": [\n {\n \"orderNumber\": \"CAT1188\",\n \"trackingNumber\": \"DG10543000000\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/tracking/stop"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"apierror\": {\n \"status\": \"BAD_REQUEST\",\n \"timestamp\": \"17-02-2022 01:15:25\",\n \"message\": \"Your request is out of bounds. Min size is 1000, Max size is %d, but received 100000.\"\n }\n}"},{"id":"ae5ad1c7-aad9-47c0-bc28-4cdbf2ad2c3a","name":"Get Tracking (Failure - 500)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"},{"key":"accountId","value":"20","type":"text","disabled":true}],"body":{"mode":"raw","raw":"{\n \"shipments\": [\n {\n \"orderNumber\": \"CAT1188\",\n \"trackingNumber\": \"DG10543000000\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/tracking/stop"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"apierror\": {\n \"status\": \"INTERNAL_SERVER_ERROR\",\n \"timestamp\": \"17-02-2022 01:15:25\",\n \"message\": \"Something unexpected happened\"\n }\n}"}],"_postman_id":"af99cd95-c52a-43b3-a6bd-df86839797e2"},{"name":"Get Click And Collect Locations ref: LOC.I.01","id":"94d5ffa3-5226-4ba6-b299-a3fa8daf3a41","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"destination\": {\n \"postcode\": \"String\",\n \"countryCode\": \"String\"\n },\n \"deliveryOrder\": {\n \"currencyCode\": \"String\",\n \"deliveryOrderProducts\": [\n {\n \"productId\": \"String\",\n \"warehouseIds\": [\n \"Integer\"\n ],\n \"quantity\": \"int\",\n \"weightInGram\": \"int\",\n \"price\": \"BigDecimal\",\n \"hazmat\": \"boolean\"\n }\n ]\n },\n \"fxRates\": {\n \"baseCurrency\": \"GBP\",\n \"fxRates\": {\n \"EUR\": 0.0,\n \"USD\": 0.0\n }\n },\n \"longitude\": \"double\",\n \"latitude\": \"double\",\n \"locality\": \"String\"\n}","options":{"raw":{"language":"json"}}},"url":"/v2/delivery/clickAndCollect/getLocations","description":"

This endpoint is used to fetch the click and collect locations from a courier based on the location and longitude and lattitude coordinates.

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
destination	Object	Yes	Destination details for the delivery.
deliveryOrder	Object	Yes	Details of the delivery order.
fxRates	Object	Yes	Exchange rates related data
longitude	Double	Yes	Longitude coordinate of the destination.
latitude	Double	Yes	Latitude coordinate of the destination.
locality	String	No	Locality or neighbourhood of the destination.

Destination Details

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
postcode	String	No	Postal code of the destination. Required for most countries except a few where there are no postcodes e.g. HK
countryCode	String	Yes	2 Char ISO Country code

DeliveryOrder Details

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
currencyCode	String	Yes	3 character ISO currency code pertaining to basket item prices
deliveryOrderProducts	List(DeliveryOrderProduct)	Yes	List of products in the delivery order.

DeliveryOrderProducts Details

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
productId	String	Yes	Unique identifier for the product.Product SKU
warehouseIds	List(Integer)	Yes	List of warehouse Ids where the product is in stock in the order of priority for fulfilment
quantity	Int	Yes	Quantity of the product ordered.
weightInGram	Int	Yes	Weight of the product in grams.
price	BigDecimal	Yes	Price of the product.Product unit price e.g. 35.00
hazmat	boolean	No	Indicates if the product is hazardous material.Defaults to false

Fx Rates Details

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
baseCurrency	String	Yes	Base currency code (e.g., \"GBP\").
fxRates	Map(String, BigDecimal)	No	Mapping of currency codes to their exchange rates relative to the base currency.

","urlObject":{"path":["v2","delivery","clickAndCollect","getLocations"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"b8ff71f6-ce0e-49ce-bf5c-427b51df3d21","name":"Get Click And Collect Locations (Success)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"destination\": {\n \"postcode\": \"cv31 3dw\",\n \"countryCode\": \"GB\"\n },\n \"deliveryOrder\": {\n \"currencyCode\": \"GBP\",\n \"deliveryOrderProducts\": [\n {\n \"productId\": \"10530986\",\n \"warehouseIds\": [\n 0,\n 31\n ],\n \"quantity\": 1,\n \"weightInGram\": 1000,\n \"price\": 40.45,\n \"hazmat\": false\n }\n ]\n },\n \"fxRates\": {\n \"baseCurrency\": \"GBP\",\n \"fxRates\": {\n \"FJD\": 2.8040962857,\n \"MXN\": 21.6335149697,\n \"TVD\": 1.8221895001,\n \"SCR\": 17.9165347784,\n \"CDF\": 2110.6207411016,\n \"GTQ\": 10.1132853368,\n \"BBD\": 2.6118664598,\n \"CLP\": 987.0094616224,\n \"UGX\": 4794.1106812318,\n \"HNL\": 31.8731231598,\n \"ZAR\": 23.227609537,\n \"TND\": 3.8884318189,\n \"STN\": 28.2982171783,\n \"CUC\": 1.2515068109,\n \"SLL\": 11323.1745466356,\n \"BSD\": 1.3059332299,\n \"SDG\": 62.2831926938,\n \"IQD\": 1638.5873623062,\n \"GMD\": 64.7122856991,\n \"CUP\": 34.6072305918,\n \"TWD\": 38.4578310551,\n \"RSD\": 136.3188087707,\n \"DOP\": 68.3195747137,\n \"KMF\": 566.5576443678,\n \"MYR\": 5.7815686392,\n \"FKP\": 1.0,\n \"XOF\": 755.4101924904,\n \"GEL\": 3.460634302,\n \"UYU\": 48.4626555406,\n \"MAD\": 12.6986591804,\n \"CVE\": 126.9886317638,\n \"TOP\": 3.0510964851,\n \"OMR\": 0.4818220141,\n \"AZN\": 2.1295701121,\n \"PGK\": 4.395433973,\n \"SEK\": 13.5390275584,\n \"KES\": 174.5793819601,\n \"CNH\": 8.8029611008,\n \"UAH\": 45.9853518038,\n \"BTN\": 93.173003098,\n \"GNF\": 11967.2484042726,\n \"MZN\": 81.78375806,\n \"ERN\": 19.5889984482,\n \"SVC\": 11.4269157614,\n \"ARS\": 308.7866210999,\n \"QAR\": 4.5554847915,\n \"IRR\": 52895.1368249697,\n \"XPD\": 0.0008837375,\n \"UZS\": 14374.1776461307,\n \"THB\": 43.3524967245,\n \"CNY\": 8.9386774516,\n \"XPF\": 137.4242738137,\n \"MRU\": 46.8259139461,\n \"BDT\": 135.5947135532,\n \"LYD\": 1.8161392992,\n \"BMD\": 1.3059332299,\n \"PHP\": 70.1897821139,\n \"KWD\": 0.3846932441,\n \"XPT\": 0.0015909828,\n \"RUB\": 104.8672709756,\n \"PYG\": 9061.3246970554,\n \"JMD\": 193.7301870961,\n \"ISK\": 173.8474600654,\n \"COP\": 5217.1395372442,\n \"USD\": 1.2515068109,\n \"MKD\": 71.6197176004,\n \"DZD\": 170.6229165408,\n \"PAB\": 1.3059332299,\n \"SGD\": 1.6812302291,\n \"GGP\": 1.0,\n \"ETB\": 37.2471561096,\n \"JEP\": 1.0,\n \"VEF\": 3434798.8035993176,\n \"VUV\": 148.6153103825,\n \"SOS\": 755.6276100704,\n \"KGS\": 91.100686759,\n \"LAK\": 11215.4118250063,\n \"BND\": 1.6812302291,\n \"XAF\": 755.4101924904,\n \"XAG\": 0.0817710658,\n \"LRD\": 210.2558854584,\n \"CHF\": 1.1370371801,\n \"HRK\": 8.5095577011,\n \"ALL\": 123.5281290686,\n \"DJF\": 232.2259221787,\n \"ZMW\": 15.5897637526,\n \"VES\": 4296.7172917618,\n \"TZS\": 3045.4315403429,\n \"VND\": 29113.6627987966,\n \"XAU\": 0.0009748375,\n \"SPL\": 0.2176555374,\n \"AUD\": 1.8532393662,\n \"ILS\": 4.5036630139,\n \"KPW\": 1175.3625206581,\n \"GYD\": 273.3444155784,\n \"GHS\": 6.871361893,\n \"BOB\": 8.6394787471,\n \"MDL\": 22.3403856628,\n \"KHR\": 5228.914655808,\n \"IDR\": 18623.2785301693,\n \"KYD\": 1.0708652515,\n \"AMD\": 483.5811361631,\n \"TRY\": 29.6219223117,\n \"SHP\": 1.0,\n \"BWP\": 13.7887256865,\n \"LBP\": 18780.4422003073,\n \"TJS\": 12.3259246182,\n \"JOD\": 0.92590666,\n \"HKD\": 9.8049651151,\n \"AED\": 4.5961587629,\n \"RWF\": 1155.0962074315,\n \"EUR\": 1.1627887829,\n \"LSL\": 18.3416096202,\n \"DKK\": 8.66539804,\n \"ZWD\": 472.617235893,\n \"CAD\": 1.6726041662,\n \"BGN\": 2.2742171852,\n \"MMK\": 1996.7640829066,\n \"NOK\": 13.5135633736,\n \"XBT\": 0.0003353033,\n \"SYP\": 672.6335163678,\n \"MUR\": 44.8440534065,\n \"IMP\": 1.0,\n \"GIP\": 1.0,\n \"RON\": 5.7632944865,\n \"LKR\": 376.7713047699,\n \"NGN\": 580.0683143213,\n \"CZK\": 27.656667477,\n \"CRC\": 679.5767143379,\n \"PKR\": 359.7950465233,\n \"XCD\": 3.3830911558,\n \"HTG\": 107.9925967499,\n \"ANG\": 2.3365077991,\n \"BHD\": 0.4705665609,\n \"KZT\": 560.1709379945,\n \"SZL\": 18.3416096202,\n \"SRD\": 9.7286420657,\n \"SAR\": 4.6931505407,\n \"TTD\": 8.8498934716,\n \"YER\": 326.6730498341,\n \"MVR\": 20.1703046936,\n \"AFN\": 107.2363351031,\n \"INR\": 103.0586836164,\n \"KRW\": 1608.0659639448,\n \"NPR\": 149.7756024801,\n \"AWG\": 2.3376204815,\n \"JPY\": 174.5416257632,\n \"MNT\": 3441.1249735503,\n \"PLN\": 5.1718245608,\n \"AOA\": 846.5599364606,\n \"SBD\": 10.4726324801,\n \"GBP\": 1.0,\n \"BYN\": 3.1286213808,\n \"HUF\": 429.2782537469,\n \"BIF\": 2353.1701805943,\n \"MWK\": 951.5184773993,\n \"MGA\": 4688.3032769689,\n \"XDR\": 0.9386242193,\n \"BZD\": 2.630327635,\n \"BAM\": 2.2742171852,\n \"MOP\": 10.0991140685,\n \"EGP\": 38.6741278363,\n \"NAD\": 18.3416096202,\n \"NIO\": 42.6167894155,\n \"PEN\": 4.5534926477,\n \"WST\": 3.4198275565,\n \"NZD\": 2.0421696129,\n \"TMT\": 4.5707663836,\n \"BRL\": 6.0846609662\n }\n },\n \"longitude\": -1.534099,\n \"latitude\": 52.2801467,\n \"locality\": \"leamington Spa\"\n}","options":{"raw":{"language":"json"}}},"url":"/v2/delivery/clickAndCollect/getLocations"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"clickAndCollectLocations\": [\n {\n \"id\": \"S19414\",\n \"latitude\": 52.2801467,\n \"longitude\": -1.534099,\n \"address\": {\n \"companyName\": \"Tachbrook Con Store\",\n \"streetName\": \"111-113 Tachbrook Road\",\n \"line3\": \"Leamington Spa\",\n \"postcode\": \"CV31 3EA\",\n \"countryCode\": \"GB\"\n },\n \"courierId\": 109,\n \"distance\": 210.16,\n \"businessHours\": [\n {\n \"dayOfWeek\": \"MON\",\n \"fromTime\": \"06:00\",\n \"untilTime\": \"23:00\"\n },\n {\n \"dayOfWeek\": \"TUE\",\n \"fromTime\": \"06:00\",\n \"untilTime\": \"23:00\"\n },\n {\n \"dayOfWeek\": \"WED\",\n \"fromTime\": \"06:00\",\n \"untilTime\": \"23:00\"\n },\n {\n \"dayOfWeek\": \"THU\",\n \"fromTime\": \"06:00\",\n \"untilTime\": \"23:00\"\n },\n {\n \"dayOfWeek\": \"FRI\",\n \"fromTime\": \"06:00\",\n \"untilTime\": \"23:00\"\n },\n {\n \"dayOfWeek\": \"SAT\",\n \"fromTime\": \"06:00\",\n \"untilTime\": \"23:00\"\n },\n {\n \"dayOfWeek\": \"SUN\",\n \"fromTime\": \"07:00\",\n \"untilTime\": \"22:30\"\n }\n ],\n \"holidays\": [],\n \"type\": \"SHOP\",\n \"deliveryOptions\": [\n {\n \"deliveryRuleId\": 67019,\n \"serviceId\": 115,\n \"warehouseId\": 31,\n \"deliveryTypeId\": 27,\n \"minimumDeliveryTime\": 2,\n \"maximumDeliveryTime\": 3,\n \"premiumService\": false,\n \"taxable\": false,\n \"price\": 4.49\n }\n ]\n },\n {\n \"id\": \"S37569\",\n \"latitude\": 52.2743287,\n \"longitude\": -1.5245176,\n \"address\": {\n \"companyName\": \"ST. MARGARETS NEWS & OFF LICENSE\",\n \"streetName\": \"Orchards Corner\",\n \"line3\": \"Leamington Spa\",\n \"postcode\": \"CV31 2NT\",\n \"countryCode\": \"GB\"\n },\n \"courierId\": 109,\n \"distance\": 718.19,\n \"businessHours\": [\n {\n \"dayOfWeek\": \"MON\",\n \"fromTime\": \"08:00\",\n \"untilTime\": \"20:00\"\n },\n {\n \"dayOfWeek\": \"TUE\",\n \"fromTime\": \"08:00\",\n \"untilTime\": \"20:00\"\n },\n {\n \"dayOfWeek\": \"WED\",\n \"fromTime\": \"08:00\",\n \"untilTime\": \"20:00\"\n },\n {\n \"dayOfWeek\": \"THU\",\n \"fromTime\": \"08:00\",\n \"untilTime\": \"20:00\"\n },\n {\n \"dayOfWeek\": \"FRI\",\n \"fromTime\": \"08:00\",\n \"untilTime\": \"20:00\"\n },\n {\n \"dayOfWeek\": \"SAT\",\n \"fromTime\": \"08:00\",\n \"untilTime\": \"20:00\"\n },\n {\n \"dayOfWeek\": \"SUN\",\n \"fromTime\": \"08:00\",\n \"untilTime\": \"20:00\"\n }\n ],\n \"holidays\": [],\n \"type\": \"SHOP\",\n \"deliveryOptions\": [\n {\n \"deliveryRuleId\": 67019,\n \"serviceId\": 115,\n \"warehouseId\": 31,\n \"deliveryTypeId\": 27,\n \"minimumDeliveryTime\": 2,\n \"maximumDeliveryTime\": 3,\n \"premiumService\": false,\n \"taxable\": false,\n \"price\": 4.49\n }\n ]\n },\n {\n \"id\": \"S35437\",\n \"latitude\": 52.2884875,\n \"longitude\": -1.5353689,\n \"address\": {\n \"companyName\": \"Co-Op\",\n \"streetName\": \"156 Parade\",\n \"line3\": \"Leamington Spa\",\n \"postcode\": \"CV32 4AG\",\n \"countryCode\": \"GB\"\n },\n \"courierId\": 109,\n \"distance\": 1064.71,\n \"businessHours\": [\n {\n \"dayOfWeek\": \"MON\",\n \"fromTime\": \"07:00\",\n \"untilTime\": \"21:00\"\n },\n {\n \"dayOfWeek\": \"TUE\",\n \"fromTime\": \"07:00\",\n \"untilTime\": \"21:00\"\n },\n {\n \"dayOfWeek\": \"WED\",\n \"fromTime\": \"07:00\",\n \"untilTime\": \"21:00\"\n },\n {\n \"dayOfWeek\": \"THU\",\n \"fromTime\": \"07:00\",\n \"untilTime\": \"21:00\"\n },\n {\n \"dayOfWeek\": \"FRI\",\n \"fromTime\": \"07:00\",\n \"untilTime\": \"21:00\"\n },\n {\n \"dayOfWeek\": \"SAT\",\n \"fromTime\": \"07:00\",\n \"untilTime\": \"21:00\"\n },\n {\n \"dayOfWeek\": \"SUN\",\n \"fromTime\": \"07:00\",\n \"untilTime\": \"21:00\"\n }\n ],\n \"holidays\": [],\n \"type\": \"SHOP\",\n \"deliveryOptions\": [\n {\n \"deliveryRuleId\": 67019,\n \"serviceId\": 115,\n \"warehouseId\": 31,\n \"deliveryTypeId\": 27,\n \"minimumDeliveryTime\": 2,\n \"maximumDeliveryTime\": 3,\n \"premiumService\": false,\n \"taxable\": false,\n \"price\": 4.49\n }\n ]\n },\n {\n \"id\": \"S32289\",\n \"latitude\": 52.2688791,\n \"longitude\": -1.5280941,\n \"address\": {\n \"companyName\": \"One Stop\",\n \"streetName\": \"76-78 Heathcote Road, Whitnash\",\n \"line3\": \"Leamington Spa\",\n \"postcode\": \"CV31 2LY\",\n \"countryCode\": \"GB\"\n },\n \"courierId\": 109,\n \"distance\": 1172.22,\n \"businessHours\": [\n {\n \"dayOfWeek\": \"MON\",\n \"fromTime\": \"06:00\",\n \"untilTime\": \"22:00\"\n },\n {\n \"dayOfWeek\": \"TUE\",\n \"fromTime\": \"06:00\",\n \"untilTime\": \"22:00\"\n },\n {\n \"dayOfWeek\": \"WED\",\n \"fromTime\": \"06:00\",\n \"untilTime\": \"22:00\"\n },\n {\n \"dayOfWeek\": \"THU\",\n \"fromTime\": \"06:00\",\n \"untilTime\": \"22:00\"\n },\n {\n \"dayOfWeek\": \"FRI\",\n \"fromTime\": \"06:00\",\n \"untilTime\": \"22:00\"\n },\n {\n \"dayOfWeek\": \"SAT\",\n \"fromTime\": \"06:00\",\n \"untilTime\": \"22:00\"\n },\n {\n \"dayOfWeek\": \"SUN\",\n \"fromTime\": \"06:00\",\n \"untilTime\": \"22:00\"\n }\n ],\n \"holidays\": [],\n \"type\": \"SHOP\",\n \"deliveryOptions\": [\n {\n \"deliveryRuleId\": 67019,\n \"serviceId\": 115,\n \"warehouseId\": 31,\n \"deliveryTypeId\": 27,\n \"minimumDeliveryTime\": 2,\n \"maximumDeliveryTime\": 3,\n \"premiumService\": false,\n \"taxable\": false,\n \"price\": 4.49\n }\n ]\n },\n {\n \"id\": \"S45503\",\n \"latitude\": 52.29295037,\n \"longitude\": -1.531281874,\n \"address\": {\n \"companyName\": \"Post Office Clarendon Street\",\n \"streetName\": \"69 Clarendon Street\",\n \"line3\": \"Leamington Spa\",\n \"postcode\": \"CV32 4PN\",\n \"countryCode\": \"GB\"\n },\n \"courierId\": 109,\n \"distance\": 1526.21,\n \"businessHours\": [\n {\n \"dayOfWeek\": \"MON\",\n \"fromTime\": \"09:00\",\n \"untilTime\": \"17:30\"\n },\n {\n \"dayOfWeek\": \"TUE\",\n \"fromTime\": \"09:00\",\n \"untilTime\": \"17:30\"\n },\n {\n \"dayOfWeek\": \"WED\",\n \"fromTime\": \"09:00\",\n \"untilTime\": \"17:30\"\n },\n {\n \"dayOfWeek\": \"THU\",\n \"fromTime\": \"09:00\",\n \"untilTime\": \"17:30\"\n },\n {\n \"dayOfWeek\": \"FRI\",\n \"fromTime\": \"09:00\",\n \"untilTime\": \"17:30\"\n },\n {\n \"dayOfWeek\": \"SAT\",\n \"fromTime\": \"09:00\",\n \"untilTime\": \"13:00\"\n }\n ],\n \"holidays\": [],\n \"type\": \"SHOP\",\n \"deliveryOptions\": [\n {\n \"deliveryRuleId\": 67019,\n \"serviceId\": 115,\n \"warehouseId\": 31,\n \"deliveryTypeId\": 27,\n \"minimumDeliveryTime\": 2,\n \"maximumDeliveryTime\": 3,\n \"premiumService\": false,\n \"taxable\": false,\n \"price\": 4.49\n }\n ]\n }\n ]\n}"},{"id":"24d31571-0c6b-4fd8-9304-c15f710e63be","name":"Get Click And Collect Locations (Failure - 401)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"destination\": {\n \"postcode\": \"cv31 3dw\",\n \"countryCode\": \"GB\"\n },\n \"deliveryOrder\": {\n \"currencyCode\": \"GBP\",\n \"deliveryOrderProducts\": [\n {\n \"productId\": \"10530986\",\n \"warehouseIds\": [\n 0,\n 31\n ],\n \"quantity\": 1,\n \"weightInGram\": 1000,\n \"price\": 40.45,\n \"hazmat\": false\n }\n ]\n },\n \"fxRates\": {\n \"baseCurrency\": \"GBP\",\n \"fxRates\": {\n \"FJD\": 2.8040962857,\n \"MXN\": 21.6335149697,\n \"TVD\": 1.8221895001,\n \"SCR\": 17.9165347784,\n \"CDF\": 2110.6207411016,\n \"GTQ\": 10.1132853368,\n \"BBD\": 2.6118664598,\n \"CLP\": 987.0094616224,\n \"UGX\": 4794.1106812318,\n \"HNL\": 31.8731231598,\n \"ZAR\": 23.227609537,\n \"TND\": 3.8884318189,\n \"STN\": 28.2982171783,\n \"CUC\": 1.2515068109,\n \"SLL\": 11323.1745466356,\n \"BSD\": 1.3059332299,\n \"SDG\": 62.2831926938,\n \"IQD\": 1638.5873623062,\n \"GMD\": 64.7122856991,\n \"CUP\": 34.6072305918,\n \"TWD\": 38.4578310551,\n \"RSD\": 136.3188087707,\n \"DOP\": 68.3195747137,\n \"KMF\": 566.5576443678,\n \"MYR\": 5.7815686392,\n \"FKP\": 1.0,\n \"XOF\": 755.4101924904,\n \"GEL\": 3.460634302,\n \"UYU\": 48.4626555406,\n \"MAD\": 12.6986591804,\n \"CVE\": 126.9886317638,\n \"TOP\": 3.0510964851,\n \"OMR\": 0.4818220141,\n \"AZN\": 2.1295701121,\n \"PGK\": 4.395433973,\n \"SEK\": 13.5390275584,\n \"KES\": 174.5793819601,\n \"CNH\": 8.8029611008,\n \"UAH\": 45.9853518038,\n \"BTN\": 93.173003098,\n \"GNF\": 11967.2484042726,\n \"MZN\": 81.78375806,\n \"ERN\": 19.5889984482,\n \"SVC\": 11.4269157614,\n \"ARS\": 308.7866210999,\n \"QAR\": 4.5554847915,\n \"IRR\": 52895.1368249697,\n \"XPD\": 0.0008837375,\n \"UZS\": 14374.1776461307,\n \"THB\": 43.3524967245,\n \"CNY\": 8.9386774516,\n \"XPF\": 137.4242738137,\n \"MRU\": 46.8259139461,\n \"BDT\": 135.5947135532,\n \"LYD\": 1.8161392992,\n \"BMD\": 1.3059332299,\n \"PHP\": 70.1897821139,\n \"KWD\": 0.3846932441,\n \"XPT\": 0.0015909828,\n \"RUB\": 104.8672709756,\n \"PYG\": 9061.3246970554,\n \"JMD\": 193.7301870961,\n \"ISK\": 173.8474600654,\n \"COP\": 5217.1395372442,\n \"USD\": 1.2515068109,\n \"MKD\": 71.6197176004,\n \"DZD\": 170.6229165408,\n \"PAB\": 1.3059332299,\n \"SGD\": 1.6812302291,\n \"GGP\": 1.0,\n \"ETB\": 37.2471561096,\n \"JEP\": 1.0,\n \"VEF\": 3434798.8035993176,\n \"VUV\": 148.6153103825,\n \"SOS\": 755.6276100704,\n \"KGS\": 91.100686759,\n \"LAK\": 11215.4118250063,\n \"BND\": 1.6812302291,\n \"XAF\": 755.4101924904,\n \"XAG\": 0.0817710658,\n \"LRD\": 210.2558854584,\n \"CHF\": 1.1370371801,\n \"HRK\": 8.5095577011,\n \"ALL\": 123.5281290686,\n \"DJF\": 232.2259221787,\n \"ZMW\": 15.5897637526,\n \"VES\": 4296.7172917618,\n \"TZS\": 3045.4315403429,\n \"VND\": 29113.6627987966,\n \"XAU\": 0.0009748375,\n \"SPL\": 0.2176555374,\n \"AUD\": 1.8532393662,\n \"ILS\": 4.5036630139,\n \"KPW\": 1175.3625206581,\n \"GYD\": 273.3444155784,\n \"GHS\": 6.871361893,\n \"BOB\": 8.6394787471,\n \"MDL\": 22.3403856628,\n \"KHR\": 5228.914655808,\n \"IDR\": 18623.2785301693,\n \"KYD\": 1.0708652515,\n \"AMD\": 483.5811361631,\n \"TRY\": 29.6219223117,\n \"SHP\": 1.0,\n \"BWP\": 13.7887256865,\n \"LBP\": 18780.4422003073,\n \"TJS\": 12.3259246182,\n \"JOD\": 0.92590666,\n \"HKD\": 9.8049651151,\n \"AED\": 4.5961587629,\n \"RWF\": 1155.0962074315,\n \"EUR\": 1.1627887829,\n \"LSL\": 18.3416096202,\n \"DKK\": 8.66539804,\n \"ZWD\": 472.617235893,\n \"CAD\": 1.6726041662,\n \"BGN\": 2.2742171852,\n \"MMK\": 1996.7640829066,\n \"NOK\": 13.5135633736,\n \"XBT\": 0.0003353033,\n \"SYP\": 672.6335163678,\n \"MUR\": 44.8440534065,\n \"IMP\": 1.0,\n \"GIP\": 1.0,\n \"RON\": 5.7632944865,\n \"LKR\": 376.7713047699,\n \"NGN\": 580.0683143213,\n \"CZK\": 27.656667477,\n \"CRC\": 679.5767143379,\n \"PKR\": 359.7950465233,\n \"XCD\": 3.3830911558,\n \"HTG\": 107.9925967499,\n \"ANG\": 2.3365077991,\n \"BHD\": 0.4705665609,\n \"KZT\": 560.1709379945,\n \"SZL\": 18.3416096202,\n \"SRD\": 9.7286420657,\n \"SAR\": 4.6931505407,\n \"TTD\": 8.8498934716,\n \"YER\": 326.6730498341,\n \"MVR\": 20.1703046936,\n \"AFN\": 107.2363351031,\n \"INR\": 103.0586836164,\n \"KRW\": 1608.0659639448,\n \"NPR\": 149.7756024801,\n \"AWG\": 2.3376204815,\n \"JPY\": 174.5416257632,\n \"MNT\": 3441.1249735503,\n \"PLN\": 5.1718245608,\n \"AOA\": 846.5599364606,\n \"SBD\": 10.4726324801,\n \"GBP\": 1.0,\n \"BYN\": 3.1286213808,\n \"HUF\": 429.2782537469,\n \"BIF\": 2353.1701805943,\n \"MWK\": 951.5184773993,\n \"MGA\": 4688.3032769689,\n \"XDR\": 0.9386242193,\n \"BZD\": 2.630327635,\n \"BAM\": 2.2742171852,\n \"MOP\": 10.0991140685,\n \"EGP\": 38.6741278363,\n \"NAD\": 18.3416096202,\n \"NIO\": 42.6167894155,\n \"PEN\": 4.5534926477,\n \"WST\": 3.4198275565,\n \"NZD\": 2.0421696129,\n \"TMT\": 4.5707663836,\n \"BRL\": 6.0846609662\n }\n },\n \"longitude\": -1.534099,\n \"latitude\": 52.2801467,\n \"locality\": \"leamington Spa\"\n}","options":{"raw":{"language":"json"}}},"url":"/v2/delivery/clickAndCollect/getLocations"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"apierror\": {\n \"status\": \"UNAUTHORIZED\",\n \"timestamp\": \"19-03-2025 11:46:46\",\n \"message\": \"Account not found for organization THG and group MYPRO1\"\n }\n}"},{"id":"76fa503d-336f-421a-bd19-ad5f36c16095","name":"Get Click And Collect Locations (Failure - 500)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"destination\": {\n \"postcode\": \"cv31 3dw\",\n \"countryCode\": \"GB\"\n },\n \"deliveryOrder\": {\n \"currencyCode\": \"GBPD\",\n \"deliveryOrderProducts\": [\n {\n \"productId\": \"10530986\",\n \"warehouseIds\": [\n 0,\n 31\n ],\n \"quantity\": 1,\n \"weightInGram\": 1000,\n \"price\": 40.45,\n \"hazmat\": false\n }\n ]\n },\n \"fxRates\": {\n \"baseCurrency\": \"GBP\",\n \"fxRates\": {\n \"FJD\": 2.8040962857,\n \"MXN\": 21.6335149697,\n \"TVD\": 1.8221895001,\n \"SCR\": 17.9165347784,\n \"CDF\": 2110.6207411016,\n \"GTQ\": 10.1132853368,\n \"BBD\": 2.6118664598,\n \"CLP\": 987.0094616224,\n \"UGX\": 4794.1106812318,\n \"HNL\": 31.8731231598,\n \"ZAR\": 23.227609537,\n \"TND\": 3.8884318189,\n \"STN\": 28.2982171783,\n \"CUC\": 1.2515068109,\n \"SLL\": 11323.1745466356,\n \"BSD\": 1.3059332299,\n \"SDG\": 62.2831926938,\n \"IQD\": 1638.5873623062,\n \"GMD\": 64.7122856991,\n \"CUP\": 34.6072305918,\n \"TWD\": 38.4578310551,\n \"RSD\": 136.3188087707,\n \"DOP\": 68.3195747137,\n \"KMF\": 566.5576443678,\n \"MYR\": 5.7815686392,\n \"FKP\": 1.0,\n \"XOF\": 755.4101924904,\n \"GEL\": 3.460634302,\n \"UYU\": 48.4626555406,\n \"MAD\": 12.6986591804,\n \"CVE\": 126.9886317638,\n \"TOP\": 3.0510964851,\n \"OMR\": 0.4818220141,\n \"AZN\": 2.1295701121,\n \"PGK\": 4.395433973,\n \"SEK\": 13.5390275584,\n \"KES\": 174.5793819601,\n \"CNH\": 8.8029611008,\n \"UAH\": 45.9853518038,\n \"BTN\": 93.173003098,\n \"GNF\": 11967.2484042726,\n \"MZN\": 81.78375806,\n \"ERN\": 19.5889984482,\n \"SVC\": 11.4269157614,\n \"ARS\": 308.7866210999,\n \"QAR\": 4.5554847915,\n \"IRR\": 52895.1368249697,\n \"XPD\": 0.0008837375,\n \"UZS\": 14374.1776461307,\n \"THB\": 43.3524967245,\n \"CNY\": 8.9386774516,\n \"XPF\": 137.4242738137,\n \"MRU\": 46.8259139461,\n \"BDT\": 135.5947135532,\n \"LYD\": 1.8161392992,\n \"BMD\": 1.3059332299,\n \"PHP\": 70.1897821139,\n \"KWD\": 0.3846932441,\n \"XPT\": 0.0015909828,\n \"RUB\": 104.8672709756,\n \"PYG\": 9061.3246970554,\n \"JMD\": 193.7301870961,\n \"ISK\": 173.8474600654,\n \"COP\": 5217.1395372442,\n \"USD\": 1.2515068109,\n \"MKD\": 71.6197176004,\n \"DZD\": 170.6229165408,\n \"PAB\": 1.3059332299,\n \"SGD\": 1.6812302291,\n \"GGP\": 1.0,\n \"ETB\": 37.2471561096,\n \"JEP\": 1.0,\n \"VEF\": 3434798.8035993176,\n \"VUV\": 148.6153103825,\n \"SOS\": 755.6276100704,\n \"KGS\": 91.100686759,\n \"LAK\": 11215.4118250063,\n \"BND\": 1.6812302291,\n \"XAF\": 755.4101924904,\n \"XAG\": 0.0817710658,\n \"LRD\": 210.2558854584,\n \"CHF\": 1.1370371801,\n \"HRK\": 8.5095577011,\n \"ALL\": 123.5281290686,\n \"DJF\": 232.2259221787,\n \"ZMW\": 15.5897637526,\n \"VES\": 4296.7172917618,\n \"TZS\": 3045.4315403429,\n \"VND\": 29113.6627987966,\n \"XAU\": 0.0009748375,\n \"SPL\": 0.2176555374,\n \"AUD\": 1.8532393662,\n \"ILS\": 4.5036630139,\n \"KPW\": 1175.3625206581,\n \"GYD\": 273.3444155784,\n \"GHS\": 6.871361893,\n \"BOB\": 8.6394787471,\n \"MDL\": 22.3403856628,\n \"KHR\": 5228.914655808,\n \"IDR\": 18623.2785301693,\n \"KYD\": 1.0708652515,\n \"AMD\": 483.5811361631,\n \"TRY\": 29.6219223117,\n \"SHP\": 1.0,\n \"BWP\": 13.7887256865,\n \"LBP\": 18780.4422003073,\n \"TJS\": 12.3259246182,\n \"JOD\": 0.92590666,\n \"HKD\": 9.8049651151,\n \"AED\": 4.5961587629,\n \"RWF\": 1155.0962074315,\n \"EUR\": 1.1627887829,\n \"LSL\": 18.3416096202,\n \"DKK\": 8.66539804,\n \"ZWD\": 472.617235893,\n \"CAD\": 1.6726041662,\n \"BGN\": 2.2742171852,\n \"MMK\": 1996.7640829066,\n \"NOK\": 13.5135633736,\n \"XBT\": 0.0003353033,\n \"SYP\": 672.6335163678,\n \"MUR\": 44.8440534065,\n \"IMP\": 1.0,\n \"GIP\": 1.0,\n \"RON\": 5.7632944865,\n \"LKR\": 376.7713047699,\n \"NGN\": 580.0683143213,\n \"CZK\": 27.656667477,\n \"CRC\": 679.5767143379,\n \"PKR\": 359.7950465233,\n \"XCD\": 3.3830911558,\n \"HTG\": 107.9925967499,\n \"ANG\": 2.3365077991,\n \"BHD\": 0.4705665609,\n \"KZT\": 560.1709379945,\n \"SZL\": 18.3416096202,\n \"SRD\": 9.7286420657,\n \"SAR\": 4.6931505407,\n \"TTD\": 8.8498934716,\n \"YER\": 326.6730498341,\n \"MVR\": 20.1703046936,\n \"AFN\": 107.2363351031,\n \"INR\": 103.0586836164,\n \"KRW\": 1608.0659639448,\n \"NPR\": 149.7756024801,\n \"AWG\": 2.3376204815,\n \"JPY\": 174.5416257632,\n \"MNT\": 3441.1249735503,\n \"PLN\": 5.1718245608,\n \"AOA\": 846.5599364606,\n \"SBD\": 10.4726324801,\n \"GBP\": 1.0,\n \"BYN\": 3.1286213808,\n \"HUF\": 429.2782537469,\n \"BIF\": 2353.1701805943,\n \"MWK\": 951.5184773993,\n \"MGA\": 4688.3032769689,\n \"XDR\": 0.9386242193,\n \"BZD\": 2.630327635,\n \"BAM\": 2.2742171852,\n \"MOP\": 10.0991140685,\n \"EGP\": 38.6741278363,\n \"NAD\": 18.3416096202,\n \"NIO\": 42.6167894155,\n \"PEN\": 4.5534926477,\n \"WST\": 3.4198275565,\n \"NZD\": 2.0421696129,\n \"TMT\": 4.5707663836,\n \"BRL\": 6.0846609662\n }\n },\n \"longitude\": -1.534099,\n \"latitude\": 52.2801467,\n \"locality\": \"leamington Spa\"\n}","options":{"raw":{"language":"json"}}},"url":"/v2/delivery/clickAndCollect/getLocations"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"apierror\": {\n \"status\": \"INTERNAL_SERVER_ERROR\",\n \"timestamp\": \"19-03-2025 11:47:40\",\n \"message\": \"Something unexpected happened\"\n }\n}"}],"_postman_id":"94d5ffa3-5226-4ba6-b299-a3fa8daf3a41"},{"name":"Get Delivery Options ref: DEL.I.01","id":"34214520-7017-4a2e-a52a-63ca1b252ba2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"destination\": {\n \"postcode\": \"String\",\n \"countryCode\": \"String\"\n },\n \"deliveryOrder\": {\n \"currencyCode\": \"String\",\n \"deliveryOrderProducts\": [\n {\n \"productId\": \"String\",\n \"warehouseIds\": [\n \"Integer\"\n ],\n \"quantity\": \"int\",\n \"weightInGram\": \"int\",\n \"price\": \"BigDecimal\",\n \"hazmat\": \"boolean\"\n }\n ]\n },\n \"fxRates\": {\n \"baseCurrency\": \"GBP\",\n \"fxRates\": {\n \"EUR\": 0.0,\n \"USD\": 0.0\n }\n },\n \"clickAndCollect\": \"boolean\"\n}","options":{"raw":{"language":"json"}}},"url":"/v1/delivery/options","description":"

This endpoint retrieves the delivery options available for a site, based on the warehouse and destination.

How It Works

When a request is made, the system checks the site’s associated warehouse and the destination address, then returns all eligible delivery methods that meet the configured criteria (e.g., currency, threshold value bracket, threshold weight bracket).

Pre-Configuration Requirements

To ensure accurate results from this endpoint, make sure the following are in place:

Warehouse is correctly set up in the system.
\n
Account with SiteCode is configured correctly.
\n
Carrier services are linked to delivery rules (if required).
\n
Pricing rules are created, including any thresholds to enable free shipping based on value and weight brackets.
\n
Destination address data in the request is accurate and complete.
\n

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
destination	Object	Yes	Destination details for the delivery.
deliveryOrder	Object	Yes	Details of the delivery order.
fxRates	Object	Yes	Exchange rates related data
clickAndCollect	boolean	No	Is Click And Collect Delivery options

Destination Details

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
postcode	String	No	Postal code of the destination. Required for most countries except a few where there are no postcodes e.g. HK
countryCode	String	Yes	2 Char ISO Country code

DeliveryOrder Details

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
currencyCode	String	Yes	3 character ISO currency code pertaining to basket item prices
deliveryOrderProducts	List(DeliveryOrderProduct)	Yes	List of products in the delivery order.

DeliveryOrderProducts Details

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
productId	String	Yes	Unique identifier for the product.Product SKU
warehouseIds	List(Integer)	Yes	List of warehouse Ids where the product is in stock in the order of priority for fulfilment
quantity	Int	Yes	Quantity of the product ordered.
weightInGram	Int	Yes	Weight of the product in grams.
price	BigDecimal	Yes	Price of the product.Product unit price e.g. 35.00
hazmat	boolean	No	Indicates if the product is hazardous material.Defaults to false

Fx Rates Details

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
baseCurrency	String	Yes	Base currency code (e.g., \"GBP\").
fxRates	Map(String, BigDecimal)	No	Mapping of currency codes to their exchange rates relative to the base currency.

","urlObject":{"path":["v1","delivery","options"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"149c89ba-f68f-4081-8753-c074e3e0c5ec","name":"Get Delivery Options (Success)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"destination\": {\n \"postcode\": \"cv31 3dw\",\n \"countryCode\": \"GB\"\n },\n \"deliveryOrder\": {\n \"currencyCode\": \"GBP\",\n \"deliveryOrderProducts\": [\n {\n \"productId\": \"13474675\",\n \"warehouseIds\": [\n 0,\n 31\n ],\n \"quantity\": 1,\n \"weightInGram\": 1000,\n \"price\": 40.45,\n \"hazmat\": false\n }\n ]\n },\n \"fxRates\": {\n \"baseCurrency\": \"GBP\",\n \"fxRates\": {\n \"FJD\": 2.8040962857,\n \"MXN\": 21.6335149697,\n \"TVD\": 1.8221895001,\n \"SCR\": 17.9165347784,\n \"CDF\": 2110.6207411016,\n \"GTQ\": 10.1132853368,\n \"BBD\": 2.6118664598,\n \"CLP\": 987.0094616224,\n \"UGX\": 4794.1106812318,\n \"HNL\": 31.8731231598,\n \"ZAR\": 23.227609537,\n \"TND\": 3.8884318189,\n \"STN\": 28.2982171783,\n \"CUC\": 1.2515068109,\n \"SLL\": 11323.1745466356,\n \"BSD\": 1.3059332299,\n \"SDG\": 62.2831926938,\n \"IQD\": 1638.5873623062,\n \"GMD\": 64.7122856991,\n \"CUP\": 34.6072305918,\n \"TWD\": 38.4578310551,\n \"RSD\": 136.3188087707,\n \"DOP\": 68.3195747137,\n \"KMF\": 566.5576443678,\n \"MYR\": 5.7815686392,\n \"FKP\": 1.0,\n \"XOF\": 755.4101924904,\n \"GEL\": 3.460634302,\n \"UYU\": 48.4626555406,\n \"MAD\": 12.6986591804,\n \"CVE\": 126.9886317638,\n \"TOP\": 3.0510964851,\n \"OMR\": 0.4818220141,\n \"AZN\": 2.1295701121,\n \"PGK\": 4.395433973,\n \"SEK\": 13.5390275584,\n \"KES\": 174.5793819601,\n \"CNH\": 8.8029611008,\n \"UAH\": 45.9853518038,\n \"BTN\": 93.173003098,\n \"GNF\": 11967.2484042726,\n \"MZN\": 81.78375806,\n \"ERN\": 19.5889984482,\n \"SVC\": 11.4269157614,\n \"ARS\": 308.7866210999,\n \"QAR\": 4.5554847915,\n \"IRR\": 52895.1368249697,\n \"XPD\": 0.0008837375,\n \"UZS\": 14374.1776461307,\n \"THB\": 43.3524967245,\n \"CNY\": 8.9386774516,\n \"XPF\": 137.4242738137,\n \"MRU\": 46.8259139461,\n \"BDT\": 135.5947135532,\n \"LYD\": 1.8161392992,\n \"BMD\": 1.3059332299,\n \"PHP\": 70.1897821139,\n \"KWD\": 0.3846932441,\n \"XPT\": 0.0015909828,\n \"RUB\": 104.8672709756,\n \"PYG\": 9061.3246970554,\n \"JMD\": 193.7301870961,\n \"ISK\": 173.8474600654,\n \"COP\": 5217.1395372442,\n \"USD\": 1.2515068109,\n \"MKD\": 71.6197176004,\n \"DZD\": 170.6229165408,\n \"PAB\": 1.3059332299,\n \"SGD\": 1.6812302291,\n \"GGP\": 1.0,\n \"ETB\": 37.2471561096,\n \"JEP\": 1.0,\n \"VEF\": 3434798.8035993176,\n \"VUV\": 148.6153103825,\n \"SOS\": 755.6276100704,\n \"KGS\": 91.100686759,\n \"LAK\": 11215.4118250063,\n \"BND\": 1.6812302291,\n \"XAF\": 755.4101924904,\n \"XAG\": 0.0817710658,\n \"LRD\": 210.2558854584,\n \"CHF\": 1.1370371801,\n \"HRK\": 8.5095577011,\n \"ALL\": 123.5281290686,\n \"DJF\": 232.2259221787,\n \"ZMW\": 15.5897637526,\n \"VES\": 4296.7172917618,\n \"TZS\": 3045.4315403429,\n \"VND\": 29113.6627987966,\n \"XAU\": 0.0009748375,\n \"SPL\": 0.2176555374,\n \"AUD\": 1.8532393662,\n \"ILS\": 4.5036630139,\n \"KPW\": 1175.3625206581,\n \"GYD\": 273.3444155784,\n \"GHS\": 6.871361893,\n \"BOB\": 8.6394787471,\n \"MDL\": 22.3403856628,\n \"KHR\": 5228.914655808,\n \"IDR\": 18623.2785301693,\n \"KYD\": 1.0708652515,\n \"AMD\": 483.5811361631,\n \"TRY\": 29.6219223117,\n \"SHP\": 1.0,\n \"BWP\": 13.7887256865,\n \"LBP\": 18780.4422003073,\n \"TJS\": 12.3259246182,\n \"JOD\": 0.92590666,\n \"HKD\": 9.8049651151,\n \"AED\": 4.5961587629,\n \"RWF\": 1155.0962074315,\n \"EUR\": 1.1627887829,\n \"LSL\": 18.3416096202,\n \"DKK\": 8.66539804,\n \"ZWD\": 472.617235893,\n \"CAD\": 1.6726041662,\n \"BGN\": 2.2742171852,\n \"MMK\": 1996.7640829066,\n \"NOK\": 13.5135633736,\n \"XBT\": 0.0003353033,\n \"SYP\": 672.6335163678,\n \"MUR\": 44.8440534065,\n \"IMP\": 1.0,\n \"GIP\": 1.0,\n \"RON\": 5.7632944865,\n \"LKR\": 376.7713047699,\n \"NGN\": 580.0683143213,\n \"CZK\": 27.656667477,\n \"CRC\": 679.5767143379,\n \"PKR\": 359.7950465233,\n \"XCD\": 3.3830911558,\n \"HTG\": 107.9925967499,\n \"ANG\": 2.3365077991,\n \"BHD\": 0.4705665609,\n \"KZT\": 560.1709379945,\n \"SZL\": 18.3416096202,\n \"SRD\": 9.7286420657,\n \"SAR\": 4.6931505407,\n \"TTD\": 8.8498934716,\n \"YER\": 326.6730498341,\n \"MVR\": 20.1703046936,\n \"AFN\": 107.2363351031,\n \"INR\": 103.0586836164,\n \"KRW\": 1608.0659639448,\n \"NPR\": 149.7756024801,\n \"AWG\": 2.3376204815,\n \"JPY\": 174.5416257632,\n \"MNT\": 3441.1249735503,\n \"PLN\": 5.1718245608,\n \"AOA\": 846.5599364606,\n \"SBD\": 10.4726324801,\n \"GBP\": 1.0,\n \"BYN\": 3.1286213808,\n \"HUF\": 429.2782537469,\n \"BIF\": 2353.1701805943,\n \"MWK\": 951.5184773993,\n \"MGA\": 4688.3032769689,\n \"XDR\": 0.9386242193,\n \"BZD\": 2.630327635,\n \"BAM\": 2.2742171852,\n \"MOP\": 10.0991140685,\n \"EGP\": 38.6741278363,\n \"NAD\": 18.3416096202,\n \"NIO\": 42.6167894155,\n \"PEN\": 4.5534926477,\n \"WST\": 3.4198275565,\n \"NZD\": 2.0421696129,\n \"TMT\": 4.5707663836,\n \"BRL\": 6.0846609662\n }\n },\n \"clickAndCollect\": false\n}","options":{"raw":{"language":"json"}}},"url":"/v1/delivery/options"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"productDeliveryOptions\": [\n {\n \"productId\": \"13474675\",\n \"deliveryOptions\": [\n {\n \"deliveryRuleId\": 58606,\n \"warehouseId\": 31,\n \"destinationId\": 10,\n \"deliveryTypeId\": 2,\n \"minimumDeliveryTime\": 3,\n \"maximumDeliveryTime\": 7,\n \"premiumService\": true,\n \"taxable\": false,\n \"price\": 7.00,\n \"additionalFields\": [\n \"PHONE_NUMBER\"\n ]\n }\n ],\n \"unshippable\": false\n }\n ],\n \"addressBlacklisted\": false\n}"},{"id":"fa227c3b-ae1c-43c5-a508-4969cecd65e7","name":"Get Delivery Options (Failure - 401)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"destination\": {\n \"postcode\": \"cv31 3dw\",\n \"countryCode\": \"GB\"\n },\n \"deliveryOrder\": {\n \"currencyCode\": \"GBP\",\n \"deliveryOrderProducts\": [\n {\n \"productId\": \"13474675\",\n \"warehouseIds\": [\n 0,\n 31\n ],\n \"quantity\": 1,\n \"weightInGram\": 1000,\n \"price\": 40.45,\n \"hazmat\": false\n }\n ]\n },\n \"fxRates\": {\n \"baseCurrency\": \"GBP\",\n \"fxRates\": {\n \"FJD\": 2.8040962857,\n \"MXN\": 21.6335149697,\n \"TVD\": 1.8221895001,\n \"SCR\": 17.9165347784,\n \"CDF\": 2110.6207411016,\n \"GTQ\": 10.1132853368,\n \"BBD\": 2.6118664598,\n \"CLP\": 987.0094616224,\n \"UGX\": 4794.1106812318,\n \"HNL\": 31.8731231598,\n \"ZAR\": 23.227609537,\n \"TND\": 3.8884318189,\n \"STN\": 28.2982171783,\n \"CUC\": 1.2515068109,\n \"SLL\": 11323.1745466356,\n \"BSD\": 1.3059332299,\n \"SDG\": 62.2831926938,\n \"IQD\": 1638.5873623062,\n \"GMD\": 64.7122856991,\n \"CUP\": 34.6072305918,\n \"TWD\": 38.4578310551,\n \"RSD\": 136.3188087707,\n \"DOP\": 68.3195747137,\n \"KMF\": 566.5576443678,\n \"MYR\": 5.7815686392,\n \"FKP\": 1.0,\n \"XOF\": 755.4101924904,\n \"GEL\": 3.460634302,\n \"UYU\": 48.4626555406,\n \"MAD\": 12.6986591804,\n \"CVE\": 126.9886317638,\n \"TOP\": 3.0510964851,\n \"OMR\": 0.4818220141,\n \"AZN\": 2.1295701121,\n \"PGK\": 4.395433973,\n \"SEK\": 13.5390275584,\n \"KES\": 174.5793819601,\n \"CNH\": 8.8029611008,\n \"UAH\": 45.9853518038,\n \"BTN\": 93.173003098,\n \"GNF\": 11967.2484042726,\n \"MZN\": 81.78375806,\n \"ERN\": 19.5889984482,\n \"SVC\": 11.4269157614,\n \"ARS\": 308.7866210999,\n \"QAR\": 4.5554847915,\n \"IRR\": 52895.1368249697,\n \"XPD\": 0.0008837375,\n \"UZS\": 14374.1776461307,\n \"THB\": 43.3524967245,\n \"CNY\": 8.9386774516,\n \"XPF\": 137.4242738137,\n \"MRU\": 46.8259139461,\n \"BDT\": 135.5947135532,\n \"LYD\": 1.8161392992,\n \"BMD\": 1.3059332299,\n \"PHP\": 70.1897821139,\n \"KWD\": 0.3846932441,\n \"XPT\": 0.0015909828,\n \"RUB\": 104.8672709756,\n \"PYG\": 9061.3246970554,\n \"JMD\": 193.7301870961,\n \"ISK\": 173.8474600654,\n \"COP\": 5217.1395372442,\n \"USD\": 1.2515068109,\n \"MKD\": 71.6197176004,\n \"DZD\": 170.6229165408,\n \"PAB\": 1.3059332299,\n \"SGD\": 1.6812302291,\n \"GGP\": 1.0,\n \"ETB\": 37.2471561096,\n \"JEP\": 1.0,\n \"VEF\": 3434798.8035993176,\n \"VUV\": 148.6153103825,\n \"SOS\": 755.6276100704,\n \"KGS\": 91.100686759,\n \"LAK\": 11215.4118250063,\n \"BND\": 1.6812302291,\n \"XAF\": 755.4101924904,\n \"XAG\": 0.0817710658,\n \"LRD\": 210.2558854584,\n \"CHF\": 1.1370371801,\n \"HRK\": 8.5095577011,\n \"ALL\": 123.5281290686,\n \"DJF\": 232.2259221787,\n \"ZMW\": 15.5897637526,\n \"VES\": 4296.7172917618,\n \"TZS\": 3045.4315403429,\n \"VND\": 29113.6627987966,\n \"XAU\": 0.0009748375,\n \"SPL\": 0.2176555374,\n \"AUD\": 1.8532393662,\n \"ILS\": 4.5036630139,\n \"KPW\": 1175.3625206581,\n \"GYD\": 273.3444155784,\n \"GHS\": 6.871361893,\n \"BOB\": 8.6394787471,\n \"MDL\": 22.3403856628,\n \"KHR\": 5228.914655808,\n \"IDR\": 18623.2785301693,\n \"KYD\": 1.0708652515,\n \"AMD\": 483.5811361631,\n \"TRY\": 29.6219223117,\n \"SHP\": 1.0,\n \"BWP\": 13.7887256865,\n \"LBP\": 18780.4422003073,\n \"TJS\": 12.3259246182,\n \"JOD\": 0.92590666,\n \"HKD\": 9.8049651151,\n \"AED\": 4.5961587629,\n \"RWF\": 1155.0962074315,\n \"EUR\": 1.1627887829,\n \"LSL\": 18.3416096202,\n \"DKK\": 8.66539804,\n \"ZWD\": 472.617235893,\n \"CAD\": 1.6726041662,\n \"BGN\": 2.2742171852,\n \"MMK\": 1996.7640829066,\n \"NOK\": 13.5135633736,\n \"XBT\": 0.0003353033,\n \"SYP\": 672.6335163678,\n \"MUR\": 44.8440534065,\n \"IMP\": 1.0,\n \"GIP\": 1.0,\n \"RON\": 5.7632944865,\n \"LKR\": 376.7713047699,\n \"NGN\": 580.0683143213,\n \"CZK\": 27.656667477,\n \"CRC\": 679.5767143379,\n \"PKR\": 359.7950465233,\n \"XCD\": 3.3830911558,\n \"HTG\": 107.9925967499,\n \"ANG\": 2.3365077991,\n \"BHD\": 0.4705665609,\n \"KZT\": 560.1709379945,\n \"SZL\": 18.3416096202,\n \"SRD\": 9.7286420657,\n \"SAR\": 4.6931505407,\n \"TTD\": 8.8498934716,\n \"YER\": 326.6730498341,\n \"MVR\": 20.1703046936,\n \"AFN\": 107.2363351031,\n \"INR\": 103.0586836164,\n \"KRW\": 1608.0659639448,\n \"NPR\": 149.7756024801,\n \"AWG\": 2.3376204815,\n \"JPY\": 174.5416257632,\n \"MNT\": 3441.1249735503,\n \"PLN\": 5.1718245608,\n \"AOA\": 846.5599364606,\n \"SBD\": 10.4726324801,\n \"GBP\": 1.0,\n \"BYN\": 3.1286213808,\n \"HUF\": 429.2782537469,\n \"BIF\": 2353.1701805943,\n \"MWK\": 951.5184773993,\n \"MGA\": 4688.3032769689,\n \"XDR\": 0.9386242193,\n \"BZD\": 2.630327635,\n \"BAM\": 2.2742171852,\n \"MOP\": 10.0991140685,\n \"EGP\": 38.6741278363,\n \"NAD\": 18.3416096202,\n \"NIO\": 42.6167894155,\n \"PEN\": 4.5534926477,\n \"WST\": 3.4198275565,\n \"NZD\": 2.0421696129,\n \"TMT\": 4.5707663836,\n \"BRL\": 6.0846609662\n }\n },\n \"clickAndCollect\": false\n}","options":{"raw":{"language":"json"}}},"url":"/v1/delivery/options"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"apierror\": {\n \"status\": \"UNAUTHORIZED\",\n \"timestamp\": \"13-08-2025 05:11:39\",\n \"message\": \"Account not found for organization THG and group MYPRO1\"\n }\n}"},{"id":"24cf222b-7ab4-4729-bf94-96d088f8cc79","name":"Get Delivery Options (Failure - 500)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"destination\": {\n \"postcode\": \"cv31 3dw\",\n \"countryCode\": \"GB\"\n },\n \"deliveryOrder\": {\n \"currencyCode\": \"GBP\",\n \"deliveryOrderProducts\": [\n {\n \"productId\": \"13474675\",\n \"warehouseIds\": [\n 0,\n 31\n ],\n \"quantity\": 1,\n \"weightInGram\": 1000,\n \"price\": 40.45,\n \"hazmat\": false\n }\n ]\n },\n \"fxRates\": {\n \"baseCurrency\": \"GBP\",\n \"fxRates\": {\n \"FJD\": 2.8040962857,\n \"MXN\": 21.6335149697,\n \"TVD\": 1.8221895001,\n \"SCR\": 17.9165347784,\n \"CDF\": 2110.6207411016,\n \"GTQ\": 10.1132853368,\n \"BBD\": 2.6118664598,\n \"CLP\": 987.0094616224,\n \"UGX\": 4794.1106812318,\n \"HNL\": 31.8731231598,\n \"ZAR\": 23.227609537,\n \"TND\": 3.8884318189,\n \"STN\": 28.2982171783,\n \"CUC\": 1.2515068109,\n \"SLL\": 11323.1745466356,\n \"BSD\": 1.3059332299,\n \"SDG\": 62.2831926938,\n \"IQD\": 1638.5873623062,\n \"GMD\": 64.7122856991,\n \"CUP\": 34.6072305918,\n \"TWD\": 38.4578310551,\n \"RSD\": 136.3188087707,\n \"DOP\": 68.3195747137,\n \"KMF\": 566.5576443678,\n \"MYR\": 5.7815686392,\n \"FKP\": 1.0,\n \"XOF\": 755.4101924904,\n \"GEL\": 3.460634302,\n \"UYU\": 48.4626555406,\n \"MAD\": 12.6986591804,\n \"CVE\": 126.9886317638,\n \"TOP\": 3.0510964851,\n \"OMR\": 0.4818220141,\n \"AZN\": 2.1295701121,\n \"PGK\": 4.395433973,\n \"SEK\": 13.5390275584,\n \"KES\": 174.5793819601,\n \"CNH\": 8.8029611008,\n \"UAH\": 45.9853518038,\n \"BTN\": 93.173003098,\n \"GNF\": 11967.2484042726,\n \"MZN\": 81.78375806,\n \"ERN\": 19.5889984482,\n \"SVC\": 11.4269157614,\n \"ARS\": 308.7866210999,\n \"QAR\": 4.5554847915,\n \"IRR\": 52895.1368249697,\n \"XPD\": 0.0008837375,\n \"UZS\": 14374.1776461307,\n \"THB\": 43.3524967245,\n \"CNY\": 8.9386774516,\n \"XPF\": 137.4242738137,\n \"MRU\": 46.8259139461,\n \"BDT\": 135.5947135532,\n \"LYD\": 1.8161392992,\n \"BMD\": 1.3059332299,\n \"PHP\": 70.1897821139,\n \"KWD\": 0.3846932441,\n \"XPT\": 0.0015909828,\n \"RUB\": 104.8672709756,\n \"PYG\": 9061.3246970554,\n \"JMD\": 193.7301870961,\n \"ISK\": 173.8474600654,\n \"COP\": 5217.1395372442,\n \"USD\": 1.2515068109,\n \"MKD\": 71.6197176004,\n \"DZD\": 170.6229165408,\n \"PAB\": 1.3059332299,\n \"SGD\": 1.6812302291,\n \"GGP\": 1.0,\n \"ETB\": 37.2471561096,\n \"JEP\": 1.0,\n \"VEF\": 3434798.8035993176,\n \"VUV\": 148.6153103825,\n \"SOS\": 755.6276100704,\n \"KGS\": 91.100686759,\n \"LAK\": 11215.4118250063,\n \"BND\": 1.6812302291,\n \"XAF\": 755.4101924904,\n \"XAG\": 0.0817710658,\n \"LRD\": 210.2558854584,\n \"CHF\": 1.1370371801,\n \"HRK\": 8.5095577011,\n \"ALL\": 123.5281290686,\n \"DJF\": 232.2259221787,\n \"ZMW\": 15.5897637526,\n \"VES\": 4296.7172917618,\n \"TZS\": 3045.4315403429,\n \"VND\": 29113.6627987966,\n \"XAU\": 0.0009748375,\n \"SPL\": 0.2176555374,\n \"AUD\": 1.8532393662,\n \"ILS\": 4.5036630139,\n \"KPW\": 1175.3625206581,\n \"GYD\": 273.3444155784,\n \"GHS\": 6.871361893,\n \"BOB\": 8.6394787471,\n \"MDL\": 22.3403856628,\n \"KHR\": 5228.914655808,\n \"IDR\": 18623.2785301693,\n \"KYD\": 1.0708652515,\n \"AMD\": 483.5811361631,\n \"TRY\": 29.6219223117,\n \"SHP\": 1.0,\n \"BWP\": 13.7887256865,\n \"LBP\": 18780.4422003073,\n \"TJS\": 12.3259246182,\n \"JOD\": 0.92590666,\n \"HKD\": 9.8049651151,\n \"AED\": 4.5961587629,\n \"RWF\": 1155.0962074315,\n \"EUR\": 1.1627887829,\n \"LSL\": 18.3416096202,\n \"DKK\": 8.66539804,\n \"ZWD\": 472.617235893,\n \"CAD\": 1.6726041662,\n \"BGN\": 2.2742171852,\n \"MMK\": 1996.7640829066,\n \"NOK\": 13.5135633736,\n \"XBT\": 0.0003353033,\n \"SYP\": 672.6335163678,\n \"MUR\": 44.8440534065,\n \"IMP\": 1.0,\n \"GIP\": 1.0,\n \"RON\": 5.7632944865,\n \"LKR\": 376.7713047699,\n \"NGN\": 580.0683143213,\n \"CZK\": 27.656667477,\n \"CRC\": 679.5767143379,\n \"PKR\": 359.7950465233,\n \"XCD\": 3.3830911558,\n \"HTG\": 107.9925967499,\n \"ANG\": 2.3365077991,\n \"BHD\": 0.4705665609,\n \"KZT\": 560.1709379945,\n \"SZL\": 18.3416096202,\n \"SRD\": 9.7286420657,\n \"SAR\": 4.6931505407,\n \"TTD\": 8.8498934716,\n \"YER\": 326.6730498341,\n \"MVR\": 20.1703046936,\n \"AFN\": 107.2363351031,\n \"INR\": 103.0586836164,\n \"KRW\": 1608.0659639448,\n \"NPR\": 149.7756024801,\n \"AWG\": 2.3376204815,\n \"JPY\": 174.5416257632,\n \"MNT\": 3441.1249735503,\n \"PLN\": 5.1718245608,\n \"AOA\": 846.5599364606,\n \"SBD\": 10.4726324801,\n \"GBP\": 1.0,\n \"BYN\": 3.1286213808,\n \"HUF\": 429.2782537469,\n \"BIF\": 2353.1701805943,\n \"MWK\": 951.5184773993,\n \"MGA\": 4688.3032769689,\n \"XDR\": 0.9386242193,\n \"BZD\": 2.630327635,\n \"BAM\": 2.2742171852,\n \"MOP\": 10.0991140685,\n \"EGP\": 38.6741278363,\n \"NAD\": 18.3416096202,\n \"NIO\": 42.6167894155,\n \"PEN\": 4.5534926477,\n \"WST\": 3.4198275565,\n \"NZD\": 2.0421696129,\n \"TMT\": 4.5707663836,\n \"BRL\": 6.0846609662\n }\n },\n \"clickAndCollect\": false\n}","options":{"raw":{"language":"json"}}},"url":"/v1/delivery/options"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"apierror\": {\n \"status\": \"INTERNAL_SERVER_ERROR\",\n \"timestamp\": \"19-03-2025 11:47:40\",\n \"message\": \"Something unexpected happened\"\n }\n}"}],"_postman_id":"34214520-7017-4a2e-a52a-63ca1b252ba2"}],"id":"089dee0c-07d0-4a86-b228-eca43e171a49","_postman_id":"089dee0c-07d0-4a86-b228-eca43e171a49","description":""},{"name":"Outbound","item":[{"name":"Send Tracking Event Update","id":"06b5e9cd-900e-4fee-a9a4-54499257db60","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"oauth2","oauth2":{},"isInherited":false},"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"createdDate\": \"2026-01-10T10:30:00Z\",\n \"lastUpdateDate\": \"2026-01-13T08:30:00Z\",\n \"orderNumber\": \"123456789\",\n \"clientOrderReference\": \"CLIENTREF001\",\n \"shipmentNumber\": \"SHIP987654\",\n \"trackingNumber\": \"1Z999AA10123456784\",\n \"tracking\": true,\n \"delivered\": false,\n \"customerNotified\": true,\n \"trackingType\": \"DISPATCH\",\n \"courierService\": {\n \"id\": 42,\n \"courier\": \"UPS\",\n \"service\": \"Express Saver\"\n },\n \"events\": [\n {\n \"utcEventDate\": \"2026-01-13T08:30:00Z\",\n \"statusId\": 1,\n \"statusCode\": \"Delivered\",\n \"statusDescription\": \"The shipment has been delivered\",\n \"eventMessage\": \"Parcel handed to resident.\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/trackingEventUpdate","description":"

Tracking Event Webhook Payload

When a tracking event occurs (e.g. shipment dispatched, out for delivery, delivered), THG Ingenuity's Shipment Tracking Service sends a webhook notification to the client's specified endpoint. This document describes the payload structure and expected response. Only clients who have opted in to receive webhook notifications will receive these events.

Request

The webhook sends tracking event data to the client's endpoint via HTTP POST. The payload will only contain the tracking event which has occurred, it will not contain the full history of tracking events for the subject parcel.

Tracking Event Payload

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
createdDate	String	Yes	Timestamp when tracking was created. Format: yyyy-MM-ddTHH:mm:ssZ
lastUpdateDate	String	Yes	Timestamp when tracking was last updated. Format: yyyy-MM-ddTHH:mm:ssZ
orderNumber	String	Yes	Unique order identifier
shipmentNumber	String	Yes	Unique shipment identifier
trackingNumber	String	Yes	Courier tracking number
clientOrderReference	String	No	Client's own order reference (if supplied during tracking initialisation)
courierService	Object	Yes	Courier service details (see Courier Service Details below)
tracking	Boolean	Yes	Whether tracking is active for this shipment
delivered	Boolean	Yes	Whether the shipment has been delivered
customerNotified	Boolean	Yes	Whether the customer should be notified of new tracking events
trackingType	String	Yes	Type of tracking. Enum: \"DISPATCH\" (outbound to customer) or \"RETURN\" (return from customer)
events	Array	Yes	Tracking update. Via webhook, contains only one tracking event (see Event Details below)

Courier Service Details

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
id	Integer	Yes	THG Ingenuity internal identifier for the courier service
courier	String	Yes	Name of the courier. Example: \"Royal Mail\", \"DPD\", \"DHL\"
service	String	Yes	Name of the specific service. Example: \"Tracked 24\", \"Next Day\", \"Express\"

Event Details

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
utcEventDate	String	Yes	UTC timestamp when the event occurred. Format: yyyy-MM-ddTHH:mm:ssZ
statusId	Integer	Yes	Courier status identifier
statusCode	String	Yes	Short status code
statusDescription	String	Yes	Human-readable description of the status
eventMessage	String	Yes	Original message from the courier, as displayed on web portal

Example Request Payload

{\n  \"createdDate\": \"2026-01-10T10:30:00Z\",\n  \"lastUpdateDate\": \"2026-01-13T08:30:00Z\",\n  \"orderNumber\": \"123456789\",\n  \"clientOrderReference\": \"CLIENTREF001\",\n  \"shipmentNumber\": \"SHIP987654\",\n  \"trackingNumber\": \"1Z999AA10123456784\",\n  \"tracking\": true,\n  \"delivered\": false,\n  \"customerNotified\": true,\n  \"trackingType\": \"DISPATCH\",\n  \"courierService\": {\n    \"id\": 42,\n    \"courier\": \"UPS\",\n    \"service\": \"Express Saver\"\n  },\n  \"events\": [\n    {\n      \"utcEventDate\": \"2026-01-13T08:30:00Z\",\n      \"statusId\": 1,\n      \"statusCode\": \"Delivered\",\n      \"statusDescription\": \"The shipment has been delivered\",\n      \"eventMessage\": \"Parcel handed to resident.\"\n    }\n  ]\n}\n\n

Response

Expected Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Requirement	Description
Success	Any HTTP 2xx status code indicates successful receipt of the webhook
Response Body	No specific response body format is required for 2xx response. Any other status code should have a descriptive response body.

Example Response (200 OK)

{\n    \"status\": \"received\"\n}\n\n

An empty response body with HTTP 200 is also acceptable.

Example Response (4xx Error)

{\n    \"error\": \"Order not found in client system\",\n    \"code\": \"ORDER_NOT_FOUND\"\n}\n\n

Example Response (5xx Error)

{\n    \"error\": \"Database temporarily unavailable\",\n    \"code\": \"INTERNAL_SERVER_ERROR\"\n}\n\n

\n","urlObject":{"path":["trackingEventUpdate"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"3576e099-2ed5-4410-b25e-61bc2cb7a7bf","name":"Outbound Webhook (Success)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"createdDate\": \"2026-01-10T10:30:00Z\",\n \"lastUpdateDate\": \"2026-01-13T08:30:00Z\",\n \"orderNumber\": \"123456789\",\n \"clientOrderReference\": \"CLIENTREF001\",\n \"shipmentNumber\": \"SHIP987654\",\n \"trackingNumber\": \"1Z999AA10123456784\",\n \"tracking\": true,\n \"delivered\": false,\n \"customerNotified\": true,\n \"trackingType\": \"DISPATCH\",\n \"courierService\": {\n \"id\": 42,\n \"courier\": \"UPS\",\n \"service\": \"Express Saver\"\n },\n \"events\": [\n {\n \"utcEventDate\": \"2026-01-13T08:30:00Z\",\n \"statusId\": 1,\n \"statusCode\": \"Delivered\",\n \"statusDescription\": \"The shipment has been delivered\",\n \"eventMessage\": \"Parcel handed to resident.\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"Client tracking endpoint"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"status\": \"received\"\n}"},{"id":"3e72d75a-a1a9-4b28-a9bb-7b08e3ec8461","name":"Outbound Webhook (Failure - 400)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"createdDate\": \"2026-01-10T10:30:00Z\",\n \"lastUpdateDate\": \"2026-01-13T08:30:00Z\",\n \"orderNumber\": \"BAD_ORDER_NUMBER\",\n \"clientOrderReference\": \"CLIENTREF001\",\n \"shipmentNumber\": \"SHIP987654\",\n \"trackingNumber\": \"1Z999AA10123456784\",\n \"tracking\": true,\n \"delivered\": false,\n \"customerNotified\": true,\n \"trackingType\": \"DISPATCH\",\n \"courierService\": {\n \"id\": 42,\n \"courier\": \"UPS\",\n \"service\": \"Express Saver\"\n },\n \"events\": [\n {\n \"utcEventDate\": \"2026-01-13T08:30:00Z\",\n \"statusId\": 1,\n \"statusCode\": \"Delivered\",\n \"statusDescription\": \"The shipment has been delivered\",\n \"eventMessage\": \"Parcel handed to resident.\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"Client tracking endpoint"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Order not found in client system\",\n \"code\": \"ORDER_NOT_FOUND\"\n}"},{"id":"f5d91053-277f-4655-bd44-152e80a1b062","name":"Outbound Webhook (Failure - 500)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"createdDate\": \"2026-01-10T10:30:00Z\",\n \"lastUpdateDate\": \"2026-01-13T08:30:00Z\",\n \"orderNumber\": \"123456789\",\n \"clientOrderReference\": \"CLIENTREF001\",\n \"shipmentNumber\": \"SHIP987654\",\n \"trackingNumber\": \"1Z999AA10123456784\",\n \"tracking\": true,\n \"delivered\": false,\n \"customerNotified\": true,\n \"trackingType\": \"DISPATCH\",\n \"courierService\": {\n \"id\": 42,\n \"courier\": \"UPS\",\n \"service\": \"Express Saver\"\n },\n \"events\": [\n {\n \"utcEventDate\": \"2026-01-13T08:30:00Z\",\n \"statusId\": 1,\n \"statusCode\": \"Delivered\",\n \"statusDescription\": \"The shipment has been delivered\",\n \"eventMessage\": \"Parcel handed to resident.\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"Client tracking endpoint"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"error\": \"Database temporarily unavailable\",\n \"code\": \"INTERNAL_SERVER_ERROR\"\n}"}],"_postman_id":"06b5e9cd-900e-4fee-a9a4-54499257db60"}],"id":"f00fccbd-74fb-48de-a7c7-0cb1a33dc3f5","_postman_id":"f00fccbd-74fb-48de-a7c7-0cb1a33dc3f5","description":""}],"id":"2f250b24-39f2-4c4e-be5c-76b9c967978e","_postman_id":"2f250b24-39f2-4c4e-be5c-76b9c967978e","description":""},{"name":"ECRM","item":[{"name":"Check the status of a job","id":"83744b7d-00a5-4481-8a64-968ff0f42d42","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v1/ecrm/jobStatus/{{jobId}}","description":"

Check the status of a job

PATH PARAMETERS

jobId: string

Job Id to retrieve the status of, job ids are returned to you when you call the opt-in or opt-out endpoints

Examples: fb6217b3-9c4d-40f3-9e33-15cbe0f3c47b

RESPONSE

200

Success retrieving job status by job id

{\n\"info\": {\n\"emails_opted_in\": \"1\",\n\"total_emails_in_request\": \"1\"\n},\n\"jobId\": \"fb6217b3-9c4d-40f3-9e33-15cbe0f3c47b\",\n\"job_type\": \"OPT_IN\",\n\"state\": \"COMPLETED\"\n}\n\n

400

Bad request, please check you are supplying a job id in the path

404

Could not find job with provided job id

500

Unknown error, please contact us for support

\n","urlObject":{"path":["v1","ecrm","jobStatus","{{jobId}}"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"83744b7d-00a5-4481-8a64-968ff0f42d42"},{"name":"Import and opt-in a list of email addresses to marketing emails","id":"2ff94387-e965-4649-93e9-c1e4c7eb5087","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/v1/ecrm/optIn/{{locale}}","description":"

REQUEST

locale: string
Locale specifying the subsite to opt the customers in to

QUERY-STRING PARAMETERS

opt-in-time int64
Optional query parameter, specifying milliseconds since epoch when the opt-ins occured, the current time is used if not provided
Examples: 1635256115757

REQUEST BODY application/json
Json request body with the list of email addresses to opt-in, a maximum of 1000 emails may be supplied

JSON SCHEMA

{\n  \"emails\": [\n    \"example@thehugroup.com\",\n    \"example2@thehugroup.com\"\n  ]\n}\n\n

RESPONSE

200

fb6217b3-9c4d-40f3-9e33-15cbe0f3c47b\n\n

400

Bad request, please check you are supplying a json body with the correct format and a maximum of 1000 customer IDs with exactly one of the booleans set to true.

500

Unknown error, please contact us for support

\n","urlObject":{"path":["v1","ecrm","optIn","{{locale}}"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"2ff94387-e965-4649-93e9-c1e4c7eb5087"},{"name":"Import and opt-out a list of email addresses to marketing emails","id":"f98f704f-6e1e-4d74-ab6c-37b6a43f2325","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/v1/ecrm/optOut/{{locale}}","description":"

REQUEST

locale: string

Locale specifying the subsite you are logging in to, currently it will opt out matching email addresses from any locale

QUERY-STRING PARAMETERS

opt0out-time int64
Optional query parameter, specifying milliseconds since epoch when the opt-outs occured, the current time is used if not provided
Examples: 1635256115757

REQUEST BODY application/json
Json request body with the list of email addresses to opt-out, a maximum of 1000 emails may be supplied

JSON SCHEMA

{\n  \"emails\": [\n    \"example@thehugroup.com\",\n    \"example2@thehugroup.com\"\n  ]\n}\n\n

RESPONSE

200

fb6217b3-9c4d-40f3-9e33-15cbe0f3c47b\n\n

400

Bad request, please check you are supplying a json body with the correct format and a maximum of 1000 customer IDs with exactly one of the booleans set to true.

500

Unknown error, please contact us for support

\n","urlObject":{"path":["v1","ecrm","optOut","{{locale}}"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"f98f704f-6e1e-4d74-ab6c-37b6a43f2325"},{"name":"Import and opt-out a list of customers from marketing (To be implemented)","id":"78e0ff90-c705-42e0-8691-e139f1c0eb9f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/v2/ecrm/optOut/{{locale}}","description":"

PARAMETERS

locale: string
Locale specifying the subsite you are logging in to, currently it will opt out matching email addresses from any locale

REQUEST BODY

Json request body with the list of THG customer IDs to opt-out, a maximum of 1000 customer IDs may be supplied, and the following booleans, one of which should be set to true. The flag set to true will opt out the user from this communication type. Flags passed in as false will result in no operation for that communication type. isSms and isPostal are to be implemented.

isEmail,\nisSms,\nisPostal\n\n

JSON SCHEMA

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n    \"customerIds\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"customerId\": {\n              \"type\": \"string\"\n          },\n          \"required\": [\n              \"customerId\"\n          ]\n        }\n      ]\n    }\n  },\n  \"isEmail\": {\n      \"type\": \"boolean\"\n  },\n  \"isSms\": {\n      \"type\": \"boolean\"\n  },\n  \"isPostal\": {\n      \"type\": \"boolean\"\n  },\n  \"required\": [\n    \"customerIds\",\n    \"isEmail\",\n    \"isSms\",\n    \"isPostal\"\n  ]\n}\n\n

RESPONSE

200

fb6217b3-9c4d-40f3-9e33-15cbe0f3c47b\n\n

400

Bad request, please check you are supplying a json body with the correct format and a maximum of 1000 customer IDs with exactly one of the booleans set to true.

500

Unknown error, please contact us for support

\n","urlObject":{"path":["v2","ecrm","optOut","{{locale}}"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"78e0ff90-c705-42e0-8691-e139f1c0eb9f"}],"id":"31508e5e-8c6d-46bd-87d0-4d8e1d01682d","_postman_id":"31508e5e-8c6d-46bd-87d0-4d8e1d01682d","description":""},{"name":"Offers and Promotions","item":[{"name":"Create offer ref: OFF.I.01","id":"8349de32-56a1-4bf4-b8b6-d997b70bcc3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"externalId\": \"Abbb-g344-g44\",\r\n \"siteId\": 9999,\r\n \"name\": \"TEST OFFER - % DISCOUNT, NO MARKETING, NO DISCOUNT CODES\",\r\n \"endTimestamp\": 1626191562000,\r\n \"trigger\": {\r\n \"discountCodes\": []\r\n },\r\n \"calculator\": {\r\n \"maxDiscountAmount\": {\r\n \"GBP\": 500.0,\r\n \"EUR\": 600.0\r\n },\r\n \"productGroups\": [\r\n {\r\n \"groupId\": 1,\r\n \"selectionType\": \"PRODUCT_IDS\",\r\n \"selectionIdentifier\": [\r\n \"1000001\",\r\n \"1000002\"\r\n ],\r\n \"exclusive\": false\r\n }\r\n ],\r\n \"tiers\": [\r\n {\r\n \"requiredProds\": [\r\n {\r\n \"productGroupId\": 1,\r\n \"numberOfProducts\": 2\r\n }\r\n ],\r\n \"discount\": {\r\n \"discountType\": \"PERCENTAGE\",\r\n \"percentage\": 30,\r\n \"discountAgainstRRP\": false\r\n }\r\n }\r\n ]\r\n },\r\n \"enabledLocales\": [\r\n \"en_GB\"\r\n ],\r\n \"localisations\": {\r\n \"en_GB\": {\r\n \"message\": \"Offer has applied\"\r\n }\r\n },\r\n \"maxRedemptions\": 100,\r\n \"exclusivity\": \"NORMAL\",\r\n \"basketExclusive\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"/v1/offer","description":"

This will create a new offer

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Response Code	Meaning
200	Offer has been created
400	There was some validation errors, response body will include validation errors
409	External offerID in use for your site
500	Any other server error

Offer Json Schema

{\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n  \"title\": \"offer\",\n  \"description\": \"The representation of a special offer\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"externalId\": {\n      \"type\": \"string\"\n    },\n    \"siteId\": {\n      \"type\": \"integer\"\n    },\n    \"name\": {\n      \"type\": \"string\"\n    },\n    \"startTimestamp\": {\n      \"type\": \"integer\",\n      \"description\": \"ms since the unix epoch, if null offer will start immediately\"\n    },\n    \"endTimestamp\": {\n      \"type\": \"integer\",\n      \"description\": \"ms since the unix epoch\"\n    },\n    \"disabled\": {\n      \"type\": \"boolean\"\n    },\n    \"enabledLocales\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"$ref\": \"#/definitions/locale\"\n      },\n      \"minItems\": 1,\n      \"uniqueItems\": true,\n      \"description\": \"This only allows valid locales for the requested site\"\n    },\n    \"maxRedemptions\": {\n      \"type\": \"integer\",\n      \"description\": \"If null the offer can be redeemed unlimited times\"\n    },\n    \"exclusivity\": {\n      \"type\": \"string\",\n      \"enum\": [\n        \"OVERRIDE\",\n        \"NORMAL\",\n        \"EXCLUSIVE\"\n      ]\n    },\n    \"basketExclusive\": {\n      \"type\": \"boolean\"\n    },\n    \"trigger\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"discountCodes\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"code\": {\n                \"type\": \"string\"\n              },\n              \"publishable\": {\n                \"type\": \"boolean\"\n              }\n            }\n          },\n          \"minItems\": 0,\n          \"uniqueItems\": true\n        }\n      },\n      \"calculator\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"productGroups\": {\n            \"type\": \"array\",\n            \"items\": {\n              \"$ref\": \"#/definitions/productGroup\"\n            }\n          },\n          \"discountableProducts\": {\n            \"type\": \"object\",\n            \"properties\": {},\n            \"required\": [\n              \"productGroupId\",\n              \"discountQuantity\"\n            ]\n          },\n          \"maxDiscountAmount\": {\n            \"$ref\": \"#/definitions/currencyToAmountMap\"\n          },\n          \"tiers\": {\n            \"type\": \"array\",\n            \"items\": {\n              \"$ref\": \"#/definitions/tier\"\n            }\n          }\n        },\n        \"required\": [\n          \"productGroups\",\n          \"tiers\"\n        ]\n      },\n      \"localisations\": {\n        \"type\": \"object\",\n        \"minProperties\": 1,\n        \"propertyNames\": {\n          \"pattern\": \"^[a-z]{2}_[A-Z]{2}$\"\n        },\n        \"additionalProperties\": {\n          \"$ref\": \"#/definitions/localisation\"\n        },\n        \"description\": \"This requires an entry for all locales listed in offer.enabledLocales\"\n      }\n    }\n  },\n  \"definitions\": {\n    \"locale\": {\n      \"type\": \"string\",\n      \"pattern\": \"^[a-z]{2}_[A-Z]{2}$\"\n    },\n    \"localisation\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"message\": {\n          \"type\": \"string\"\n        },\n        \"marketing\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"publishable\": {\n              \"type\": \"boolean\"\n            },\n            \"displayPaps\": {\n              \"type\": \"boolean\"\n            },\n            \"weighting\": {\n              \"type\": \"integer\",\n              \"minimum\": 1,\n              \"maximum\": 100\n            },\n            \"title\": {\n              \"type\": \"string\"\n            },\n            \"description\": {\n              \"type\": \"string\"\n            },\n            \"linkUrl\": {\n              \"type\": \"string\"\n            },\n            \"linkText\": {\n              \"type\": \"string\"\n            }\n          },\n          \"required\": [\n            \"publishable\",\n            \"displayPaps\",\n            \"weighting\",\n            \"title\",\n            \"description\",\n            \"linkUrl\",\n            \"linkText\"\n          ]\n        }\n      },\n      \"required\": [\n        \"message\"\n      ]\n    },\n    \"productGroup\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"groupId\": {\n          \"type\": \"integer\"\n        },\n        \"selectionType\": {\n          \"type\": \"string\",\n          \"enum\": [\n            \"All\",\n            \"PRODUCT_IDS\"\n          ]\n        },\n        \"selectionIdentifiers\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"string\"\n          }\n        },\n        \"exclusive\": {\n          \"type\": \"boolean\"\n        }\n      },\n      \"required\": [\n        \"groupId\",\n        \"selectionType\",\n        \"selectionIdentifier\",\n        \"exclusive\"\n      ]\n    },\n    \"currencyToAmountMap\": {\n      \"type\": \"object\",\n      \"minProperties\": 1,\n      \"propertyNames\": {\n        \"pattern\": \"^[A-Z]{3}$\"\n      },\n      \"additionalProperties\": {\n        \"type\": \"number\"\n      }\n    },\n    \"tier\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"requiredProds\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"productGroupId\": {\n                \"type\": \"integer\"\n              },\n              \"numberOfProducts\": {\n                \"type\": \"integer\"\n              },\n              \"minSpend\": {\n                \"$ref\": \"#/definitions/currencyToAmountMap\"\n              }\n            },\n            \"required\": [\n              \"productGroupId\"\n            ]\n          }\n        },\n        \"discount\": {\n          \"oneOf\": [\n            {\n              \"$ref\": \"#/definitions/fixedPriceDiscount\"\n            },\n            {\n              \"$ref\": \"#/definitions/percentageDiscount\"\n            },\n            {\n              \"$ref\": \"#/definitions/flatDiscount\"\n            }\n          ]\n        }\n      },\n      \"required\": [\n        \"requiredProds\",\n        \"discount\"\n      ]\n    },\n    \"fixedPriceDiscount\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"discountType\": {\n          \"type\": \"string\",\n          \"enum\": [\n            \"FIXED_PRICE\"\n          ]\n        },\n        \"fixedPrice\": {\n          \"$ref\": \"#/definitions/currencyToAmountMap\"\n        },\n        \"productGroupId\": {\n          \"type\": \"integer\"\n        },\n        \"discountQuantity\": {\n          \"type\": \"integer\"\n        }\n      },\n      \"required\": [\n        \"discountType\",\n        \"fixedPrice\"\n      ]\n    },\n    \"percentageDiscount\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"discountType\": {\n          \"type\": \"string\",\n          \"enum\": [\n            \"PERCENTAGE\"\n          ]\n        },\n        \"percentage\": {\n          \"type\": \"number\"\n        },\n        \"discountAgainstRRP\": {\n          \"type\": \"boolean\"\n        },\n        \"productGroupId\": {\n          \"type\": \"integer\"\n        },\n        \"discountQuantity\": {\n          \"type\": \"integer\"\n        }\n      },\n      \"required\": [\n        \"discountType\",\n        \"percentage\",\n        \"discountAgainstRRP\"\n      ]\n    },\n    \"flatDiscount\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"discountType\": {\n          \"type\": \"string\",\n          \"enum\": [\n            \"FLAT\"\n          ]\n        },\n        \"discountAmount\": {\n          \"$ref\": \"#/definitions/currencyToAmountMap\"\n        },\n        \"productGroupId\": {\n          \"type\": \"integer\"\n        },\n        \"discountQuantity\": {\n          \"type\": \"integer\"\n        }\n      },\n      \"required\": [\n        \"discountType\",\n        \"discountAmount\"\n      ]\n    }\n  },\n  \"required\": [\n    \"siteId\",\n    \"name\",\n    \"endTimestamp\",\n    \"enabledLocales\",\n    \"basketExclusive\",\n    \"exclusivity\",\n    \"trigger\",\n    \"localisations\"\n  ]\n}\n\n

Sample

{\n    \"externalId\": \"Abbb-g344-g44\",\n    \"siteId\": 9999,\n    \"name\": \"TEST OFFER - % DISCOUNT, NO MARKETING, NO DISCOUNT CODES\",\n    \"endTimestamp\": 1626191562000,\n    \"trigger\": {\n        \"discountCodes\": []\n    },\n    \"calculator\": {\n        \"maxDiscountAmount\": {\n            \"GBP\": 500.0,\n            \"EUR\": 600.0\n        },\n        \"productGroups\": [\n            {\n                \"groupId\": 1,\n                \"selectionType\": \"PRODUCT_IDS\",\n                \"selectionIdentifier\": [\n                    \"1000001\",\n                    \"1000002\"\n                ],\n                \"exclusive\": false\n            }\n        ],\n        \"tiers\": [\n            {\n                \"requiredProds\": [\n                    {\n                        \"productGroupId\": 1,\n                        \"numberOfProducts\": 2\n                    }\n                ],\n                \"discount\": {\n                    \"discountType\": \"PERCENTAGE\",\n                    \"percentage\": 30,\n                    \"discountAgainstRRP\": false\n                }\n            }\n        ]\n    },\n    \"enabledLocales\": [\n        \"en_GB\"\n    ],\n    \"localisations\": {\n        \"en_GB\": {\n            \"message\": \"Offer has applied\"\n        }\n    },\n    \"maxRedemptions\": 100,\n    \"exclusivity\": \"NORMAL\",\n    \"basketExclusive\": false\n}\n\n

\n","urlObject":{"path":["v1","offer"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"8349de32-56a1-4bf4-b8b6-d997b70bcc3d"},{"name":"Update offer ref: OFF.I.02","id":"8b6be5b5-82f5-49ca-a752-062794635c99","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"externalId\": \"Abbb-g344-g44\",\r\n \"siteId\": 9999,\r\n \"name\": \"TEST OFFER - % DISCOUNT, NO MARKETING, NO DISCOUNT CODES\",\r\n \"endTimestamp\": 1626191562000,\r\n \"trigger\": {\r\n \"discountCodes\": []\r\n },\r\n \"calculator\": {\r\n \"maxDiscountAmount\": {\r\n \"GBP\": 500.0,\r\n \"EUR\": 600.0\r\n },\r\n \"productGroups\": [\r\n {\r\n \"groupId\": 1,\r\n \"selectionType\": \"PRODUCT_IDS\",\r\n \"selectionIdentifier\": [\r\n \"1000001\",\r\n \"1000002\"\r\n ],\r\n \"exclusive\": false\r\n }\r\n ],\r\n \"tiers\": [\r\n {\r\n \"requiredProds\": [\r\n {\r\n \"productGroupId\": 1,\r\n \"numberOfProducts\": 2\r\n }\r\n ],\r\n \"discount\": {\r\n \"discountType\": \"PERCENTAGE\",\r\n \"percentage\": 30,\r\n \"discountAgainstRRP\": false\r\n }\r\n }\r\n ]\r\n },\r\n \"enabledLocales\": [\r\n \"en_GB\"\r\n ],\r\n \"localisations\": {\r\n \"en_GB\": {\r\n \"message\": \"Offer has applied\"\r\n }\r\n },\r\n \"maxRedemptions\": 100,\r\n \"exclusivity\": \"NORMAL\",\r\n \"basketExclusive\": false\r\n}","options":{"raw":{"language":"json"}}},"url":"/v1/offer/{{offerId}}","description":"

This will create a new offer

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Response Code	Meaning
200	Offer has been updated
400	There was some validation errors, response body will include validation errors
404	Offer not found
500	Any other server error

Offer Json Schema

{\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n  \"title\": \"offer\",\n  \"description\": \"The representation of a special offer\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"offerId\": {\n      \"type\": \"integer\"\n    },\n    \"externalId\": {\n      \"type\": \"string\"\n    },\n    \"siteId\": {\n      \"type\": \"integer\"\n    },\n    \"name\": {\n      \"type\": \"string\"\n    },\n    \"startTimestamp\": {\n      \"type\": \"integer\",\n      \"description\": \"ms since the unix epoch, if null offer will start immediately\"\n    },\n    \"endTimestamp\": {\n      \"type\": \"integer\",\n      \"description\": \"ms since the unix epoch\"\n    },\n    \"disabled\": {\n      \"type\": \"boolean\"\n    },\n    \"enabledLocales\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"$ref\": \"#/definitions/locale\"\n      },\n      \"minItems\": 1,\n      \"uniqueItems\": true,\n      \"description\": \"This only allows valid locales for the requested site\"\n    },\n    \"maxRedemptions\": {\n      \"type\": \"integer\",\n      \"description\": \"If null the offer can be redeemed unlimited times\"\n    },\n    \"exclusivity\": {\n      \"type\": \"string\",\n      \"enum\": [\n        \"OVERRIDE\",\n        \"NORMAL\",\n        \"EXCLUSIVE\"\n      ]\n    },\n    \"basketExclusive\": {\n      \"type\": \"boolean\"\n    },\n    \"trigger\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"discountCodes\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"code\": {\n                \"type\": \"string\"\n              },\n              \"publishable\": {\n                \"type\": \"boolean\"\n              }\n            }\n          },\n          \"minItems\": 0,\n          \"uniqueItems\": true\n        }\n      },\n      \"calculator\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"productGroups\": {\n            \"type\": \"array\",\n            \"items\": {\n              \"$ref\": \"#/definitions/productGroup\"\n            }\n          },\n          \"discountableProducts\": {\n            \"type\": \"object\",\n            \"properties\": {},\n            \"required\": [\n              \"productGroupId\",\n              \"discountQuantity\"\n            ]\n          },\n          \"maxDiscountAmount\": {\n            \"$ref\": \"#/definitions/currencyToAmountMap\"\n          },\n          \"tiers\": {\n            \"type\": \"array\",\n            \"items\": {\n              \"$ref\": \"#/definitions/tier\"\n            }\n          }\n        },\n        \"required\": [\n          \"productGroups\",\n          \"tiers\"\n        ]\n      },\n      \"localisations\": {\n        \"type\": \"object\",\n        \"minProperties\": 1,\n        \"propertyNames\": {\n          \"pattern\": \"^[a-z]{2}_[A-Z]{2}$\"\n        },\n        \"additionalProperties\": {\n          \"$ref\": \"#/definitions/localisation\"\n        },\n        \"description\": \"This requires an entry for all locales listed in offer.enabledLocales\"\n      }\n    }\n  },\n  \"definitions\": {\n    \"locale\": {\n      \"type\": \"string\",\n      \"pattern\": \"^[a-z]{2}_[A-Z]{2}$\"\n    },\n    \"localisation\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"message\": {\n          \"type\": \"string\"\n        },\n        \"marketing\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"publishable\": {\n              \"type\": \"boolean\"\n            },\n            \"displayPaps\": {\n              \"type\": \"boolean\"\n            },\n            \"weighting\": {\n              \"type\": \"integer\",\n              \"minimum\": 1,\n              \"maximum\": 100\n            },\n            \"title\": {\n              \"type\": \"string\"\n            },\n            \"description\": {\n              \"type\": \"string\"\n            },\n            \"linkUrl\": {\n              \"type\": \"string\"\n            },\n            \"linkText\": {\n              \"type\": \"string\"\n            }\n          },\n          \"required\": [\n            \"publishable\",\n            \"displayPaps\",\n            \"weighting\",\n            \"title\",\n            \"description\",\n            \"linkUrl\",\n            \"linkText\"\n          ]\n        }\n      },\n      \"required\": [\n        \"message\"\n      ]\n    },\n    \"productGroup\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"groupId\": {\n          \"type\": \"integer\"\n        },\n        \"selectionType\": {\n          \"type\": \"string\",\n          \"enum\": [\n            \"All\",\n            \"PRODUCT_IDS\"\n          ]\n        },\n        \"selectionIdentifiers\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"string\"\n          }\n        },\n        \"exclusive\": {\n          \"type\": \"boolean\"\n        }\n      },\n      \"required\": [\n        \"groupId\",\n        \"selectionType\",\n        \"selectionIdentifier\",\n        \"exclusive\"\n      ]\n    },\n    \"currencyToAmountMap\": {\n      \"type\": \"object\",\n      \"minProperties\": 1,\n      \"propertyNames\": {\n        \"pattern\": \"^[A-Z]{3}$\"\n      },\n      \"additionalProperties\": {\n        \"type\": \"number\"\n      }\n    },\n    \"tier\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"requiredProds\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"productGroupId\": {\n                \"type\": \"integer\"\n              },\n              \"numberOfProducts\": {\n                \"type\": \"integer\"\n              },\n              \"minSpend\": {\n                \"$ref\": \"#/definitions/currencyToAmountMap\"\n              }\n            },\n            \"required\": [\n              \"productGroupId\"\n            ]\n          }\n        },\n        \"discount\": {\n          \"oneOf\": [\n            {\n              \"$ref\": \"#/definitions/fixedPriceDiscount\"\n            },\n            {\n              \"$ref\": \"#/definitions/percentageDiscount\"\n            },\n            {\n              \"$ref\": \"#/definitions/flatDiscount\"\n            }\n          ]\n        }\n      },\n      \"required\": [\n        \"requiredProds\",\n        \"discount\"\n      ]\n    },\n    \"fixedPriceDiscount\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"discountType\": {\n          \"type\": \"string\",\n          \"enum\": [\n            \"FIXED_PRICE\"\n          ]\n        },\n        \"fixedPrice\": {\n          \"$ref\": \"#/definitions/currencyToAmountMap\"\n        },\n        \"productGroupId\": {\n          \"type\": \"integer\"\n        },\n        \"discountQuantity\": {\n          \"type\": \"integer\"\n        }\n      },\n      \"required\": [\n        \"discountType\",\n        \"fixedPrice\"\n      ]\n    },\n    \"percentageDiscount\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"discountType\": {\n          \"type\": \"string\",\n          \"enum\": [\n            \"PERCENTAGE\"\n          ]\n        },\n        \"percentage\": {\n          \"type\": \"number\"\n        },\n        \"discountAgainstRRP\": {\n          \"type\": \"boolean\"\n        },\n        \"productGroupId\": {\n          \"type\": \"integer\"\n        },\n        \"discountQuantity\": {\n          \"type\": \"integer\"\n        }\n      },\n      \"required\": [\n        \"discountType\",\n        \"percentage\",\n        \"discountAgainstRRP\"\n      ]\n    },\n    \"flatDiscount\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"discountType\": {\n          \"type\": \"string\",\n          \"enum\": [\n            \"FLAT\"\n          ]\n        },\n        \"discountAmount\": {\n          \"$ref\": \"#/definitions/currencyToAmountMap\"\n        },\n        \"productGroupId\": {\n          \"type\": \"integer\"\n        },\n        \"discountQuantity\": {\n          \"type\": \"integer\"\n        }\n      },\n      \"required\": [\n        \"discountType\",\n        \"discountAmount\"\n      ]\n    }\n  },\n  \"required\": [\n    \"siteId\",\n    \"name\",\n    \"endTimestamp\",\n    \"enabledLocales\",\n    \"basketExclusive\",\n    \"exclusivity\",\n    \"trigger\",\n    \"localisations\",\n    \"offerId\"\n  ]\n}\n\n

Sample

{\n    \"externalId\": \"Abbb-g344-g44\",\n    \"siteId\": 9999,\n    \"name\": \"TEST OFFER - % DISCOUNT, NO MARKETING, NO DISCOUNT CODES\",\n    \"endTimestamp\": 1626191562000,\n    \"trigger\": {\n        \"discountCodes\": []\n    },\n    \"calculator\": {\n        \"maxDiscountAmount\": {\n            \"GBP\": 500.0,\n            \"EUR\": 600.0\n        },\n        \"productGroups\": [\n            {\n                \"groupId\": 1,\n                \"selectionType\": \"PRODUCT_IDS\",\n                \"selectionIdentifier\": [\n                    \"1000001\",\n                    \"1000002\"\n                ],\n                \"exclusive\": false\n            }\n        ],\n        \"tiers\": [\n            {\n                \"requiredProds\": [\n                    {\n                        \"productGroupId\": 1,\n                        \"numberOfProducts\": 2\n                    }\n                ],\n                \"discount\": {\n                    \"discountType\": \"PERCENTAGE\",\n                    \"percentage\": 30,\n                    \"discountAgainstRRP\": false\n                }\n            }\n        ]\n    },\n    \"enabledLocales\": [\n        \"en_GB\"\n    ],\n    \"localisations\": {\n        \"en_GB\": {\n            \"message\": \"Offer has applied\"\n        }\n    },\n    \"maxRedemptions\": 100,\n    \"exclusivity\": \"NORMAL\",\n    \"basketExclusive\": false\n}\n\n

\n","urlObject":{"path":["v1","offer","{{offerId}}"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"8b6be5b5-82f5-49ca-a752-062794635c99"},{"name":"Load offer details ref: OFF.I.03","id":"5d6be5d5-e46a-4e78-9ba6-c9efe1985647","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v1/offer/{{offerId}}","description":"

NOTE THAT THIS ENDPOINT CAN ONLY RETURN DETAILS ON AN OFFER CREATED THROUGH THE API

This will return the details of an offer acording to the schema.

OfferId is an Integer.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Response Code	Meaning
200	Offer has been returned
400	Vaidation error
404	Offer not found
500	Any other server error

Offer Json Schema

{\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n  \"title\": \"offer\",\n  \"description\": \"The representation of a special offer\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"offerId\": {\n      \"type\": \"integer\"\n    },\n    \"externalId\": {\n      \"type\": \"string\"\n    },\n    \"siteId\": {\n      \"type\": \"integer\"\n    },\n    \"name\": {\n      \"type\": \"string\"\n    },\n    \"startTimestamp\": {\n      \"type\": \"integer\",\n      \"description\": \"ms since the unix epoch, if null offer will start immediately\"\n    },\n    \"endTimestamp\": {\n      \"type\": \"integer\",\n      \"description\": \"ms since the unix epoch\"\n    },\n    \"disabled\" : {\n        \"type\": \"boolean\"\n    },\n    \"enabledLocales\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"$ref\": \"#/definitions/locale\"\n      },\n      \"minItems\": 1,\n      \"uniqueItems\": true,\n      \"description\": \"This only allows valid locales for the requested site\"\n    },\n    \"maxRedemptions\": {\n      \"type\": \"integer\",\n      \"description\": \"If null the offer can be redeemed unlimited times\"\n    },\n    \"exclusivity\": {\n      \"type\": \"string\",\n      \"enum\": [\n        \"OVERRIDE\",\n        \"NORMAL\",\n        \"EXCLUSIVE\"\n      ]\n    },\n    \"basketExclusive\": {\n      \"type\": \"boolean\"\n    },\n    \"trigger\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"discountCodes\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"code\": {\n                \"type\": \"string\"\n              },\n              \"publishable\": {\n                \"type\": \"boolean\"\n              }\n            }\n          },\n          \"minItems\": 0,\n          \"uniqueItems\": true\n        },\n        \"usesPromoCodes\": {\n          \"type\": \"boolean\",\n          \"default\": \"false\"\n        },\n        \"customerLists\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"integer\"\n          }\n        },\n        \"areCustomerListsExclusive\": {\n          \"type\": \"boolean\"\n        },\n        \"isLoyalyExclusive\": {\n          \"type\": \"boolean\"\n        },\n        \"isFirstOrder\": {\n          \"type\": \"boolean\"\n        },\n        \"customerReferralAward\": {\n          \"$ref\": \"#/definitions/currencyToAmountMap\"\n        },\n        \"offerChannel\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"string\",\n            \"enum\": [\n              \"ONLINE\",\n              \"APP\",\n              \"STORE\"\n            ]\n          }\n        }\n      }\n    },\n    \"calculator\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"productGroups\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"$ref\": \"#/definitions/productGroup\"\n          }\n        },\n        \"discountableProducts\": {\n          \"type\": \"object\",\n          \"properties\": {},\n          \"required\": [\n            \"productGroupId\",\n            \"discountQuantity\"\n          ]\n        },\n        \"maxDiscountAmount\": {\n          \"$ref\": \"#/definitions/currencyToAmountMap\"\n        },\n        \"tiers\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"$ref\": \"#/definitions/tier\"\n          }\n        }\n      },\n      \"required\": [\n        \"productGroups\",\n        \"tiers\"\n      ]\n    },\n    \"localisations\": {\n      \"type\": \"object\",\n      \"minProperties\": 1,\n      \"propertyNames\": {\n        \"pattern\": \"^[a-z]{2}_[A-Z]{2}$\"\n      },\n      \"additionalProperties\": {\n        \"$ref\": \"#/definitions/localisation\"\n      },\n      \"description\": \"This requires an entry for all locales listed in offer.enabledLocales\"\n    }\n  },\n  \"definitions\": {\n    \"locale\": {\n      \"type\": \"string\",\n      \"pattern\": \"^[a-z]{2}_[A-Z]{2}$\"\n    },\n    \"localisation\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"message\": {\n          \"type\": \"string\"\n        },\n        \"marketing\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"publishable\": {\n              \"type\": \"boolean\"\n            },\n            \"displayPaps\": {\n              \"type\": \"boolean\"\n            },\n            \"weighting\": {\n              \"type\": \"integer\",\n              \"minimum\": 1,\n              \"maximum\": 100\n            },\n            \"title\": {\n              \"type\": \"string\"\n            },\n            \"description\": {\n              \"type\": \"string\"\n            },\n            \"linkUrl\": {\n              \"type\": \"string\"\n            },\n            \"linkText\": {\n              \"type\": \"string\"\n            }\n          },\n          \"required\": [\n            \"publishable\",\n            \"displayPaps\",\n            \"weighting\",\n            \"title\",\n            \"description\",\n            \"linkUrl\",\n            \"linkText\"\n          ]\n        }\n      },\n      \"required\": [\n        \"message\"\n      ]\n    },\n    \"productGroup\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"groupId\": {\n          \"type\": \"integer\"\n        },\n        \"selectionType\": {\n          \"type\": \"string\",\n          \"enum\": [\n            \"All\",\n            \"PRODUCT_IDS\"\n          ]\n        },\n        \"selectionIdentifiers\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"string\"\n          }\n        },\n        \"exclusive\": {\n          \"type\": \"boolean\"\n        }\n      },\n      \"required\": [\n        \"groupId\",\n        \"selectionType\",\n        \"selectionIdentifier\",\n        \"exclusive\"\n      ]\n    },\n    \"currencyToAmountMap\": {\n      \"type\": \"object\",\n      \"minProperties\": 1,\n      \"propertyNames\": {\n        \"pattern\": \"^[A-Z]{3}$\"\n      },\n      \"additionalProperties\": {\n        \"type\": \"number\"\n      }\n    },\n    \"tier\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"requiredProds\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"productGroupId\": {\n                \"type\": \"integer\"\n              },\n              \"numberOfProducts\": {\n                \"type\": \"integer\"\n              },\n              \"minSpend\": {\n                \"$ref\": \"#/definitions/currencyToAmountMap\"\n              }\n            },\n            \"required\": [\n              \"productGroupId\"\n            ]\n          }\n        },\n        \"discount\": {\n          \"oneOf\": [\n            {\n              \"$ref\": \"#/definitions/fixedPriceDiscount\"\n            },\n            {\n              \"$ref\": \"#/definitions/percentageDiscount\"\n            },\n            {\n              \"$ref\": \"#/definitions/flatDiscount\"\n            },\n            {\n              \"$ref\": \"#/definitions/freeGift\"\n            }\n          ]\n        }\n      },\n      \"required\": [\n        \"requiredProds\",\n        \"discount\"\n      ]\n    },\n    \"fixedPriceDiscount\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"discountType\": {\n          \"type\": \"string\",\n          \"enum\": [\n            \"FIXED_PRICE\"\n          ]\n        },\n        \"fixedPrice\": {\n          \"$ref\": \"#/definitions/currencyToAmountMap\"\n        },\n        \"productGroupId\": {\n          \"type\": \"integer\"\n        },\n        \"discountQuantity\": {\n          \"type\": \"integer\"\n        }\n      },\n      \"required\": [\n        \"discountType\",\n        \"fixedPrice\"\n      ]\n    },\n    \"percentageDiscount\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"discountType\": {\n          \"type\": \"string\",\n          \"enum\": [\n            \"PERCENTAGE\"\n          ]\n        },\n        \"percentage\": {\n          \"type\": \"number\"\n        },\n        \"discountAgainstRRP\": {\n          \"type\": \"boolean\"\n        },\n        \"productGroupId\": {\n          \"type\": \"integer\"\n        },\n        \"discountQuantity\": {\n          \"type\": \"integer\"\n        }\n      },\n      \"required\": [\n        \"discountType\",\n        \"percentage\",\n        \"discountAgainstRRP\"\n      ]\n    },\n    \"flatDiscount\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"discountType\": {\n          \"type\": \"string\",\n          \"enum\": [\n            \"FLAT\"\n          ]\n        },\n        \"discountAmount\": {\n          \"$ref\": \"#/definitions/currencyToAmountMap\"\n        },\n        \"productGroupId\": {\n          \"type\": \"integer\"\n        },\n        \"discountQuantity\": {\n          \"type\": \"integer\"\n        }\n      },\n      \"required\": [\n        \"discountType\",\n        \"discountAmount\"\n      ]\n    },\n    \"freeGift\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"discountType\": {\n          \"type\": \"string\",\n          \"enum\": [\n            \"FREE_GIFT\"\n          ]\n        },\n        \"freeGifts\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"string\"\n          }\n        },\n        \"autoAddToBasket\": {\n          \"type\": \"boolean\"\n        },\n        \"selectionQuantity\": {\n          \"type\": \"integer\"\n        },\n        \"selectionDisplayQuantity\": {\n          \"type\": \"integer\"\n        }\n      },\n      \"required\": [\n        \"freeGifts\",\n        \"autoAddToBasket\"\n      ]\n    }\n  },\n  \"required\": [\n    \"siteId\",\n    \"name\",\n    \"endTimestamp\",\n    \"enabledLocales\",\n    \"basketExclusive\",\n    \"exclusivity\",\n    \"trigger\",\n    \"localisations\",\n    \"offerId\"\n  ]\n}\n\n

Sample

{\n  \"externalId\": \"Abbb-g344-g44\",\n  \"siteId\": 9999,\n  \"name\": \"TEST OFFER - % DISCOUNT, buy 2 items in group 1 the products in group 2 50% off\",\n  \"endTimestamp\": 1626191562000,\n  \"trigger\": {\n    \"discountCodes\": []\n  },\n  \"calculator\": {\n    \"maxDiscountAmount\": {\n      \"GBP\": 500.0,\n      \"EUR\": 600.0\n    },\n    \"productGroups\": [{\n        \"groupId\": 1,\n        \"selectionType\": \"PRODUCT_IDS\",\n        \"selectionIdentifier\": [\"1000001\", \"1000002\"],\n        \"exclusive\": false\n      }, {\n        \"groupId\": 2,\n        \"selectionType\": \"PRODUCT_IDS\",\n        \"selectionIdentifier\": [\"2200001\", \"2200002\"],\n        \"exclusive\": false\n      }\n    ],\n    \"tiers\": [{\n        \"requiredProds\": [{\n            \"productGroupId\": 1,\n            \"numberOfProducts\": 2\n          }\n        ],\n        \"discount\": {\n          \"discountType\": \"PERCENTAGE\",\n          \"percentage\": 50,\n          \"discountAgainstRRP\": false,\n          \"productGroupId\": 2\n        }\n      }\n    ]\n  },\n  \"enabledLocales\": [\"en_GB\"],\n  \"localisations\": {\n    \"en_GB\": {\n      \"message\": \"Offer has applied\"\n    }\n  },\n  \"maxRedemptions\": 100,\n  \"exclusivity\": \"NORMAL\",\n  \"basketExclusive\": false\n}\n\n

\n","urlObject":{"path":["v1","offer","{{offerId}}"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"5d6be5d5-e46a-4e78-9ba6-c9efe1985647"},{"name":"Load offer details by externalId ref: OFF.I.04","id":"2d1ca1ad-83a2-4d54-97d0-ec3970f82a38","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v1/offer/{{externalOfferId}}","description":"

**NOTE THAT THIS ENDPOINT CAN ONLY RETURN DETAILS ON AN OFFER CREATED THROUGH THE API
**

This will return the details of an offer acording to the schema.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Response Code	Meaning
200	Offer has been returned
400	Vaidation error
404	Offer not found
500	Any other server error

Offer Json Schema

{\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n  \"title\": \"offer\",\n  \"description\": \"The representation of a special offer\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"offerId\": {\n      \"type\": \"integer\"\n    },\n    \"externalId\": {\n      \"type\": \"string\"\n    },\n    \"siteId\": {\n      \"type\": \"integer\"\n    },\n    \"name\": {\n      \"type\": \"string\"\n    },\n    \"startTimestamp\": {\n      \"type\": \"integer\",\n      \"description\": \"ms since the unix epoch, if null offer will start immediately\"\n    },\n    \"endTimestamp\": {\n      \"type\": \"integer\",\n      \"description\": \"ms since the unix epoch\"\n    },\n    \"disabled\" : {\n        \"type\": \"boolean\"\n    },\n    \"enabledLocales\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"$ref\": \"#/definitions/locale\"\n      },\n      \"minItems\": 1,\n      \"uniqueItems\": true,\n      \"description\": \"This only allows valid locales for the requested site\"\n    },\n    \"maxRedemptions\": {\n      \"type\": \"integer\",\n      \"description\": \"If null the offer can be redeemed unlimited times\"\n    },\n    \"exclusivity\": {\n      \"type\": \"string\",\n      \"enum\": [\n        \"OVERRIDE\",\n        \"NORMAL\",\n        \"EXCLUSIVE\"\n      ]\n    },\n    \"basketExclusive\": {\n      \"type\": \"boolean\"\n    },\n    \"trigger\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"discountCodes\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"code\": {\n                \"type\": \"string\"\n              },\n              \"publishable\": {\n                \"type\": \"boolean\"\n              }\n            }\n          },\n          \"minItems\": 0,\n          \"uniqueItems\": true\n        },\n        \"usesPromoCodes\": {\n          \"type\": \"boolean\",\n          \"default\": \"false\"\n        },\n        \"customerLists\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"integer\"\n          }\n        },\n        \"areCustomerListsExclusive\": {\n          \"type\": \"boolean\"\n        },\n        \"isLoyalyExclusive\": {\n          \"type\": \"boolean\"\n        },\n        \"isFirstOrder\": {\n          \"type\": \"boolean\"\n        },\n        \"customerReferralAward\": {\n          \"$ref\": \"#/definitions/currencyToAmountMap\"\n        },\n        \"offerChannel\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"string\",\n            \"enum\": [\n              \"ONLINE\",\n              \"APP\",\n              \"STORE\"\n            ]\n          }\n        }\n      }\n    },\n    \"calculator\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"productGroups\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"$ref\": \"#/definitions/productGroup\"\n          }\n        },\n        \"discountableProducts\": {\n          \"type\": \"object\",\n          \"properties\": {},\n          \"required\": [\n            \"productGroupId\",\n            \"discountQuantity\"\n          ]\n        },\n        \"maxDiscountAmount\": {\n          \"$ref\": \"#/definitions/currencyToAmountMap\"\n        },\n        \"tiers\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"$ref\": \"#/definitions/tier\"\n          }\n        }\n      },\n      \"required\": [\n        \"productGroups\",\n        \"tiers\"\n      ]\n    },\n    \"localisations\": {\n      \"type\": \"object\",\n      \"minProperties\": 1,\n      \"propertyNames\": {\n        \"pattern\": \"^[a-z]{2}_[A-Z]{2}$\"\n      },\n      \"additionalProperties\": {\n        \"$ref\": \"#/definitions/localisation\"\n      },\n      \"description\": \"This requires an entry for all locales listed in offer.enabledLocales\"\n    }\n  },\n  \"definitions\": {\n    \"locale\": {\n      \"type\": \"string\",\n      \"pattern\": \"^[a-z]{2}_[A-Z]{2}$\"\n    },\n    \"localisation\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"message\": {\n          \"type\": \"string\"\n        },\n        \"marketing\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"publishable\": {\n              \"type\": \"boolean\"\n            },\n            \"displayPaps\": {\n              \"type\": \"boolean\"\n            },\n            \"weighting\": {\n              \"type\": \"integer\",\n              \"minimum\": 1,\n              \"maximum\": 100\n            },\n            \"title\": {\n              \"type\": \"string\"\n            },\n            \"description\": {\n              \"type\": \"string\"\n            },\n            \"linkUrl\": {\n              \"type\": \"string\"\n            },\n            \"linkText\": {\n              \"type\": \"string\"\n            }\n          },\n          \"required\": [\n            \"publishable\",\n            \"displayPaps\",\n            \"weighting\",\n            \"title\",\n            \"description\",\n            \"linkUrl\",\n            \"linkText\"\n          ]\n        }\n      },\n      \"required\": [\n        \"message\"\n      ]\n    },\n    \"productGroup\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"groupId\": {\n          \"type\": \"integer\"\n        },\n        \"selectionType\": {\n          \"type\": \"string\",\n          \"enum\": [\n            \"All\",\n            \"PRODUCT_IDS\"\n          ]\n        },\n        \"selectionIdentifiers\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"string\"\n          }\n        },\n        \"exclusive\": {\n          \"type\": \"boolean\"\n        }\n      },\n      \"required\": [\n        \"groupId\",\n        \"selectionType\",\n        \"selectionIdentifier\",\n        \"exclusive\"\n      ]\n    },\n    \"currencyToAmountMap\": {\n      \"type\": \"object\",\n      \"minProperties\": 1,\n      \"propertyNames\": {\n        \"pattern\": \"^[A-Z]{3}$\"\n      },\n      \"additionalProperties\": {\n        \"type\": \"number\"\n      }\n    },\n    \"tier\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"requiredProds\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"productGroupId\": {\n                \"type\": \"integer\"\n              },\n              \"numberOfProducts\": {\n                \"type\": \"integer\"\n              },\n              \"minSpend\": {\n                \"$ref\": \"#/definitions/currencyToAmountMap\"\n              }\n            },\n            \"required\": [\n              \"productGroupId\"\n            ]\n          }\n        },\n        \"discount\": {\n          \"oneOf\": [\n            {\n              \"$ref\": \"#/definitions/fixedPriceDiscount\"\n            },\n            {\n              \"$ref\": \"#/definitions/percentageDiscount\"\n            },\n            {\n              \"$ref\": \"#/definitions/flatDiscount\"\n            },\n            {\n              \"$ref\": \"#/definitions/freeGift\"\n            }\n          ]\n        }\n      },\n      \"required\": [\n        \"requiredProds\",\n        \"discount\"\n      ]\n    },\n    \"fixedPriceDiscount\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"discountType\": {\n          \"type\": \"string\",\n          \"enum\": [\n            \"FIXED_PRICE\"\n          ]\n        },\n        \"fixedPrice\": {\n          \"$ref\": \"#/definitions/currencyToAmountMap\"\n        },\n        \"productGroupId\": {\n          \"type\": \"integer\"\n        },\n        \"discountQuantity\": {\n          \"type\": \"integer\"\n        }\n      },\n      \"required\": [\n        \"discountType\",\n        \"fixedPrice\"\n      ]\n    },\n    \"percentageDiscount\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"discountType\": {\n          \"type\": \"string\",\n          \"enum\": [\n            \"PERCENTAGE\"\n          ]\n        },\n        \"percentage\": {\n          \"type\": \"number\"\n        },\n        \"discountAgainstRRP\": {\n          \"type\": \"boolean\"\n        },\n        \"productGroupId\": {\n          \"type\": \"integer\"\n        },\n        \"discountQuantity\": {\n          \"type\": \"integer\"\n        }\n      },\n      \"required\": [\n        \"discountType\",\n        \"percentage\",\n        \"discountAgainstRRP\"\n      ]\n    },\n    \"flatDiscount\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"discountType\": {\n          \"type\": \"string\",\n          \"enum\": [\n            \"FLAT\"\n          ]\n        },\n        \"discountAmount\": {\n          \"$ref\": \"#/definitions/currencyToAmountMap\"\n        },\n        \"productGroupId\": {\n          \"type\": \"integer\"\n        },\n        \"discountQuantity\": {\n          \"type\": \"integer\"\n        }\n      },\n      \"required\": [\n        \"discountType\",\n        \"discountAmount\"\n      ]\n    },\n    \"freeGift\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"discountType\": {\n          \"type\": \"string\",\n          \"enum\": [\n            \"FREE_GIFT\"\n          ]\n        },\n        \"freeGifts\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"string\"\n          }\n        },\n        \"autoAddToBasket\": {\n          \"type\": \"boolean\"\n        },\n        \"selectionQuantity\": {\n          \"type\": \"integer\"\n        },\n        \"selectionDisplayQuantity\": {\n          \"type\": \"integer\"\n        }\n      },\n      \"required\": [\n        \"freeGifts\",\n        \"autoAddToBasket\"\n      ]\n    }\n  },\n  \"required\": [\n    \"siteId\",\n    \"name\",\n    \"endTimestamp\",\n    \"enabledLocales\",\n    \"basketExclusive\",\n    \"exclusivity\",\n    \"trigger\",\n    \"localisations\",\n    \"offerId\"\n  ]\n}\n\n

Sample

{\n  \"externalId\": \"Abbb-g344-g44\",\n  \"siteId\": 9999,\n  \"name\": \"TEST OFFER - % DISCOUNT, buy 2 items in group 1 the products in group 2 50% off\",\n  \"endTimestamp\": 1626191562000,\n  \"trigger\": {\n    \"discountCodes\": []\n  },\n  \"calculator\": {\n    \"maxDiscountAmount\": {\n      \"GBP\": 500.0,\n      \"EUR\": 600.0\n    },\n    \"productGroups\": [{\n        \"groupId\": 1,\n        \"selectionType\": \"PRODUCT_IDS\",\n        \"selectionIdentifier\": [\"1000001\", \"1000002\"],\n        \"exclusive\": false\n      }, {\n        \"groupId\": 2,\n        \"selectionType\": \"PRODUCT_IDS\",\n        \"selectionIdentifier\": [\"2200001\", \"2200002\"],\n        \"exclusive\": false\n      }\n    ],\n    \"tiers\": [{\n        \"requiredProds\": [{\n            \"productGroupId\": 1,\n            \"numberOfProducts\": 2\n          }\n        ],\n        \"discount\": {\n          \"discountType\": \"PERCENTAGE\",\n          \"percentage\": 50,\n          \"discountAgainstRRP\": false,\n          \"productGroupId\": 2\n        }\n      }\n    ]\n  },\n  \"enabledLocales\": [\"en_GB\"],\n  \"localisations\": {\n    \"en_GB\": {\n      \"message\": \"Offer has applied\"\n    }\n  },\n  \"maxRedemptions\": 100,\n  \"exclusivity\": \"NORMAL\",\n  \"basketExclusive\": false\n}\n\n

\n","urlObject":{"path":["v1","offer","{{externalOfferId}}"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"2d1ca1ad-83a2-4d54-97d0-ec3970f82a38"},{"name":"Load offer details for a locale ref: OFF.I.05","id":"b432c780-1a25-4ee1-b312-40ee7dc14e51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v1/offer?locale={{locale}}","description":"

This will return the details of an offer acording to the schema.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Response Code	Meaning
200	Offers has been returned
400	Vaidation error
500	Any other server error

Offer Json Schema

{\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n  \"title\": \"offer\",\n  \"description\": \"The representation of a special offer\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"offerId\": {\n      \"type\": \"integer\"\n    },\n    \"externalId\": {\n      \"type\": \"string\"\n    },\n    \"siteId\": {\n      \"type\": \"integer\"\n    },\n    \"name\": {\n      \"type\": \"string\"\n    },\n    \"startTimestamp\": {\n      \"type\": \"integer\",\n      \"description\": \"ms since the unix epoch, if null offer will start immediately\"\n    },\n    \"endTimestamp\": {\n      \"type\": \"integer\",\n      \"description\": \"ms since the unix epoch\"\n    },\n    \"disabled\" : {\n        \"type\": \"boolean\"\n    },\n    \"enabledLocales\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"$ref\": \"#/definitions/locale\"\n      },\n      \"minItems\": 1,\n      \"uniqueItems\": true,\n      \"description\": \"This only allows valid locales for the requested site\"\n    },\n    \"maxRedemptions\": {\n      \"type\": \"integer\",\n      \"description\": \"If null the offer can be redeemed unlimited times\"\n    },\n    \"exclusivity\": {\n      \"type\": \"string\",\n      \"enum\": [\n        \"OVERRIDE\",\n        \"NORMAL\",\n        \"EXCLUSIVE\"\n      ]\n    },\n    \"basketExclusive\": {\n      \"type\": \"boolean\"\n    },\n    \"trigger\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"discountCodes\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"code\": {\n                \"type\": \"string\"\n              },\n              \"publishable\": {\n                \"type\": \"boolean\"\n              }\n            }\n          },\n          \"minItems\": 0,\n          \"uniqueItems\": true\n        },\n        \"usesPromoCodes\": {\n          \"type\": \"boolean\",\n          \"default\": \"false\"\n        },\n        \"customerLists\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"integer\"\n          }\n        },\n        \"areCustomerListsExclusive\": {\n          \"type\": \"boolean\"\n        },\n        \"isLoyalyExclusive\": {\n          \"type\": \"boolean\"\n        },\n        \"isFirstOrder\": {\n          \"type\": \"boolean\"\n        },\n        \"customerReferralAward\": {\n          \"$ref\": \"#/definitions/currencyToAmountMap\"\n        },\n        \"offerChannel\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"string\",\n            \"enum\": [\n              \"ONLINE\",\n              \"APP\",\n              \"STORE\"\n            ]\n          }\n        }\n      }\n    },\n    \"calculator\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"productGroups\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"$ref\": \"#/definitions/productGroup\"\n          }\n        },\n        \"discountableProducts\": {\n          \"type\": \"object\",\n          \"properties\": {},\n          \"required\": [\n            \"productGroupId\",\n            \"discountQuantity\"\n          ]\n        },\n        \"maxDiscountAmount\": {\n          \"$ref\": \"#/definitions/currencyToAmountMap\"\n        },\n        \"tiers\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"$ref\": \"#/definitions/tier\"\n          }\n        }\n      },\n      \"required\": [\n        \"productGroups\",\n        \"tiers\"\n      ]\n    },\n    \"localisations\": {\n      \"type\": \"object\",\n      \"minProperties\": 1,\n      \"propertyNames\": {\n        \"pattern\": \"^[a-z]{2}_[A-Z]{2}$\"\n      },\n      \"additionalProperties\": {\n        \"$ref\": \"#/definitions/localisation\"\n      },\n      \"description\": \"This requires an entry for all locales listed in offer.enabledLocales\"\n    }\n  },\n  \"definitions\": {\n    \"locale\": {\n      \"type\": \"string\",\n      \"pattern\": \"^[a-z]{2}_[A-Z]{2}$\"\n    },\n    \"localisation\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"message\": {\n          \"type\": \"string\"\n        },\n        \"marketing\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"publishable\": {\n              \"type\": \"boolean\"\n            },\n            \"displayPaps\": {\n              \"type\": \"boolean\"\n            },\n            \"weighting\": {\n              \"type\": \"integer\",\n              \"minimum\": 1,\n              \"maximum\": 100\n            },\n            \"title\": {\n              \"type\": \"string\"\n            },\n            \"description\": {\n              \"type\": \"string\"\n            },\n            \"linkUrl\": {\n              \"type\": \"string\"\n            },\n            \"linkText\": {\n              \"type\": \"string\"\n            }\n          },\n          \"required\": [\n            \"publishable\",\n            \"displayPaps\",\n            \"weighting\",\n            \"title\",\n            \"description\",\n            \"linkUrl\",\n            \"linkText\"\n          ]\n        }\n      },\n      \"required\": [\n        \"message\"\n      ]\n    },\n    \"productGroup\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"groupId\": {\n          \"type\": \"integer\"\n        },\n        \"selectionType\": {\n          \"type\": \"string\",\n          \"enum\": [\n            \"All\",\n            \"PRODUCT_IDS\"\n          ]\n        },\n        \"selectionIdentifiers\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"string\"\n          }\n        },\n        \"exclusive\": {\n          \"type\": \"boolean\"\n        }\n      },\n      \"required\": [\n        \"groupId\",\n        \"selectionType\",\n        \"selectionIdentifier\",\n        \"exclusive\"\n      ]\n    },\n    \"currencyToAmountMap\": {\n      \"type\": \"object\",\n      \"minProperties\": 1,\n      \"propertyNames\": {\n        \"pattern\": \"^[A-Z]{3}$\"\n      },\n      \"additionalProperties\": {\n        \"type\": \"number\"\n      }\n    },\n    \"tier\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"requiredProds\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"object\",\n            \"properties\": {\n              \"productGroupId\": {\n                \"type\": \"integer\"\n              },\n              \"numberOfProducts\": {\n                \"type\": \"integer\"\n              },\n              \"minSpend\": {\n                \"$ref\": \"#/definitions/currencyToAmountMap\"\n              }\n            },\n            \"required\": [\n              \"productGroupId\"\n            ]\n          }\n        },\n        \"discount\": {\n          \"oneOf\": [\n            {\n              \"$ref\": \"#/definitions/fixedPriceDiscount\"\n            },\n            {\n              \"$ref\": \"#/definitions/percentageDiscount\"\n            },\n            {\n              \"$ref\": \"#/definitions/flatDiscount\"\n            },\n            {\n              \"$ref\": \"#/definitions/freeGift\"\n            }\n          ]\n        }\n      },\n      \"required\": [\n        \"requiredProds\",\n        \"discount\"\n      ]\n    },\n    \"fixedPriceDiscount\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"discountType\": {\n          \"type\": \"string\",\n          \"enum\": [\n            \"FIXED_PRICE\"\n          ]\n        },\n        \"fixedPrice\": {\n          \"$ref\": \"#/definitions/currencyToAmountMap\"\n        },\n        \"productGroupId\": {\n          \"type\": \"integer\"\n        },\n        \"discountQuantity\": {\n          \"type\": \"integer\"\n        }\n      },\n      \"required\": [\n        \"discountType\",\n        \"fixedPrice\"\n      ]\n    },\n    \"percentageDiscount\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"discountType\": {\n          \"type\": \"string\",\n          \"enum\": [\n            \"PERCENTAGE\"\n          ]\n        },\n        \"percentage\": {\n          \"type\": \"number\"\n        },\n        \"discountAgainstRRP\": {\n          \"type\": \"boolean\"\n        },\n        \"productGroupId\": {\n          \"type\": \"integer\"\n        },\n        \"discountQuantity\": {\n          \"type\": \"integer\"\n        }\n      },\n      \"required\": [\n        \"discountType\",\n        \"percentage\",\n        \"discountAgainstRRP\"\n      ]\n    },\n    \"flatDiscount\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"discountType\": {\n          \"type\": \"string\",\n          \"enum\": [\n            \"FLAT\"\n          ]\n        },\n        \"discountAmount\": {\n          \"$ref\": \"#/definitions/currencyToAmountMap\"\n        },\n        \"productGroupId\": {\n          \"type\": \"integer\"\n        },\n        \"discountQuantity\": {\n          \"type\": \"integer\"\n        }\n      },\n      \"required\": [\n        \"discountType\",\n        \"discountAmount\"\n      ]\n    },\n    \"freeGift\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"discountType\": {\n          \"type\": \"string\",\n          \"enum\": [\n            \"FREE_GIFT\"\n          ]\n        },\n        \"freeGifts\": {\n          \"type\": \"array\",\n          \"items\": {\n            \"type\": \"string\"\n          }\n        },\n        \"autoAddToBasket\": {\n          \"type\": \"boolean\"\n        },\n        \"selectionQuantity\": {\n          \"type\": \"integer\"\n        },\n        \"selectionDisplayQuantity\": {\n          \"type\": \"integer\"\n        }\n      },\n      \"required\": [\n        \"freeGifts\",\n        \"autoAddToBasket\"\n      ]\n    }\n  },\n  \"required\": [\n    \"siteId\",\n    \"name\",\n    \"endTimestamp\",\n    \"enabledLocales\",\n    \"basketExclusive\",\n    \"exclusivity\",\n    \"trigger\",\n    \"localisations\",\n    \"offerId\"\n  ]\n}\n\n

Sample

{\n  \"externalId\": \"Abbb-g344-g44\",\n  \"siteId\": 9999,\n  \"name\": \"TEST OFFER - % DISCOUNT, buy 2 items in group 1 the products in group 2 50% off\",\n  \"endTimestamp\": 1626191562000,\n  \"trigger\": {\n    \"discountCodes\": []\n  },\n  \"calculator\": {\n    \"maxDiscountAmount\": {\n      \"GBP\": 500.0,\n      \"EUR\": 600.0\n    },\n    \"productGroups\": [{\n        \"groupId\": 1,\n        \"selectionType\": \"PRODUCT_IDS\",\n        \"selectionIdentifier\": [\"1000001\", \"1000002\"],\n        \"exclusive\": false\n      }, {\n        \"groupId\": 2,\n        \"selectionType\": \"PRODUCT_IDS\",\n        \"selectionIdentifier\": [\"2200001\", \"2200002\"],\n        \"exclusive\": false\n      }\n    ],\n    \"tiers\": [{\n        \"requiredProds\": [{\n            \"productGroupId\": 1,\n            \"numberOfProducts\": 2\n          }\n        ],\n        \"discount\": {\n          \"discountType\": \"PERCENTAGE\",\n          \"percentage\": 50,\n          \"discountAgainstRRP\": false,\n          \"productGroupId\": 2\n        }\n      }\n    ]\n  },\n  \"enabledLocales\": [\"en_GB\"],\n  \"localisations\": {\n    \"en_GB\": {\n      \"message\": \"Offer has applied\"\n    }\n  },\n  \"maxRedemptions\": 100,\n  \"exclusivity\": \"NORMAL\",\n  \"basketExclusive\": false\n}\n\n

\n","urlObject":{"path":["v1","offer"],"host":[""],"query":[{"description":{"content":"

required, e.g. en_GB

\n","type":"text/plain"},"key":"locale","value":"{{locale}}"}],"variable":[]}},"response":[],"_postman_id":"b432c780-1a25-4ee1-b312-40ee7dc14e51"},{"name":"Load promotion codes for an Offer ref: OFF.I.06","id":"c1cd218e-dcff-49ab-ac04-feec40dbd37a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v1/offer/{{offerId}}/promotionCodes?removedUsed=false","description":"

This will return the list of promotions avaiable on an Offer, by default this will include use promotions codes used in the THG system

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Response Code	Meaning
200	Codes have been returned
404	Offer not found
500	Any other server error

Promotion code Schema

{\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n  \"title\": \"offer\",\n  \"description\": \"The representation of promo codes\",\n  \"type\": \"array\",\n  \"items\": {\n    \"$ref\": \"#/definitions/promotionCode\"\n  },\n  \"definitions\": {\n    \"promotionCode\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"used\": {\n          \"type\": \"boolean\"\n        },\n        \"promotionCode\": {\n          \"type\": \"string\"\n        }\n      },\n      \"required\": [\n        \"used\",\n        \"promotionCode\"\n      ]\n    }\n  }\n}\n\n

Sample

[\n    {\n        \"used\": true,\n        \"promotionCode\": \"CQ654-U5YA-PFGC\"\n    },\n    {\n        \"used\": false,\n        \"promotionCode\": \"L9L2U-YRLX-7C1R\"\n    },\n    {\n        \"used\": false,\n        \"promotionCode\": \"OSFM0-IDQ9-904W\"\n    }\n]\n\n

\n","urlObject":{"path":["v1","offer","{{offerId}}","promotionCodes"],"host":[""],"query":[{"description":{"content":"

Optional - Defaults false

\n","type":"text/plain"},"key":"removedUsed","value":"false"}],"variable":[]}},"response":[],"_postman_id":"c1cd218e-dcff-49ab-ac04-feec40dbd37a"},{"name":"Load summaries for all offers: OFF.I.08","id":"a77ee6ce-ccb8-4d33-b7d7-c393a5ec48b0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v1/offer/summary?onlyActive=false&expiryCutoff=2022-11-04","description":"

This will return the list of all summaries on the requested site. This will return details for offers not created though the API

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Query Parameter	Required	Value
onlyActive	false	If set to true will only display offers that haven't expired
expiryCutoff	false	If set to a date will only display offers that expired on that day or after. e.g. If set to 2022-11-04 will display all offers that expired after 2022-11-04 00:00:00

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Response Code	Meaning
200	summaries have been returned
500	Any other server error

Promotion code Schema

{\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n  \"title\": \"offerSummaries\",\n  \"description\": \"The representation of Offer Summary\",\n  \"type\": \"array\",\n  \"items\": {\n    \"$ref\": \"#/definitions/offerSummary\"\n  },\n  \"definitions\": {\n    \"offerSummary\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"offerId\": {\n          \"type\": \"integer\"\n        },\n        \"externalId\": {\n          \"type\": \"string\"\n        },\n        \"siteId\": {\n          \"type\": \"integer\"\n        },\n        \"name\": {\n          \"type\": \"string\"\n        },\n        \"startTimestamp\": {\n          \"type\": \"integer\",\n          \"description\": \"ms since the unix epoch\"\n        },\n        \"endTimestamp\": {\n          \"type\": \"integer\",\n          \"description\": \"ms since the unix epoch\"\n        },\n        \"createdTimestamp\": {\n          \"type\": \"integer\",\n          \"description\": \"ms since the unix epoch\"\n        },\n        \"customerSpecificOffer\": {\n          \"type\": \"boolean\",\n          \"description\": \"True if the offer only applies to a customer list\"\n        },\n        \"requiresCode\": {\n          \"type\": \"boolean\",\n          \"description\": \"True if the offer uses a discount or promotion code\"\n        }\n      },\n      \"required\": [\n        \"offerId\",\n        \"siteId\",\n        \"name\",\n        \"startTimestamp\",\n        \"endTimestamp\",\n        \"createdTimestamp\",\n        \"customerSpecificOffer\",\n        \"requiresCode\"\n      ]\n    }\n  }\n}\n\n

Sample

[\n  {\n    \"offerId\": 123,\n    \"siteId\": 66,\n    \"name\": \"TEST OFFER 1\",\n    \"startTimestamp\": 1663632000000,\n    \"endTimestamp\": 1666224000000,\n    \"createdTimestamp\": 1663632000000,\n    \"customerSpecificOffer\": false,\n    \"requiresCode\": true\n  },\n  {\n    \"offerId\": 124,\n    \"externalId\": \"EXT-2\",\n    \"siteId\": 66,\n    \"name\": \"TEST OFFER 2\",\n    \"startTimestamp\": 1663632000000,\n    \"endTimestamp\": 1666224000000,\n    \"createdTimestamp\": 1663632000000,\n    \"customerSpecificOffer\": true,\n    \"requiresCode\": true\n  }\n]\n\n

\n","urlObject":{"path":["v1","offer","summary"],"host":[""],"query":[{"key":"onlyActive","value":"false"},{"key":"expiryCutoff","value":"2022-11-04"}],"variable":[]}},"response":[],"_postman_id":"a77ee6ce-ccb8-4d33-b7d7-c393a5ec48b0"},{"name":"Load summary for single offer: OFF.I.09","id":"e5f84944-8a59-4f20-87f4-3766ba5947dc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v1/offer/{{offerId}}/summary","description":"

This will return the list of the summary on the requested offer. This will return details for offers not created though the API

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Response Code	Meaning
200	summaries have been returned
404	Offer was not found
500	Any other server error

Promotion code Schema

{\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n  \"title\": \"offerSummary\",\n  \"description\": \"The representation of Offer Summary\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"offerId\": {\n      \"type\": \"integer\"\n    },\n    \"externalId\": {\n      \"type\": \"string\"\n    },\n    \"siteId\": {\n      \"type\": \"integer\"\n    },\n    \"name\": {\n      \"type\": \"string\"\n    },\n    \"startTimestamp\": {\n      \"type\": \"integer\",\n      \"description\": \"ms since the unix epoch\"\n    },\n    \"endTimestamp\": {\n      \"type\": \"integer\",\n      \"description\": \"ms since the unix epoch\"\n    },\n    \"createdTimestamp\": {\n      \"type\": \"integer\",\n      \"description\": \"ms since the unix epoch\"\n    },\n    \"customerSpecificOffer\": {\n      \"type\": \"boolean\",\n      \"description\": \"True if the offer only applies to a customer list\"\n    },\n    \"requiresCode\": {\n      \"type\": \"boolean\",\n      \"description\": \"True if the offer uses a discount or promotion code\"\n    }\n  },\n  \"required\": [\n    \"offerId\",\n    \"siteId\",\n    \"name\",\n    \"startTimestamp\",\n    \"endTimestamp\",\n    \"createdTimestamp\",\n    \"customerSpecificOffer\",\n    \"requiresCode\"\n  ]\n}\n\n

Sample

  {\n    \"offerId\": 123,\n    \"siteId\": 66,\n    \"name\": \"TEST OFFER 1\",\n    \"startTimestamp\": 1663632000000,\n    \"endTimestamp\": 1666224000000,\n    \"createdTimestamp\": 1663632000000,\n    \"customerSpecificOffer\": false,\n    \"requiresCode\": true\n  }\n\n

\n","urlObject":{"path":["v1","offer","{{offerId}}","summary"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"e5f84944-8a59-4f20-87f4-3766ba5947dc"},{"name":"Assign Codes to a customer for a Reward Wallet Offer: OFF.I.10","id":"c014d2ee-04e3-4e2f-a72a-b4d2fbc3f63c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"customerId\": 12345,\r\n \"visibleStartDate\": 1670400000,\r\n \"visibleEndDate\": 1670500000,\r\n \"advertisedStartDate\": 1670450000,\r\n \"onlineCode\": \"AB-42\",\r\n \"storeCode\": \"1223344132131\",\r\n \"storeCodeType\": \"UPC\"\r\n },\r\n {\r\n \"customerId\": 67789,\r\n \"visibleStartDate\": 1670400000,\r\n \"onlineCode\": \"CW-9\"\r\n },\r\n {\r\n \"customerId\": 787687,\r\n \"storeCode\": \"534534534543534534\",\r\n \"storeCodeType\": \"UPC\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"/v1/offer/wallet/{{offerId}}/customer","description":"

This will asgin cutomers to promotion codes for a reward wallter offer. If the visableStartDate is set to null then the code will appear in the reward wallet according to the display setting of the offer.

The advertisedStartDate will override the offer start date that is displayed in the reward wallet entry.

NOTE: This assignment is purely for display in a rewards wallet and won't affect redemptions

NOTE: You can only asign upto 10K codes per request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Response Code	Meaning
200	summaries have been returned
403	Offer is on a diffrent site than the login details allow
404	Offer was not found
500	Any other server error

Promotion code Schema

{\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n  \"title\": \"codeAssignment\",\n  \"description\": \"The representation of Code Assignment\",\n  \"type\": \"array\",\n  \"minItems\": 1,\n  \"maxItems\": 10000,\n  \"items\": {\n    \"$ref\": \"#/definitions/customerAssignment\"\n  },\n  \"definitions\": {\n    \"customerAssignment\": {\n      \"type\": \"object\",\n      \"anyOf\": [\n        {\n          \"required\": [\n            \"onlineCode\"\n          ]\n        },\n        {\n          \"required\": [\n            \"storeCode\",\n            \"storeCodeType\"\n          ]\n        }\n      ],\n      \"properties\": {\n        \"customerId\": {\n          \"type\": \"integer\"\n        },\n        \"visibleStartDate\": {\n          \"type\": \"integer\",\n          \"description\": \"ms since the unix epoch\"\n        },\n        \"visibleEndDate\": {\n          \"type\": \"integer\",\n          \"description\": \"ms since the unix epoch\"\n        },\n        \"advertisedStartDate\": {\n          \"type\": \"integer\",\n          \"description\": \"ms since the unix epoch\"\n        },\n        \"onlineCode\": {\n          \"type\": \"string\",\n          \"maxLength\": 32\n        },\n        \"storeCode\": {\n          \"type\": \"string\",\n          \"maxLength\": 32\n        },\n        \"storeCodeType\": {\n          \"type\": \"string\",\n          \"maxLength\": 32,\n          \"enum\": [\"QR\", \"EAN\", \"CODE_35\", \"CODE_128\", \"DATA_MATRIX\", \"UPC\", \"INTER_2_OF_5\", \"PDF417\"]\n        }\n      },\n      \"required\": [\n        \"customerId\"\n      ]\n    }\n  }\n}\n\n

Sample

[\n    {\n        \"customerId\": 12345,\n        \"visibleStartDate\": 1670400000,\n        \"visibleEndDate\": 1670500000,\n        \"advertisedStartDate\": 1670450000,\n        \"onlineCode\": \"AB-42\",\n        \"storeCode\": \"1223344132131\",\n        \"storeCodeType\": \"UPC\"\n    },\n    {\n        \"customerId\": 67789,\n        \"visibleeStartDate\": 1670400000,\n        \"onlineCode\": \"CW-9\"\n    },\n    {\n        \"customerId\": 787687,\n        \"storeCode\": \"534534534543534534\",\n        \"storeCodeType\": \"UPC\"\n    }\n]\n\n

\n","urlObject":{"path":["v1","offer","wallet","{{offerId}}","customer"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"c014d2ee-04e3-4e2f-a72a-b4d2fbc3f63c"},{"name":"Update Codes to a customer for a Reward Wallet Offer: OFF.I.11","id":"d9d0d725-22a7-4ac6-b5c9-bff30235be47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"[\r\n {\r\n \"customerId\": 12345,\r\n \"visibleStartDate\": 1670400000,\r\n \"visibleEndDate\": 1670500000,\r\n \"advertisedStartDate\": 1670450000,\r\n \"onlineCode\": \"AB-42\",\r\n \"storeCode\": \"1223344132131\",\r\n \"storeCodeType\": \"UPC\"\r\n },\r\n {\r\n \"customerId\": 67789,\r\n \"visibleStartDate\": 1670400000,\r\n \"onlineCode\": \"CW-9\"\r\n },\r\n {\r\n \"customerId\": 787687,\r\n \"storeCode\": \"534534534543534534\",\r\n \"storeCodeType\": \"UPC\"\r\n }\r\n]","options":{"raw":{"language":"json"}}},"url":"/v1/offer/wallet/{{offerId}}/customer","description":"

This will update entries in the reward wallter for an offer. If the visableStartDate is set to null then the code will appear in the reward wallet according to the display setting of the offer.

NOTE: Any not supplied fields will be changed to null in the data.

NOTE: This assignment is purely for display in a rewards wallet and won't affect redemptions

NOTE: You can only asign upto 10K codes per request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Response Code	Meaning
200	summaries have been returned
403	Offer is on a diffrent site than the login details allow
404	Offer was not found
500	Any other server error

Promotion code Schema

{\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n  \"title\": \"codeAssignment\",\n  \"description\": \"The representation of Code Assignment\",\n  \"type\": \"array\",\n  \"minItems\": 1,\n  \"maxItems\": 10000,\n  \"items\": {\n    \"$ref\": \"#/definitions/customerAssignment\"\n  },\n  \"definitions\": {\n    \"customerAssignment\": {\n      \"type\": \"object\",\n      \"anyOf\": [\n        {\n          \"required\": [\n            \"onlineCode\"\n          ]\n        },\n        {\n          \"required\": [\n            \"storeCode\",\n            \"storeCodeType\"\n          ]\n        }\n      ],\n      \"properties\": {\n        \"customerId\": {\n          \"type\": \"integer\"\n        },\n        \"visibleStartDate\": {\n          \"type\": \"integer\",\n          \"description\": \"ms since the unix epoch\"\n        },\n        \"visibleEndDate\": {\n          \"type\": \"integer\",\n          \"description\": \"ms since the unix epoch\"\n        },\n        \"advertisedStartDate\": {\n          \"type\": \"integer\",\n          \"description\": \"ms since the unix epoch\"\n        },\n        \"onlineCode\": {\n          \"type\": \"string\",\n          \"maxLength\": 32\n        },\n        \"storeCode\": {\n          \"type\": \"string\",\n          \"maxLength\": 32\n        },\n        \"storeCodeType\": {\n          \"type\": \"string\",\n          \"maxLength\": 32,\n          \"enum\": [\"QR\", \"EAN\", \"CODE_35\", \"CODE_128\", \"DATA_MATRIX\", \"UPC\", \"INTER_2_OF_5\", \"PDF417\"]\n        }\n      },\n      \"required\": [\n        \"customerId\"\n      ]\n    }\n  }\n}\n\n

Sample

[\n    {\n        \"customerId\": 12345,\n        \"visibleStartDate\": 1670400000,\n        \"visibleEndDate\": 1670500000,\n        \"advertisedStartDate\": 1670450000,\n        \"onlineCode\": \"AB-42\",\n        \"storeCode\": \"1223344132131\",\n        \"storeCodeType\": \"UPC\"\n    },\n    {\n        \"customerId\": 67789,\n        \"visibleeStartDate\": 1670400000,\n        \"onlineCode\": \"CW-9\"\n    },\n    {\n        \"customerId\": 787687,\n        \"storeCode\": \"534534534543534534\",\n        \"storeCodeType\": \"UPC\"\n    }\n]\n\n

\n","urlObject":{"path":["v1","offer","wallet","{{offerId}}","customer"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"d9d0d725-22a7-4ac6-b5c9-bff30235be47"},{"name":"Mark a code as used for customer a Reward Wallet Offer: OFF.I.12","id":"9c8b6991-9d13-4019-af62-f87eefb935ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[],"url":"/v1/offer/wallet/{{offerId}}/customer/{{customerId}}","description":"

This will mark a rewards wallet entry as used for a customer and so hide it from view.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Response Code	Meaning
204	Wallet entry has been marked as used
403	Offer is on a diffrent site than the login details allow
500	Any other server error

","urlObject":{"path":["v1","offer","wallet","{{offerId}}","customer","{{customerId}}"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"9c8b6991-9d13-4019-af62-f87eefb935ac"}],"id":"0f02809e-6b12-42a7-b0e2-fb6c421b43f5","description":"

Offers and promotions are documented into a separate set of documents and examples in a zip file with the name \"Matalan Offers and Promo.zip\"

\n","_postman_id":"0f02809e-6b12-42a7-b0e2-fb6c421b43f5"},{"name":"Offline orders","item":[{"name":"Inbound","item":[{"name":"Offline Orders ref: ORD.I.01","id":"2244fc0b-46db-4b5a-a525-702fae8ae0b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"orderId\": \"string\",\n \"rewardCardId\": \"string\",\n \"orderCreatedDate\": \"string\",\n \"orderStatus\": \"DISPATCHED || REPLACED\",\n \"orderCurrency\": \"string\",\n \"customerInfo\": {\n \"customerId\": \"string\",\n \"emailId\": \"string\",\n \"mobileNumber\": \"string\"\n },\n \"orderLines\": [\n {\n \"sku\": \"string\",\n \"productId\": \"string\",\n \"productName\": \"string\",\n \"quantity\": 0,\n \"barcodes\": [\n \"string\"\n ]\n }\n ],\n \"paymentType\": \"CREDIT_CARD || DEBIT_CARD || CASH\",\n \"totalAmount\": {\n \"currency\": \"string\",\n \"value\": 0,\n \"appliedDiscount\": 0,\n \"vat\": 0\n },\n \"fulfilmentLocationId\": \"string\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"/order/offlineOrders","description":"

All offline transactions can be posted to THG, including all store transactions linked to the customer's reward card.

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
orderId	String	Yes	Unique Identifier for an order
orderCreatedDate	String	Yes	Date the order is created, Ex: \"2022-01-20T10:00:00\", UTC Format
orderStatus	String	Yes	Allowed values are Dispatched and Replaced
orderCurrency	String	Yes	Ex: GBP
customerInfo	Object	Yes	Customer information
orderLines	Object	Yes	Collection of items in the order
paymentType	String	Yes	Allowed values are CREDIT_CARD, DEBIT_CARD or CASH
totalAmount	Object	Yes	Total amount of the order
fulfilmentLocationId	String	Yes	Unique identifier of store

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"array\",\n  \"items\": [\n    {\n      \"type\": \"object\",\n      \"properties\": {\n        \"orderId\": {\n          \"type\": \"string\"\n        },\n        \"rewardCardId\": {\n          \"type\": \"string\"\n        },\n        \"orderCreatedDate\": {\n          \"type\": \"string\"\n        },\n        \"orderStatus\": {\n          \"type\": \"string\"\n        },\n        \"orderCurrency\": {\n          \"type\": \"string\"\n        },\n        \"customerInfo\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"emailId\": {\n              \"type\": \"string\"\n            },\n                      \"customerId\": {\n              \"type\": \"string\"\n            },\n            \"mobileNumber\": {\n              \"type\": \"string\"\n            }\n          },\n          \"required\": [\n            \"emailId\",\n            \"mobileNumber\"\n          ]\n        },\n        \"orderLines\": {\n          \"type\": \"array\",\n          \"items\": [\n            {\n              \"type\": \"object\",\n              \"properties\": {\n                \"sku\": {\n                  \"type\": \"string\"\n                },\n                \"productId\": {\n                  \"type\": \"string\"\n                },\n                \"productName\": {\n                  \"type\": \"string\"\n                },\n                \"quantity\": {\n                  \"type\": \"integer\"\n                },\n                \"barcodes\": {\n                  \"type\": \"array\",\n                  \"items\": [\n                    {\n                      \"type\": \"string\"\n                    }\n                  ]\n                }\n              },\n              \"required\": [\n                \"sku\",\n                \"productId\",\n                \"productName\",\n                \"quantity\",\n                \"barcodes\"\n              ]\n            }\n          ]\n        },\n        \"paymentType\": {\n          \"type\": \"string\"\n        },\n        \"totalAmount\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"currency\": {\n              \"type\": \"string\"\n            },\n            \"value\": {\n              \"type\": \"integer\"\n            },\n            \"appliedDiscount\": {\n              \"type\": \"integer\"\n            },\n            \"vat\": {\n              \"type\": \"integer\"\n            }\n          },\n          \"required\": [\n            \"currency\",\n            \"value\",\n            \"appliedDiscount\",\n            \"vat\"\n          ]\n        },\n        \"fulfilmentLocationId\": {\n          \"type\": \"string\"\n        }\n      },\n      \"required\": [\n        \"orderId\",\n        \"rewardCardId\",\n        \"orderCreatedDate\",\n        \"orderStatus\",\n        \"orderCurrency\",\n        \"customerInfo\",\n        \"orderLines\",\n        \"paymentType\",\n        \"totalAmount\",\n        \"fulfilmentLocationId\"\n      ]\n    }\n  ]\n}\n\n

\n","urlObject":{"path":["order","offlineOrders"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"d4c517fc-7ed0-46a6-8ab5-d1260c7864c4","name":"Offline Orders (Success)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"orderId\": \"405524478\",\n \"rewardCardId\": \"12345566\",\n \"orderCreatedDate\": \"2022-05-19T13:19:28Z\",\n \"orderStatus\": \"DISPATCHED\",\n \"orderCurrency\": \"GBP\",\n \"customerInfo\": {\n \"emailId\": \"marrie.cze@gmail.com\",\n \"mobileNumber\": \"07898786666\"\n },\n \"orderLines\": [\n {\n \"sku\": \"Loreal/Black/40\",\n \"productId\": \"123456\",\n \"productName\": \"Loreal\",\n \"quantity\": 1,\n \"barcodes\": [\n \"5055964790059\"\n ]\n }\n ],\n \"paymentType\": \"CREDIT_CARD\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 25.00,\n \"appliedDiscount\": 0,\n \"vat\": 0\n },\n \"fulfilmentLocationId\": \"123\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"/order/offlineOrders"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"d153e756-2a21-4f18-a9a7-09d5c5aa049a","name":"Offline Orders (Failure)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"[\n {\n \"orderId\": \"405524478\",\n \"rewardCardId\": 12345566,\n \"orderCreatedDate\": \"2022-05-19T13:19:28Z\",\n \"orderStatus\": \"DISPATCHED\",\n \"orderCurrency\": \"GBP\",\n \"customerInfo\": {\n \"emailId\": \"\",\n \"mobileNumber\": \"07898786666\"\n },\n \"orderLines\": [\n {\n \"sku\": \"Loreal/Black/40\",\n \"productId\": \"123456\",\n \"productName\": \"Loreal\",\n \"quantity\": 1,\n \"barcodes\": [\n \"5055964790059\"\n ]\n }\n ],\n \"paymentType\": \"CREDIT_CARD\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 25.00,\n \"appliedDiscount\": 0,\n \"vat\": 0\n },\n \"fulfilmentLocationId\": \"123\"\n }\n]","options":{"raw":{"language":"json"}}},"url":"/order/offlineOrders"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"error\": [{\n \"errorCode\": \"IDENTIFIER_MISSING\", // Other error codes can be INVALID_CONTENT || INVALID_QUANTITY\n \"errorMessage\": \"rewardCardId\"\n },\n {\n \"errorCode\": \"INVALID_CONTENT\", \n \"errorMessage\": \"customerInfo.emailId\"\n }]\n}"}],"_postman_id":"2244fc0b-46db-4b5a-a525-702fae8ae0b7"},{"name":"Order Updates ref: ORD.I.02","id":"ff9228ed-2bb1-4ec0-8227-5fcfd4dc1137","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"eventType\": \"ORDER\",\n \"payload\": [\n {\n \"id\": \"Order_00002-A\",\n \"type\": \"UPDATE\",\n \"details\": {\n \"changes\": [\n {\n \"field\": \"ORDER_LINE_STATE\",\n \"order_line_id\": \"Order_00001-A-1\",\n \"from\": \"WAITING_ACCEPTANCE\",\n \"to\": \"CANCELED\"\n },\n {\n \"field\": \"PRICE\",\n \"from\": 130.00,\n \"to\": 11.00\n },\n {\n \"field\": \"SHIPPING_PRICE\",\n \"from\": 8.00,\n \"to\": 0.00\n },\n {\n \"field\": \"TOTAL_PRICE\",\n \"from\": 138.00,\n \"to\": 11.00\n },\n {\n \"field\": \"ORDER_LINE_PRICE\",\n \"order_line_id\": \"Order_00001-A-1\",\n \"from\": 119.00,\n \"to\": 0.00\n },\n {\n \"field\": \"ORDER_LINE_TOTAL_PRICE\",\n \"order_line_id\": \"Order_00001-A-1\",\n \"from\": 127.00,\n \"to\": 0.00\n },\n {\n \"field\": \"ORDER_LINE_COMMISSION_FEE\",\n \"order_line_id\": \"Order_00001-A-1\",\n \"from\": 19.05,\n \"to\": 0.00\n },\n {\n \"field\": \"ORDER_LINE_COMMISSION_TAXES\",\n \"order_line_id\": \"Order_00001-A-1\",\n \"from\": [\n {\n \"amount\": 3.81,\n \"code\": \"TAXDEFAULT\",\n \"rate\": 20.0000\n }\n ],\n \"to\": [\n {\n \"amount\": 0.00,\n \"code\": \"TAXDEFAULT\",\n \"rate\": 20.0000\n }\n ]\n },\n {\n \"field\": \"ORDER_LINE_TOTAL_COMMISSION\",\n \"order_line_id\": \"Order_00001-A-1\",\n \"from\": 22.86,\n \"to\": 0.00\n },\n {\n \"field\": \"ORDER_LINE_SHIPPING_PRICE\",\n \"order_line_id\": \"Order_00001-A-1\",\n \"from\": 8.00,\n \"to\": 0.00\n },\n {\n \"field\": \"ORDER_LINE_CANCELLATION\",\n \"order_line_id\": \"Order_00001-A-1\",\n \"from\": null,\n \"to\": {\n \"id\": \"1133\",\n \"created_date\": \"2022-03-08T10:30:32.186Z\",\n \"quantity\": 1,\n \"reason_code\": \"34\",\n \"amount\": 119.00,\n \"commission_amount\": 19.05,\n \"commission_taxes\": [\n {\n \"amount\": 3.81,\n \"code\": \"TAXDEFAULT\"\n }\n ],\n \"commission_total_amount\": 22.86,\n \"shipping_amount\": 8.00,\n \"shipping_taxes\": [],\n \"taxes\": []\n }\n }\n ]\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/order/orderUpdates","description":"

All offline transactions can be posted to THG, including all store transactions linked to the customer's reward card.

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
orderId	String	Yes	Unique Identifier for an order
orderCreatedDate	String	Yes	Date the order is created, Ex: \"2022-01-20T10:00:00\", UTC Format
orderStatus	String	Yes	Allowed values are Dispatched and Replaced
orderCurrency	String	Yes	Ex: GBP
customerInfo	Object	Yes	Customer information
orderLines	Object	Yes	Collection of items in the order
paymentType	String	Yes	Allowed values are CREDIT_CARD, DEBIT_CARD or CASH
totalAmount	Object	Yes	Total amount of the order
fulfilmentLocationId	String	Yes	Unique identifier of store

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"array\",\n  \"items\": [\n    {\n      \"type\": \"object\",\n      \"properties\": {\n        \"orderId\": {\n          \"type\": \"string\"\n        },\n        \"rewardCardId\": {\n          \"type\": \"string\"\n        },\n        \"orderCreatedDate\": {\n          \"type\": \"string\"\n        },\n        \"orderStatus\": {\n          \"type\": \"string\"\n        },\n        \"orderCurrency\": {\n          \"type\": \"string\"\n        },\n        \"customerInfo\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"emailId\": {\n              \"type\": \"string\"\n            },\n            \"mobileNumber\": {\n              \"type\": \"string\"\n            }\n          },\n          \"required\": [\n            \"emailId\",\n            \"mobileNumber\"\n          ]\n        },\n        \"orderLines\": {\n          \"type\": \"array\",\n          \"items\": [\n            {\n              \"type\": \"object\",\n              \"properties\": {\n                \"sku\": {\n                  \"type\": \"string\"\n                },\n                \"productId\": {\n                  \"type\": \"string\"\n                },\n                \"productName\": {\n                  \"type\": \"string\"\n                },\n                \"quantity\": {\n                  \"type\": \"integer\"\n                },\n                \"barcodes\": {\n                  \"type\": \"array\",\n                  \"items\": [\n                    {\n                      \"type\": \"string\"\n                    }\n                  ]\n                }\n              },\n              \"required\": [\n                \"sku\",\n                \"productId\",\n                \"productName\",\n                \"quantity\",\n                \"barcodes\"\n              ]\n            }\n          ]\n        },\n        \"paymentType\": {\n          \"type\": \"string\"\n        },\n        \"totalAmount\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"currency\": {\n              \"type\": \"string\"\n            },\n            \"value\": {\n              \"type\": \"integer\"\n            },\n            \"appliedDiscount\": {\n              \"type\": \"integer\"\n            },\n            \"vat\": {\n              \"type\": \"integer\"\n            }\n          },\n          \"required\": [\n            \"currency\",\n            \"value\",\n            \"appliedDiscount\",\n            \"vat\"\n          ]\n        },\n        \"fulfilmentLocationId\": {\n          \"type\": \"string\"\n        }\n      },\n      \"required\": [\n        \"orderId\",\n        \"rewardCardId\",\n        \"orderCreatedDate\",\n        \"orderStatus\",\n        \"orderCurrency\",\n        \"customerInfo\",\n        \"orderLines\",\n        \"paymentType\",\n        \"totalAmount\",\n        \"fulfilmentLocationId\"\n      ]\n    }\n  ]\n}\n\n

\n","urlObject":{"path":["order","orderUpdates"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"ff9228ed-2bb1-4ec0-8227-5fcfd4dc1137"}],"id":"9ddb448b-ba6e-48c9-8129-d7b387bd003c","_postman_id":"9ddb448b-ba6e-48c9-8129-d7b387bd003c","description":""}],"id":"9f073fa1-371e-4c9b-8a92-49f06d1f75fe","description":"

Offline orders is a concept whereby you can registre orders for customers rewarsds programs into the THG Ingenuity systems.

This is a future concept and not available yet.

\n","_postman_id":"9f073fa1-371e-4c9b-8a92-49f06d1f75fe"},{"name":"Order Management","item":[{"name":"Outbound","item":[{"name":"Full Order View ref: ORD.O.01","id":"9ba4ea95-a0a7-45e7-9939-35ff5ad06819","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orderId\": \"string\",\n \"orderCreatedDate\": \"string\",\n \"orderStatus\": \"ORDER_PLACED || ORDER_PROCESSING || ORDER_DISPATCHED || ORDER_CANCELLED || ORDER_DELIVERED || ORDER_COLLECTED\",\n \"deliveryType\": \"STANDARD || NEXT_DAY || CLICK_AND_COLLECT_STANDARD || CLICK_AND_COLLECT_NEXT_DAY || CLICK_AND_COLLECT_1HOUR || LARGE_ITEM\",\n \"orderAmount\": {\n \"currency\": \"string\",\n \"totalAmount\": 0.00,\n \"vat\": 0.00,\n \"shippingCost\": {\n \"currency\": \"string\",\n \"value\": 0.00\n }\n },\n \"paymentInfo\": [\n {\n \"paymentType\": \"CREDIT_CARD || APPLEPAY || GOOGLEPAY || PAYPAL || KLARNA_NOW || KLARNA_LATER || KLARNA_SLICE || AFTERPAY || GIFT_CARD\",\n \"paymentMethod\": \"AMEX || DINERS_CLUB || DISCOVER || INTERNATIONAL_MAESTRO || JCB || MAESTRO || MASTERCARD || ONE4ALL || SOLO || UNION_PAY || VISA || VISA_ELECTRON\",\n \"paymentStatus\": \"AUTH_REQUIRED || PAYMENT_AUTHORISED\",\n \"amount\": 0.00\n }\n ],\n \"orderLineItems\": [\n {\n \"skuId\": \"string\",\n \"barcode\": \"string\",\n \"barcodes\": {\n \"EAN\": [\n \"string\"\n ],\n \"UPC\": [\n \"string\"\n ]\n },\n \"quantity\": 0,\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 0.00,\n \"appliedDiscount\": 0.00,\n \"vat\": 0.00\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 0.00,\n \"discountAmount\": 0.00\n },\n \"offers\": [\n {\n \"offerId\": 0,\n \"discount\": 0.00\n }\n ]\n }\n ],\n \"customerInfo\": {\n \"emailId\": \"string\",\n \"mobileNumber\": \"string\",\n \"billingAddress\": {\n \"name\": \"string\",\n \"companyName\": \"string\",\n \"houseNameNumber\": \"string\",\n \"streetName\": \"string\",\n \"line2\": \"string\",\n \"line3\": \"string\",\n \"line4\": \"string\",\n \"country\": \"string\",\n \"postCode\": \"string\"\n },\n \"shippingAddress\": {\n \"name\": \"string\",\n \"companyName\": \"string\",\n \"houseNameNumber\": \"string\",\n \"streetName\": \"string\",\n \"line2\": \"string\",\n \"line3\": \"Astring\",\n \"line4\": \"string\",\n \"country\": \"string\",\n \"postCode\": \"string\"\n }\n },\n \"shipments\": [\n {\n \"shipmentNumber\": \"string\",\n \"shipmentType\": \"DC2STORE || B2B || B2C\",\n \"fulfilmentChannel\": {\n \"locationId\": 0,\n \"locationName\": \"WEB || STORE || DROP\"\n },\n \"shipmentStatus\": \"NEW || RESERVED || RELEASED || OPEN || CLOSED || CANCELLED || REFUNDED\",\n \"deliveryType\": \"STANDARD || NEXT_DAY || CLICK_AND_COLLECT_STANDARD || CLICK_AND_COLLECT_NEXT_DAY || CLICK_AND_COLLECT_1HOUR || LARGE_ITEM\",\n \"shipmentLines\": [\n {\n \"shipmentLineId\": 0,\n \"skuId\": \"string\",\n \"barcode\": \"string\",\n \"barcodes\": {\n \"EAN\": [\n \"string\"\n ],\n \"UPC\": [\n \"string\"\n ]\n },\n \"quantity\": 0,\n \"expectedDispatchDate\": \"string\",\n \"totalAmount\": {\n \"currency\": \"string\",\n \"value\": 0.00,\n \"appliedDiscount\": 0.00,\n \"vat\": 0.00\n },\n \"productPricePerUnit\": {\n \"currency\": \"string\",\n \"actualAmount\": 0.00,\n \"discountAmount\": 0.00\n },\n \"offers\": [\n {\n \"offerId\": 0,\n \"discount\": 0.00\n }\n ]\n }\n ],\n \"shippingCost\": {\n \"currency\": \"string\",\n \"value\": 0.0\n },\n \"parcels\": [\n {\n \"dispatchDate\": \"2000-01-20T10:00:00\",\n \"fulfilmentLocationId\": 0,\n \"dispatchedItems\": [\n {\n \"skuId\": \"string\",\n \"barcode\": \"string\",\n \"quantity\": 0\n }\n ],\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"CREDIT_CARD || APPLEPAY || GOOGLEPAY || PAYPAL || KLARNA_NOW || KLARNA_LATER || KLARNA_SLICE || AFTERPAY || GIFT_CARD\",\n \"paymentType\": \"AMEX || DINERS_CLUB || DISCOVER || INTERNATIONAL_MAESTRO || JCB || MAESTRO || MASTERCARD || ONE4ALL || SOLO || UNION_PAY || VISA || VISA_ELECTRON\",\n \"paymentStatus\": \"PAYMENT_CHARGED || PAYMENT_FAILED || PAYMENT_PENDING\",\n \"amount\": {\n \"currency\": \"string\",\n \"value\": 0.00,\n \"vat\": 0.00\n }\n }\n ],\n \"labelBarcode\": \"string\",\n \"trackingNumber\": \"string\",\n \"trackingUrl\": \"string\",\n \"parcelId\": \"string\"\n }\n ]\n }\n ],\n \"returns\": [\n {\n \"returnShipmentNumber\": 0,\n \"createdDate\": \"string\",\n \"returnChannel\": {\n \"locationId\": 0,\n \"locationName\": \"WEB || STORE || DROP\"\n },\n \"returnDate\": \"YYYYMMDD\",\n \"returnLines\": [\n {\n \"skuId\": \"string\",\n \"barcode\": \"abc\",\n \"productType\": \"DROP || ECOM || REG\",\n \"sellerId\": \"string\",\n \"quantity\": 0,\n \"returnReason\": {\n \"reasonId\": 1,\n \"reasonName\": \"string\",\n \"returnStatus\": \"GOOD || DAMAGED || FAULTY\"\n }\n }\n ]\n }\n ],\n \"refunds\": [\n {\n \"refundId\": \"string\",\n \"refundDate\": \"string\",\n \"refundType\": \"Refund || MiscRefund\",\n \"refundStatus\": \"REFUND_SUCCESS || REFUND_PENDING || REFUND_FAILED\",\n \"totalRefundAmount\": {\n \"includesOrderShippingCost\": true,\n \"shippingAmount\": 0.0,\n \"currency\": \"EUR\",\n \"value\": 10.0\n },\n \"refundItems\": [\n {\n \"skuId\": \"string\",\n \"barcode\": \"string\",\n \"quantity\": 0,\n \"currency\": \"EUR\",\n \"unitPrice\": 10.0,\n \"returnReasonId\": 1\n }\n ],\n \"processedByStore\": \"string\",\n \"updateStoreStock\": false,\n \"fulfilmentChannel\": {\n \"locationId\": 0,\n \"locationName\": \"WEB || STORE || DROP\"\n }\n }\n ],\n \"donations\": [\n {\n \"charityId\": 0,\n \"charityName\": \"string\",\n \"amount\": 0.50,\n \"status\": \"CHARGE_PENDING || CHARGED || CHARGE_FAILED\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/order/fullOrderView","description":"

A full order view of a customer order including multiple shipments across different fulfillment channels and other order updates will be made available.

The outbound Full Order View (FOV) is an optional API that you can subscribe to and will be sent to you for every change in the order, shipments or returns that will occur.

Beware: This is a stricly For Your Information data exchange and should not be used for operational purposes. For instance if you do your own fulfillment then you can't rely on receiving FOV data before you receive a shipment for said order. Our gateway is asynchronous and supports retries and load balancing and does not guarantee delivery of a FOV before we send you shipments.

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
orderId	String	Yes	Unique Identifier for an order
orderCreatedDate	String	Yes	Date the order is created, Ex: \"2022-01-20T10:00:00\", UTC Format
orderAmount	Object	Yes	Total amount of the order
customerInfo	Object	Yes	Customer information
shipments	Object	Yes	Collection of shipments per order along with fulfilment channel, status, items within the shipments with relevant discount information, payment information and offers applicable during the chekcout journey.
parcels	Object	No	Collection of parcels for a shipment with dispatched items, relevant payment information & parcel tracking details.
donations	Array	No	Array of donations object for a given order. If an order has no donation then this will be an empty array.

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"orderId\": {\n      \"type\": \"string\"\n    },\n    \"orderCreatedDate\": {\n      \"type\": \"string\"\n    },\n    \"orderStatus\": {\n      \"type\": \"string\"\n    },\n    \"orderAmount\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"currency\": {\n          \"type\": \"string\"\n        },\n        \"totalAmount\": {\n          \"type\": \"number\"\n        },\n        \"vat\": {\n          \"type\": \"number\"\n        },\n        \"shippingCost\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"currency\": {\n              \"type\": \"string\"\n            },\n            \"value\": {\n              \"type\": \"number\"\n            }\n          },\n          \"required\": [\n            \"currency\",\n            \"value\"\n          ]\n        }\n      },\n      \"required\": [\n        \"currency\",\n        \"totalAmount\",\n        \"vat\",\n        \"shippingCost\"\n      ]\n    },\n    \"paymentInfo\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"paymentMethod\": {\n              \"type\": \"string\"\n            },\n            \"paymentType\": {\n              \"type\": \"string\"\n            },\n            \"paymentStatus\": {\n              \"type\": \"string\"\n            },\n        \"amount\": {\n          \"type\": \"number\"\n        }\n          },\n          \"required\": [\n            \"paymentMethod\",\n            \"paymentType\",\n            \"paymentStatus\",\n            \"amount\"\n          ]\n        }\n      ]\n    },\n    \"orderLineItems\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"skuId\": {\n              \"type\": \"string\"\n            },\n            \"barcode\": {\n              \"type\": \"string\"\n            },\n            \"barcodes\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"EAN\": {\n                  \"type\": \"array\",\n                  \"items\": [\n                    {\n                      \"type\": \"string\"\n                    }\n                  ]\n                },\n                \"UPC\": {\n                  \"type\": \"array\",\n                  \"items\": [\n                    {\n                      \"type\": \"string\"\n                    }\n                  ]\n                }\n              },\n              \"required\": [\n                \"EAN\",\n                \"UPC\"\n              ]\n            },\n            \"quantity\": {\n              \"type\": \"integer\"\n            },\n            \"expectedDispatchDate\": {\n              \"type\": \"string\"\n            },\n            \"totalAmount\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"currency\": {\n                  \"type\": \"string\"\n                },\n                \"value\": {\n                  \"type\": \"number\"\n                },\n                \"appliedDiscount\": {\n                  \"type\": \"number\"\n                },\n                \"vat\": {\n                  \"type\": \"number\"\n                }\n              },\n              \"required\": [\n                \"currency\",\n                \"value\",\n                \"appliedDiscount\",\n                \"vat\"\n              ]\n            },\n            \"productPricePerUnit\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"currency\": {\n                  \"type\": \"string\"\n                },\n                \"actualAmount\": {\n                  \"type\": \"number\"\n                },\n                \"discountAmount\": {\n                  \"type\": \"number\"\n                }\n              },\n              \"required\": [\n                \"currency\",\n                \"actualAmount\",\n                \"discountAmount\"\n              ]\n            },\n            \"offers\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"offerId\": {\n                      \"type\": \"integer\"\n                    },\n                    \"discount\": {\n                      \"type\": \"number\"\n                    }\n                  },\n                  \"required\": [\n                    \"offerId\",\n                    \"discount\"\n                  ]\n                }\n              ]\n            }\n          },\n          \"required\": [\n            \"skuId\",\n            \"barcode\",\n            \"barcodes\",\n            \"quantity\",\n            \"expectedDispatchDate\",\n            \"totalAmount\",\n            \"productPricePerUnit\",\n            \"offers\"\n          ]\n        }\n      ]\n    },\n    \"customerInfo\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"emailId\": {\n          \"type\": \"string\"\n        },\n        \"mobileNumber\": {\n          \"type\": \"string\"\n        },\n        \"billingAddress\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"name\": {\n              \"type\": \"string\"\n            },\n            \"companyName\": {\n              \"type\": \"string\"\n            },\n            \"houseNameNumber\": {\n              \"type\": \"string\"\n            },\n            \"streetName\": {\n              \"type\": \"string\"\n            },\n            \"line2\": {\n              \"type\": \"string\"\n            },\n            \"line3\": {\n              \"type\": \"string\"\n            },\n            \"line4\": {\n              \"type\": \"string\"\n            },\n            \"country\": {\n              \"type\": \"string\"\n            },\n            \"postCode\": {\n              \"type\": \"string\"\n            }\n          },\n          \"required\": [\n            \"name\",\n            \"houseNameNumber\",\n            \"streetName\",\n            \"line2\",\n            \"line3\",\n            \"line4\",\n            \"country\",\n            \"postCode\"\n          ]\n        },\n        \"shippingAddress\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"name\": {\n              \"type\": \"string\"\n            },\n            \"companyName\": {\n              \"type\": \"string\"\n            },\n            \"houseNameNumber\": {\n              \"type\": \"string\"\n            },\n            \"streetName\": {\n              \"type\": \"string\"\n            },\n            \"line2\": {\n              \"type\": \"string\"\n            },\n            \"line3\": {\n              \"type\": \"string\"\n            },\n            \"line4\": {\n              \"type\": \"string\"\n            },\n            \"country\": {\n              \"type\": \"string\"\n            },\n            \"postCode\": {\n              \"type\": \"string\"\n            }\n          },\n          \"required\": [\n            \"name\",\n            \"houseNameNumber\",\n            \"streetName\",\n            \"line2\",\n            \"line3\",\n            \"line4\",\n            \"country\",\n            \"postCode\"\n          ]\n        }\n      },\n      \"required\": [\n        \"emailId\",\n        \"mobileNumber\",\n        \"billingAddress\",\n        \"shippingAddress\"\n      ]\n    },\n    \"shipments\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"shipmentNumber\": {\n              \"type\": \"string\"\n            },\n            \"shipmentType\": {\n              \"type\": \"string\"\n            },\n            \"deliveryType\": {\n              \"type\": \"string\"\n            },\n            \"fulfilmentChannel\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"locationId\": {\n                  \"type\": \"integer\"\n                },\n                \"locationName\": {\n                  \"type\": \"string\"\n                }\n              },\n              \"required\": [\n                \"locationId\",\n                \"locationName\"\n              ]\n            },\n            \"shipmentStatus\": {\n              \"type\": \"string\"\n            },\n            \"shipmentLines\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"shipmentLineId\": {\n                      \"type\": \"integer\"\n                    },\n                    \"skuId\": {\n                      \"type\": \"string\"\n                    },\n                    \"barcode\": {\n                      \"type\": \"string\"\n                    },\n                    \"barcodes\": {\n                      \"type\": \"object\",\n                      \"properties\": {\n                        \"EAN\": {\n                          \"type\": \"array\",\n                          \"items\": [\n                            {\n                              \"type\": \"string\"\n                            }\n                          ]\n                        },\n                        \"UPC\": {\n                          \"type\": \"array\",\n                          \"items\": [\n                            {\n                              \"type\": \"string\"\n                            }\n                          ]\n                        }\n                      },\n                      \"required\": [\n                        \"EAN\",\n                        \"UPC\"\n                      ]\n                    },\n                    \"quantity\": {\n                      \"type\": \"integer\"\n                    },\n                    \"expectedDispatchDate\": {\n                      \"type\": \"string\"\n                    },\n                    \"totalAmount\": {\n                      \"type\": \"object\",\n                      \"properties\": {\n                        \"currency\": {\n                          \"type\": \"string\"\n                        },\n                        \"value\": {\n                          \"type\": \"number\"\n                        },\n                        \"appliedDiscount\": {\n                          \"type\": \"number\"\n                        },\n                        \"vat\": {\n                          \"type\": \"number\"\n                        }\n                      },\n                      \"required\": [\n                        \"currency\",\n                        \"value\",\n                        \"appliedDiscount\",\n                        \"vat\"\n                      ]\n                    },\n                    \"productPricePerUnit\": {\n                      \"type\": \"object\",\n                      \"properties\": {\n                        \"currency\": {\n                          \"type\": \"string\"\n                        },\n                        \"actualAmount\": {\n                          \"type\": \"number\"\n                        },\n                        \"discountAmount\": {\n                          \"type\": \"number\"\n                        }\n                      },\n                      \"required\": [\n                        \"currency\",\n                        \"actualAmount\",\n                        \"discountAmount\"\n                      ]\n                    },\n                    \"offers\": {\n                      \"type\": \"array\",\n                      \"items\": [\n                        {\n                          \"type\": \"object\",\n                          \"properties\": {\n                            \"offerId\": {\n                              \"type\": \"integer\"\n                            },\n                            \"discount\": {\n                              \"type\": \"number\"\n                            }\n                          },\n                          \"required\": [\n                            \"offerId\",\n                            \"discount\"\n                          ]\n                        }\n                      ]\n                    }\n                  },\n                  \"required\": [\n                    \"shipmentLineId\",\n                    \"skuId\",\n                    \"barcode\",\n                    \"barcodes\",\n                    \"quantity\",\n                    \"expectedDispatchDate\",\n                    \"totalAmount\",\n                    \"productPricePerUnit\",\n                    \"offers\"\n                  ]\n                }\n              ]\n            },\n            \"shippingCost\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"currency\": {\n                  \"type\": \"string\"\n                },\n                \"value\": {\n                  \"type\": \"number\"\n                }\n              },\n              \"required\": [\n                \"currency\",\n                \"value\"\n              ]\n            },\n            \"parcels\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"dispatchDate\": {\n                      \"type\": \"string\"\n                    },\n                    \"fulfilmentLocationId\": {\n                      \"type\": \"integer\"\n                    },\n                    \"parcelId\": {\n                      \"type\": \"string\"\n                    },\n                    \"dispatchedItems\": {\n                      \"type\": \"array\",\n                      \"items\": [\n                        {\n                          \"type\": \"object\",\n                          \"properties\": {\n                            \"skuId\": {\n                              \"type\": \"string\"\n                            },\n                            \"barcode\": {\n                              \"type\": \"string\"\n                            },\n                            \"quantity\": {\n                              \"type\": \"integer\"\n                            }\n                          },\n                          \"required\": [\n                            \"skuId\",\n                            \"barcode\",\n                            \"quantity\"\n                          ]\n                        }\n                      ]\n                    },\n                    \"paymentInfo\": {\n                      \"type\": \"array\",\n                      \"items\": [\n                        {\n                          \"type\": \"object\",\n                          \"properties\": {\n                            \"paymentMethod\": {\n                              \"type\": \"string\"\n                            },\n                            \"paymentType\": {\n                              \"type\": \"string\"\n                            },\n                            \"paymentStatus\": {\n                              \"type\": \"string\"\n                            },\n                            \"amount\": {\n                              \"type\": \"object\",\n                              \"properties\": {\n                                \"currency\": {\n                                  \"type\": \"string\"\n                                },\n                                \"value\": {\n                                  \"type\": \"number\"\n                                },\n                                \"vat\": {\n                                  \"type\": \"number\"\n                                }\n                              },\n                              \"required\": [\n                                \"currency\",\n                                \"value\",\n                                \"vat\"\n                              ]\n                            }\n                          },\n                          \"required\": [\n                            \"paymentMethod\",\n                            \"paymentType\",\n                            \"paymentStatus\",\n                            \"amount\"\n                          ]\n                        }\n                      ]\n                    },\n                    \"labelBarcode\": {\n                      \"type\": \"string\"\n                    },\n                    \"trackingNumber\": {\n                      \"type\": \"string\"\n                    },\n                    \"trackingUrl\": {\n                      \"type\": \"string\"\n                    }\n                  },\n                  \"required\": [\n                    \"dispatchDate\",\n                    \"fulfilmentLocationId\",\n                    \"dispatchedItems\",\n                    \"paymentInfo\",\n                    \"labelBarcode\",\n                    \"trackingNumber\",\n                    \"trackingUrl\"\n                  ]\n                }\n              ]\n            }\n          },\n          \"required\": [\n            \"shipmentNumber\",\n            \"shipmentType\",\n            \"fulfilmentChannel\",\n            \"shipmentStatus\",\n            \"shipmentLines\",\n            \"shippingCost\",\n            \"parcels\"\n          ]\n        }\n      ]\n    },\n    \"returns\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"returnShipmentNumber\": {\n              \"type\": \"integer\"\n            },\n            \"createdDate\": {\n              \"type\": \"string\"\n            },\n            \"returnChannel\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"locationId\": {\n                  \"type\": \"integer\"\n                },\n                \"locationName\": {\n                  \"type\": \"string\"\n                }\n              },\n              \"required\": [\n                \"locationId\",\n                \"locationName\"\n              ]\n            },\n            \"returnDate\": {\n              \"type\": \"string\"\n            },\n            \"returnLines\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"skuId\": {\n                      \"type\": \"string\"\n                    },\n                    \"barcode\": {\n                      \"type\": \"string\"\n                    },\n                    \"productType\": {\n                      \"type\": \"string\"\n                    },\n                    \"sellerId\": {\n                      \"type\": \"string\"\n                    },\n                    \"quantity\": {\n                      \"type\": \"integer\"\n                    },\n                    \"returnReason\": {\n                      \"type\": \"object\",\n                      \"properties\": {\n                        \"reasonId\": {\n                          \"type\": \"integer\"\n                        },\n                        \"reasonName\": {\n                          \"type\": \"string\"\n                        },\n                        \"returnStatus\": {\n                          \"type\": \"string\"\n                        }\n                      },\n                      \"required\": [\n                        \"reasonId\",\n                        \"reasonName\",\n                        \"returnStatus\"\n                      ]\n                    }\n                  },\n                  \"required\": [\n                    \"skuId\",\n                    \"barcode\",\n                    \"productType\",\n                    \"quantity\",\n                    \"returnReason\"\n                  ]\n                }\n              ]\n            }\n          },\n          \"required\": [\n            \"returnShipmentNumber\",\n            \"createdDate\",\n            \"returnChannel\",\n            \"returnDate\",\n            \"returnLines\"\n          ]\n        }\n      ]\n    },\n    \"refunds\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"refundId\": {\n              \"type\": \"string\"\n            },\n            \"refundDate\": {\n              \"type\": \"string\"\n            },\n            \"refundType\": {\n              \"type\": \"string\"\n            },\n            \"refundStatus\": {\n              \"type\": \"string\"\n            },\n            \"totalRefundAmount\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"includesOrderShippingCost\": {\n                  \"type\": \"boolean\"\n                },\n                \"shippingAmount\": {\n                  \"type\": \"number\"\n                },\n                \"currency\": {\n                  \"type\": \"string\"\n                },\n                \"value\": {\n                  \"type\": \"number\"\n                }\n              },\n              \"required\": [\n                \"includesOrderShippingCost\",\n                \"currency\",\n                \"value\"\n              ]\n            },\n            \"processedByStore\": {\n              \"type\": \"string\"\n            },\n            \"updateStoreStock\": {\n              \"type\": \"boolean\"\n            },\n            \"fulfilmentChannel\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"locationId\": {\n                  \"type\": \"integer\"\n                },\n                \"locationName\": {\n                  \"type\": \"string\"\n                }\n              },\n              \"required\": [\n                \"locationId\",\n                \"locationName\"\n              ]\n            },      \n            \"refundItems\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"skuId\": {\n                      \"type\": \"string\"\n                    },\n                    \"barcode\": {\n                      \"type\": \"string\"\n                    },\n                    \"quantity\": {\n                      \"type\": \"integer\"\n                    },\n                    \"currency\": {\n                      \"type\": \"string\"\n                    },\n                    \"returnReasonId\": {\n                      \"type\": \"integer\"\n                    },\n                    \"unitPrice\": {\n                      \"type\": \"number\"\n                    }\n                  },\n                  \"required\": [\n                    \"skuId\",\n                    \"barcode\",\n                    \"quantity\",\n                    \"currency\",\n                    \"unitPrice\"\n                  ]\n                }\n              ]\n            }\n          },\n          \"required\": [\n            \"refundId\",\n            \"refundDate\",\n            \"refundType\",\n            \"refundStatus\",\n            \"totalRefundAmount\",\n            \"refundItems\"\n          ]\n        }\n      ]\n    },\n    \"donations\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"charityId\": {\n              \"type\": \"integer\"\n            },\n            \"charityName\": {\n              \"type\": \"string\"\n            },\n            \"amount\": {\n              \"type\": \"number\"\n            },\n            \"status\": {\n              \"type\": \"string\"\n            }\n          },\n          \"required\": [\n            \"charityId\",\n            \"charityName\",\n            \"amount\",\n            \"status\"\n          ]\n        }\n      ]\n    }\n  },\n  \"required\": [\n    \"orderId\",\n    \"orderCreatedDate\",\n    \"orderStatus\",\n    \"orderAmount\",\n    \"deliveryType\",\n    \"paymentInfo\",\n    \"orderLineItems\",\n    \"customerInfo\",\n    \"shipments\",\n    \"returns\",\n    \"refunds\",\n    \"donations\"\n  ]\n}\n\n

Order State Transitions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Order Status	Shipment Status	Payment Status	Description
ORDER_PLACED	NEW	AUTH_REQUIRED	ORDER IS PLACED ORDER PROCESSING IS HELD NO SHIPMENTS ARE CREATED UNTIL THE 20 MINS CANCELLATION WINDOW
ORDER_PLACED	NEW	PAYMENT_AUTHORISED	ORDER IS PLACED ORDER PROCESSING IS HELD NO SHIPMENTS ARE CREATED AFTER THE 20 MINS CANCELLATION WINDOW, PAYMENT STATUS IS UPDATED TO REFLECT FULL VALUE ORDER AUTHORISATION
ORDER_PROCESSING	RESERVED	PAYMENT_AUTHORISED	SHIPMENT LINE ITEMS ARE RESERVED AGAINST THE FULFILMENT LOCATION SHIPMENTS ARE CREATED
ORDER_PROCESSING	RELEASED	PAYMENT_AUTHORISED	SHIPMENTS ARE RELEASED TO RELEVANT FULFILMENT LOCATION(S)
ORDER_PROCESSING	OPEN	PAYMENT_AUTHORISED	AWAIT PARCEL DISPATCH FROM STORE / WAREHOUSE SHIPMENT WILL REMAIN OPEN UNTIL ALL PARCELS WITHIN A SHIPMENT ARE RECEIVED
ORDER_PROCESSING	CHARGED / CHARGE_FAILED	PAYMENT_AUTHORISED	PAYMENT FAILURE EXCEPTION
ORDER_PROCESSING	CLOSED (FINAL STATE FOR SHIPMENT)	PAYMENT_AUTHORISED	ALL PARCELS IN THE SHIPMENT ARE DISPATCHED
ORDER_DISPATCHED	CLOSED (FINAL STATE FOR SHIPMENT)	PAYMENT_AUTHORISED	ALL SHIPMENTS IN THE ORDER ARE DISPATCHED
ORDER_COLLECTED (FINAL STATE FOR ORDER IF ORDER WAS COLLECTED IN STORE)	CLOSED (FINAL STATE FOR SHIPMENT)	PAYMENT_AUTHORISED	WHEN CUSTOMER HAS COLLECTED THE ORDER IN STORE (FFS/FFW)
ORDER_CANCELLED (FINAL STATE FOR ORDER IF ORDER WAS CANCELLED)	CANCELLED (FINAL STATE FOR SHIPMENT)	PAYMENT_AUTHORISED	WHEN ENTIRE ORDER IS CANCELLED
ORDER_REFUNDED (FINAL STATE FOR ORDER IF REFUND WAS ISSUED)	REFUNDED (FINAL STATE FOR SHIPMENT IF REFUND WAS ISSUED)	PAYMENT_AUTHORISED	WHEN ITEMS ARE RETURNED, A REFUND WILL BE INITIATED

","urlObject":{"path":["order","fullOrderView"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"dfafe8c1-53e3-47ed-a036-12a9c0c4327b","name":"FOV (ORDER_PLACED - Mixed Basket)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"orderId\": \"405524478\",\n \"orderCreatedDate\": \"2022-05-19T13:19:28Z\",\n \"orderStatus\": \"ORDER_PLACED\",\n \"deliveryType\": \"STANDARD\",\n \"orderAmount\": {\n \"currency\": \"GBP\",\n \"totalAmount\": 204.00,\n \"vat\": 5.00,\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 3.00\n }\n },\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"AMEX\",\n \"paymentType\": \"CREDIT_CARD || DEBIT_CARD || CASH || GIFT_CARD\",\n \"paymentStatus\": \"PAYMENT_AUTHORISED\",\n \"amount\": 204.00\n }\n ],\n \"orderLineItems\": [\n {\n \"skuId\": \"Loreal/Black/40\",\n \"barcode\": \"5055964790059\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790059\"\n ],\n \"UPC\": [\n \"5055964790010\"\n ]\n },\n \"quantity\": 2,\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 40.00,\n \"appliedDiscount\": 10.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 5.00\n },\n \"offers\": [\n {\n \"offerId\": 124567,\n \"discount\": 10.00\n }\n ]\n },\n {\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 4,\n \"fulfilmentChannel\": {\n \"locationId\": 200,\n \"locationName\": \"STORE\"\n },\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 75.00,\n \"appliedDiscount\": 25.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 6.25\n },\n \"offers\": [\n {\n \"offerId\": 124567,\n \"discount\": 25.00\n }\n ]\n },\n {\n \"skuId\": \"MALIN/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 1,\n \"fulfilmentChannel\": {\n \"locationId\": 300,\n \"locationName\": \"DROP\"\n },\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 100.00,\n \"appliedDiscount\": 50.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 100.00,\n \"discountAmount\": 50.00\n },\n \"offers\": [\n {\n \"offerId\": 124567,\n \"discount\": 50.00\n }\n ]\n }\n ],\n \"customerInfo\": {\n \"emailId\": \"marrie.cze@gmail.com\",\n \"mobileNumber\": \"07898786666\",\n \"billingAddress\": {\n \"name\": \"Marie Culloden\",\n \"houseNameNumber\": \"11\",\n \"streetName\": \"Mellon Lane\",\n \"line2\": \"Byron Apartments\",\n \"line3\": \"Lanes End\",\n \"line4\": \"Manchester\",\n \"country\": \"GB\",\n \"postCode\": \"M33 6PS\"\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Anns Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n }\n },\n \"shipments\": [],\n \"returns\": [],\n \"refunds\": [],\n \"donations\": []\n}","options":{"raw":{"language":"json"}}},"url":"/order/fullOrderView"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"42113952-51dc-4ea5-8a34-d9081689c89d","name":"FOV (With Donation details)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"orderId\": \"405524478\",\n \"orderCreatedDate\": \"2022-05-19T13:19:28Z\",\n \"orderStatus\": \"ORDER_PLACED\",\n \"deliveryType\": \"STANDARD\",\n \"orderAmount\": {\n \"currency\": \"GBP\",\n \"totalAmount\": 204.00,\n \"vat\": 5.00,\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 3.00\n }\n },\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"AMEX\",\n \"paymentType\": \"CREDIT_CARD || DEBIT_CARD || CASH || GIFT_CARD\",\n \"paymentStatus\": \"PAYMENT_AUTHORISED\",\n \"amount\": 204.00\n }\n ],\n \"orderLineItems\": [\n {\n \"skuId\": \"Loreal/Black/40\",\n \"barcode\": \"5055964790059\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790059\"\n ],\n \"UPC\": [\n \"5055964790010\"\n ]\n },\n \"quantity\": 2,\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 40.00,\n \"appliedDiscount\": 10.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 5.00\n },\n \"offers\": [\n {\n \"offerId\": 124567,\n \"discount\": 10.00\n }\n ]\n },\n {\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 4,\n \"fulfilmentChannel\": {\n \"locationId\": 200,\n \"locationName\": \"STORE\"\n },\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 75.00,\n \"appliedDiscount\": 25.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 6.25\n },\n \"offers\": [\n {\n \"offerId\": 124567,\n \"discount\": 25.00\n }\n ]\n },\n {\n \"skuId\": \"MALIN/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 1,\n \"fulfilmentChannel\": {\n \"locationId\": 300,\n \"locationName\": \"DROP\"\n },\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 100.00,\n \"appliedDiscount\": 50.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 100.00,\n \"discountAmount\": 50.00\n },\n \"offers\": [\n {\n \"offerId\": 124567,\n \"discount\": 50.00\n }\n ]\n }\n ],\n \"customerInfo\": {\n \"emailId\": \"marrie.cze@gmail.com\",\n \"mobileNumber\": \"07898786666\",\n \"billingAddress\": {\n \"name\": \"Marie Culloden\",\n \"houseNameNumber\": \"11\",\n \"streetName\": \"Mellon Lane\",\n \"line2\": \"Byron Apartments\",\n \"line3\": \"Lanes End\",\n \"line4\": \"Manchester\",\n \"country\": \"GB\",\n \"postCode\": \"M33 6PS\"\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Anns Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n }\n },\n \"shipments\": [],\n \"returns\": [],\n \"refunds\": [],\n \"donations\": [\n {\n \"charityId\": 101,\n \"charityName\": \"Save the Children\",\n \"amount\": 2.50,\n \"status\": \"CHARGE_PENDING|CHARGED|CHARGE_FAILED\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/order/fullOrderView"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"3d74b1c3-3885-456a-9a18-1e1d2fe817be","name":"FOV (ORDER_PROCESSING - Mixed Basket, Shipments)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"orderId\": \"405524478\",\n \"orderCreatedDate\": \"2022-05-19T13:19:28Z\",\n \"orderStatus\": \"ORDER_PROCESSING\",\n \"deliveryType\": \"STANDARD\",\n \"orderAmount\": {\n \"currency\": \"GBP\",\n \"totalAmount\": 204.00,\n \"vat\": 5.00,\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 3.00\n }\n },\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"string\",\n \"paymentType\": \"CREDIT_CARD || DEBIT_CARD || CASH || GIFT_CARD\",\n \"paymentStatus\": \"PAYMENT_AUTHORISED\",\n \"amount\": 204.00\n }\n ],\n \"orderLineItems\": [\n {\n \"skuId\": \"Loreal/Black/40\",\n \"barcode\": \"5055964790059\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790059\"\n ],\n \"UPC\": [\n \"5055964790010\"\n ]\n },\n \"quantity\": 2,\n \"fulfilmentChannel\": {\n \"locationId\": 100,\n \"locationName\": \"WEB\"\n },\n \"deliveryType\": \"STANDARD\",\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 47.00,\n \"appliedDiscount\": 3.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124567,\n \"discount\": 1.00\n }\n ]\n },\n {\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 4,\n \"fulfilmentChannel\": {\n \"locationId\": 200,\n \"locationName\": \"STORE\"\n },\n \"deliveryType\": \"STANDARD\",\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 47.00,\n \"appliedDiscount\": 3.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124567,\n \"discount\": 1.00\n }\n ]\n },\n {\n \"skuId\": \"MALIN/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 1,\n \"fulfilmentChannel\": {\n \"locationId\": 300,\n \"locationName\": \"DROP\"\n },\n \"deliveryType\": \"STANDARD\",\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 47.00,\n \"appliedDiscount\": 3.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124567,\n \"discount\": 1.00\n }\n ]\n }\n ],\n \"customerInfo\": {\n \"emailId\": \"marrie.cze@gmail.com\",\n \"mobileNumber\": \"07898786666\",\n \"billingAddress\": {\n \"name\": \"Marie Culloden\",\n \"houseNameNumber\": \"11\",\n \"streetName\": \"Mellon Lane\",\n \"line2\": \"Byron Apartments\",\n \"line3\": \"Lanes End\",\n \"line4\": \"Manchester\",\n \"country\": \"GB\",\n \"postCode\": \"M33 6PS\"\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Anns Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n }\n },\n \"shipments\": [\n {\n \"shipmentNumber\": \"245645704\",\n \"shipmentType\": \"B2C\",\n \"fulfilmentChannel\": {\n \"locationId\": 100,\n \"locationName\": \"WEB\"\n },\n \"deliveryType\": \"STANDARD\",\n \"shipmentStatus\": \"RESERVED\",\n \"shipmentLines\": [\n {\n \"shipmentLineId\": 201,\n \"skuId\": \"Loreal/Black/40\",\n \"barcode\": \"5055964790059\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790059\"\n ],\n \"UPC\": [\n \"5055964790010\"\n ]\n },\n \"quantity\": 2,\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 47.00,\n \"appliedDiscount\": 3.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124567,\n \"discount\": 1.00\n }\n ]\n }\n ],\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 1.00\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"companyName\": null,\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Ann's Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n },\n \"parcels\": [\n {\n \"dispatchDate\": \"2022-05-27T13:19:28Z\",\n \"fulfilmentLocationId\": 1021,\n \"dispatchedItems\": [\n {\n \"skuId\": \"Loreal/Black/40\",\n \"barcode\": \"3600520761145\",\n \"quantity\": 1\n }\n ],\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"string\",\n \"paymentType\": \"CREDIT_CARD || DEBIT_CARD || CASH || GIFT_CARD\",\n \"paymentStatus\": \"PAYMENT_CHARGED || PAYMENT_FAILED || PAYMENT_PENDING\",\n \"amount\": {\n \"currency\": \"string\",\n \"value\": 0.00,\n \"vat\": 0.00\n }\n }\n ],\n \"labelBarcode\": \"THG245645704\",\n \"trackingNumber\": \"HZYEJC0131117751\",\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=HZYEJC0131117751\",\n \"parcelId\": \"THG245645704Parcel\"\n }\n ]\n },\n {\n \"shipmentNumber\": \"245645705\",\n \"shipmentType\": \"B2C\",\n \"fulfilmentChannel\": {\n \"locationId\": 200,\n \"locationName\": \"STORE\"\n },\n \"deliveryType\": \"STANDARD\",\n \"shipmentStatus\": \"RELEASED\",\n \"shipmentLines\": [\n {\n \"shipmentLineId\": 202,\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 2,\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 97.00,\n \"appliedDiscount\": 3.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 50.00,\n \"discountAmount\": 1.50\n },\n \"offers\": []\n }\n ],\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 1.00\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"companyName\": null,\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Ann's Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n },\n \"parcels\": [\n {\n \"dispatchDate\": \"2022-05-27T13:19:28Z\",\n \"fulfilmentLocationId\": 1021,\n \"dispatchedItems\": [\n {\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"3600520761145\",\n \"quantity\": 1\n }\n ],\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"string\",\n \"paymentType\": \"CREDIT_CARD || DEBIT_CARD || CASH || GIFT_CARD\",\n \"paymentStatus\": \"PAYMENT_CHARGED || PAYMENT_FAILED || PAYMENT_PENDING\",\n \"amount\": {\n \"currency\": \"string\",\n \"value\": 0.00,\n \"vat\": 0.00\n }\n }\n ],\n \"labelBarcode\": \"THG245645704\",\n \"trackingNumber\": \"HZYEJC0131117751\",\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=HZYEJC0131117751\",\n \"parcelId\": \"THG245645704Parcel\"\n }\n ]\n }\n ],\n \"returns\": [],\n \"refunds\": [],\n \"donations\": []\n}","options":{"raw":{"language":"json"}}},"url":"/order/fullOrderView"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"3a5da4c5-319d-44e9-aaa1-5205ba1a87b6","name":"FOV (ORDER_PROCESSING - Cancelled and Recycled shipment item)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"orderId\": \"405524478\",\n \"orderCreatedDate\": \"2022-05-19T13:19:28Z\",\n \"orderStatus\": \"ORDER_PROCESSING\",\n \"deliveryType\": \"STANDARD\",\n \"orderAmount\": {\n \"currency\": \"GBP\",\n \"totalAmount\": 166.00,\n \"vat\": 2.00,\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 3.00\n }\n },\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"string\",\n \"paymentType\": \"CREDIT_CARD\",\n \"paymentStatus\": \"PAYMENT_AUTHORISED\",\n \"amount\": 166.00\n }\n ],\n \"orderLineItems\": [\n {\n \"skuId\": \"Loreal/Black/40\",\n \"barcode\": \"5055964790059\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790059\"\n ],\n \"UPC\": [\n \"5055964790010\"\n ]\n },\n \"quantity\": 2,\n \"fulfilmentChannel\": {\n \"locationId\": 100,\n \"locationName\": \"WEB\"\n },\n \"deliveryType\": \"STANDARD\",\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 48.00,\n \"appliedDiscount\": 2.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124567,\n \"discount\": 1.00\n }\n ]\n },\n {\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 4,\n \"fulfilmentChannel\": {\n \"locationId\": 100,\n \"locationName\": \"WEB\"\n },\n \"deliveryType\": \"STANDARD\",\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 96.00,\n \"appliedDiscount\": 4.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124568,\n \"discount\": 1.00\n }\n ]\n },\n {\n \"skuId\": \"MALIN/Medium/12\",\n \"barcode\": \"5055964790061\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790061\"\n ],\n \"UPC\": [\n \"5055964790012\"\n ]\n },\n \"quantity\": 1,\n \"fulfilmentChannel\": {\n \"locationId\": 100,\n \"locationName\": \"WEB\"\n },\n \"deliveryType\": \"STANDARD\",\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 24.00,\n \"appliedDiscount\": 1.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124569,\n \"discount\": 1.00\n }\n ]\n }\n ],\n \"customerInfo\": {\n \"emailId\": \"marrie.cze@gmail.com\",\n \"mobileNumber\": \"07898786666\",\n \"billingAddress\": {\n \"name\": \"Marie Culloden\",\n \"houseNameNumber\": \"11\",\n \"streetName\": \"Mellon Lane\",\n \"line2\": \"Byron Apartments\",\n \"line3\": \"Lanes End\",\n \"line4\": \"Manchester\",\n \"country\": \"GB\",\n \"postCode\": \"M33 6PS\"\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Anns Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n }\n },\n \"shipments\": [\n {\n \"shipmentNumber\": \"245645704\",\n \"shipmentType\": \"B2C\",\n \"fulfilmentChannel\": {\n \"locationId\": 100,\n \"locationName\": \"WEB\"\n },\n \"deliveryType\": \"STANDARD\",\n \"shipmentStatus\": \"CANCELLED\",\n \"shipmentLines\": [\n {\n \"shipmentLineId\": 201,\n \"skuId\": \"Loreal/Black/40\",\n \"barcode\": \"5055964790059\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790059\"\n ],\n \"UPC\": [\n \"5055964790010\"\n ]\n },\n \"quantity\": 2,\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 48.00,\n \"appliedDiscount\": 2.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124567,\n \"discount\": 1.00\n }\n ]\n },\n {\n \"shipmentLineId\": 202,\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 4,\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 96.00,\n \"appliedDiscount\": 4.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124568,\n \"discount\": 1.00\n }\n ]\n },\n {\n \"shipmentLineId\": 203,\n \"skuId\": \"MALIN/Medium/12\",\n \"barcode\": \"5055964790061\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790061\"\n ],\n \"UPC\": [\n \"5055964790012\"\n ]\n },\n \"quantity\": 1,\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 24.00,\n \"appliedDiscount\": 1.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124569,\n \"discount\": 1.00\n }\n ]\n }\n ],\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 2.00\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"companyName\": null,\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Ann's Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n },\n \"parcels\": [\n {\n \"dispatchDate\": \"2022-05-27T13:19:28Z\",\n \"fulfilmentLocationId\": 100,\n \"dispatchedItems\": [\n {\n \"skuId\": \"Loreal/Black/40\",\n \"barcode\": \"5055964790059\",\n \"quantity\": 2\n }\n ],\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"string\",\n \"paymentType\": \"CREDIT_CARD\",\n \"paymentStatus\": \"PAYMENT_CHARGED\",\n \"amount\": {\n \"currency\": \"GBP\",\n \"value\": 48.00,\n \"vat\": 0.00\n }\n }\n ],\n \"labelBarcode\": \"THG245645704\",\n \"trackingNumber\": \"HZYEJC0131117751\",\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=HZYEJC0131117751\",\n \"parcelId\": \"THG245645704Parcel\"\n },\n {\n \"dispatchDate\": \"2022-05-27T13:19:28Z\",\n \"fulfilmentLocationId\": 100,\n \"dispatchedItems\": [\n {\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"quantity\": 4\n }\n ],\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"string\",\n \"paymentType\": \"CREDIT_CARD\",\n \"paymentStatus\": \"PAYMENT_CHARGED\",\n \"amount\": {\n \"currency\": \"GBP\",\n \"value\": 96.00,\n \"vat\": 0.00\n }\n }\n ],\n \"labelBarcode\": \"THG245645705\",\n \"trackingNumber\": \"HZYEJC0131117752\",\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=HZYEJC0131117752\",\n \"parcelId\": \"THG245645705Parcel\"\n }\n ]\n },\n {\n \"shipmentNumber\": \"245645705\",\n \"shipmentType\": \"B2C\",\n \"fulfilmentChannel\": {\n \"locationId\": 100,\n \"locationName\": \"WEB\"\n },\n \"deliveryType\": \"STANDARD\",\n \"shipmentStatus\": \"RELEASED\",\n \"shipmentLines\": [\n {\n \"shipmentLineId\": 204,\n \"skuId\": \"MALIN/Medium/12\",\n \"barcode\": \"5055964790061\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790061\"\n ],\n \"UPC\": [\n \"5055964790012\"\n ]\n },\n \"quantity\": 1,\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 24.00,\n \"appliedDiscount\": 1.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124569,\n \"discount\": 1.00\n }\n ]\n }\n ],\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 1.00\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Ann's Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n },\n \"parcels\": []\n }\n ],\n \"returns\": [],\n \"refunds\": [],\n \"donations\": []\n}","options":{"raw":{"language":"json"}}},"url":"/order/fullOrderView"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"14ce0544-1c87-4ddf-9a04-1c71089fc7c6","name":"FOV (ORDER_CANCELLED - Cancelled complete order in cancellation window)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"orderId\": \"405524478\",\n \"orderCreatedDate\": \"2022-05-19T13:19:28Z\",\n \"orderStatus\": \"ORDER_CANCELLED\",\n \"deliveryType\": \"STANDARD\",\n \"orderAmount\": {\n \"currency\": \"GBP\",\n \"totalAmount\": 166.00,\n \"vat\": 2.00,\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 3.00\n }\n },\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"string\",\n \"paymentType\": \"CREDIT_CARD\",\n \"paymentStatus\": \"PAYMENT_AUTHORISED\",\n \"amount\": 166.00\n }\n ],\n \"orderLineItems\": [\n {\n \"skuId\": \"Loreal/Black/40\",\n \"barcode\": \"5055964790059\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790059\"\n ],\n \"UPC\": [\n \"5055964790010\"\n ]\n },\n \"quantity\": 2,\n \"fulfilmentChannel\": {\n \"locationId\": 100,\n \"locationName\": \"WEB\"\n },\n \"deliveryType\": \"STANDARD\",\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 48.00,\n \"appliedDiscount\": 2.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124567,\n \"discount\": 1.00\n }\n ]\n },\n {\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 4,\n \"fulfilmentChannel\": {\n \"locationId\": 100,\n \"locationName\": \"WEB\"\n },\n \"deliveryType\": \"STANDARD\",\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 96.00,\n \"appliedDiscount\": 4.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124568,\n \"discount\": 1.00\n }\n ]\n },\n {\n \"skuId\": \"MALIN/Medium/12\",\n \"barcode\": \"5055964790061\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790061\"\n ],\n \"UPC\": [\n \"5055964790012\"\n ]\n },\n \"quantity\": 1,\n \"fulfilmentChannel\": {\n \"locationId\": 100,\n \"locationName\": \"WEB\"\n },\n \"deliveryType\": \"STANDARD\",\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 24.00,\n \"appliedDiscount\": 1.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124569,\n \"discount\": 1.00\n }\n ]\n }\n ],\n \"customerInfo\": {\n \"emailId\": \"marrie.cze@gmail.com\",\n \"mobileNumber\": \"07898786666\",\n \"billingAddress\": {\n \"name\": \"Marie Culloden\",\n \"houseNameNumber\": \"11\",\n \"streetName\": \"Mellon Lane\",\n \"line2\": \"Byron Apartments\",\n \"line3\": \"Lanes End\",\n \"line4\": \"Manchester\",\n \"country\": \"GB\",\n \"postCode\": \"M33 6PS\"\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Anns Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n }\n },\n \"shipments\": [],\n \"returns\": [],\n \"refunds\": [],\n \"donations\": []\n}","options":{"raw":{"language":"json"}}},"url":"/order/fullOrderView"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"790b1cff-9df8-4a5d-bf57-ec006c8c9e20","name":"FOV (ORDER_CANCELLED - Cancelled whole shipment with no recycle)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"orderId\": \"405524478\",\n \"orderCreatedDate\": \"2022-05-19T13:19:28Z\",\n \"orderStatus\": \"ORDER_CANCELLED\",\n \"deliveryType\": \"STANDARD\",\n \"orderAmount\": {\n \"currency\": \"GBP\",\n \"totalAmount\": 166.00,\n \"vat\": 2.00,\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 3.00\n }\n },\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"string\",\n \"paymentType\": \"CREDIT_CARD\",\n \"paymentStatus\": \"PAYMENT_AUTHORISED\",\n \"amount\": 166.00\n }\n ],\n \"orderLineItems\": [\n {\n \"skuId\": \"Loreal/Black/40\",\n \"barcode\": \"5055964790059\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790059\"\n ],\n \"UPC\": [\n \"5055964790010\"\n ]\n },\n \"quantity\": 2,\n \"fulfilmentChannel\": {\n \"locationId\": 100,\n \"locationName\": \"STORE\"\n },\n \"deliveryType\": \"CLICK_AND_COLLECT\",\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 48.00,\n \"appliedDiscount\": 2.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124567,\n \"discount\": 1.00\n }\n ]\n },\n {\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 4,\n \"fulfilmentChannel\": {\n \"locationId\": 100,\n \"locationName\": \"WEB\"\n },\n \"deliveryType\": \"STANDARD\",\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 96.00,\n \"appliedDiscount\": 4.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124568,\n \"discount\": 1.00\n }\n ]\n },\n {\n \"skuId\": \"MALIN/Medium/12\",\n \"barcode\": \"5055964790061\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790061\"\n ],\n \"UPC\": [\n \"5055964790012\"\n ]\n },\n \"quantity\": 1,\n \"fulfilmentChannel\": {\n \"locationId\": 100,\n \"locationName\": \"WEB\"\n },\n \"deliveryType\": \"STANDARD\",\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 24.00,\n \"appliedDiscount\": 1.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124569,\n \"discount\": 1.00\n }\n ]\n }\n ],\n \"customerInfo\": {\n \"emailId\": \"marrie.cze@gmail.com\",\n \"mobileNumber\": \"07898786666\",\n \"billingAddress\": {\n \"name\": \"Marie Culloden\",\n \"houseNameNumber\": \"11\",\n \"streetName\": \"Mellon Lane\",\n \"line2\": \"Byron Apartments\",\n \"line3\": \"Lanes End\",\n \"line4\": \"Manchester\",\n \"country\": \"GB\",\n \"postCode\": \"M33 6PS\"\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Anns Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n }\n },\n \"shipments\": [\n {\n \"shipmentNumber\": \"245645704\",\n \"shipmentType\": \"B2C\",\n \"fulfilmentChannel\": {\n \"locationId\": 100,\n \"locationName\": \"STORE\"\n },\n \"deliveryType\": \"CLICK_AND_COLLECT\",\n \"shipmentStatus\": \"CANCELLED\",\n \"shipmentLines\": [\n {\n \"shipmentLineId\": 201,\n \"skuId\": \"Loreal/Black/40\",\n \"barcode\": \"5055964790059\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790059\"\n ],\n \"UPC\": [\n \"5055964790010\"\n ]\n },\n \"quantity\": 2,\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 48.00,\n \"appliedDiscount\": 2.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124567,\n \"discount\": 1.00\n }\n ]\n },\n {\n \"shipmentLineId\": 202,\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 4,\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 96.00,\n \"appliedDiscount\": 4.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124568,\n \"discount\": 1.00\n }\n ]\n },\n {\n \"shipmentLineId\": 203,\n \"skuId\": \"MALIN/Medium/12\",\n \"barcode\": \"5055964790061\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790061\"\n ],\n \"UPC\": [\n \"5055964790012\"\n ]\n },\n \"quantity\": 1,\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 24.00,\n \"appliedDiscount\": 1.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124569,\n \"discount\": 1.00\n }\n ]\n }\n ],\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 2.00\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Ann's Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n },\n \"parcels\": []\n }\n ],\n \"returns\": [],\n \"refunds\": [],\n \"donations\": []\n}","options":{"raw":{"language":"json"}}},"url":"/order/fullOrderView"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"324a2882-b5f9-45b7-a68a-51fe840bce5f","name":"FOV (ORDER_PROCESSING - Shipment OPEN, Awaiting Parcel)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"orderId\": \"405524478\",\n \"orderCreatedDate\": \"2022-05-19T13:19:28Z\",\n \"orderStatus\": \"ORDER_PROCESSING\",\n \"deliveryType\": \"STANDARD\",\n \"orderAmount\": {\n \"currency\": \"GBP\",\n \"totalAmount\": 204.00,\n \"vat\": 5.00,\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 3.00\n }\n },\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"string\",\n \"paymentType\": \"CREDIT_CARD || DEBIT_CARD || CASH || GIFT_CARD\",\n \"paymentStatus\": \"PAYMENT_AUTHORISED\",\n \"amount\": 204.00\n }\n ],\n \"orderLineItems\": [\n {\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 4,\n \"fulfilmentChannel\": {\n \"locationId\": 200,\n \"locationName\": \"STORE\"\n },\n \"deliveryType\": \"STANDARD\",\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 47.00,\n \"appliedDiscount\": 3.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124567,\n \"discount\": 1.00\n }\n ]\n }\n ],\n \"customerInfo\": {\n \"emailId\": \"marrie.cze@gmail.com\",\n \"mobileNumber\": \"07898786666\",\n \"billingAddress\": {\n \"name\": \"Marie Culloden\",\n \"houseNameNumber\": \"11\",\n \"streetName\": \"Mellon Lane\",\n \"line2\": \"Byron Apartments\",\n \"line3\": \"Lanes End\",\n \"line4\": \"Manchester\",\n \"country\": \"GB\",\n \"postCode\": \"M33 6PS\"\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Anns Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n }\n },\n \"shipments\": [\n {\n \"shipmentNumber\": \"245645705\",\n \"shipmentType\": \"B2C\",\n \"fulfilmentChannel\": {\n \"locationId\": 200,\n \"locationName\": \"STORE\"\n },\n \"deliveryType\": \"STANDARD\",\n \"shipmentStatus\": \"OPEN\",\n \"shipmentLines\": [\n {\n \"shipmentLineId\": 202,\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 4,\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 97.00,\n \"appliedDiscount\": 3.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 50.00,\n \"discountAmount\": 1.50\n },\n \"offers\": []\n }\n ],\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 1.00\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Ann's Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n },\n \"parcels\": [\n {\n \"dispatchDate\": \"2022-05-27T13:19:28Z\",\n \"fulfilmentLocationId\": 1021,\n \"dispatchedItems\": [\n {\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"3600520761145\",\n \"quantity\": 2\n }\n ],\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"string\",\n \"paymentType\": \"CREDIT_CARD || DEBIT_CARD || CASH || GIFT_CARD\",\n \"paymentStatus\": \"PAYMENT_CHARGED || PAYMENT_FAILED || PAYMENT_PENDING\",\n \"amount\": {\n \"currency\": \"string\",\n \"value\": 0.00,\n \"vat\": 0.00\n }\n }\n ],\n \"labelBarcode\": \"THG245645704\",\n \"trackingNumber\": \"HZYEJC0131117751\",\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=HZYEJC0131117751\",\n \"parcelId\": \"THG245645704Parcel\"\n }\n ]\n }\n ],\n \"returns\": [],\n \"refunds\": [],\n \"donations\": []\n}","options":{"raw":{"language":"json"}}},"url":"/order/fullOrderView"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"ded1718e-4865-48d0-bd80-b9ffa9d8251c","name":"FOV (ORDER_COLLECTED - Shipment CLOSED)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"orderId\": \"405524478\",\n \"orderCreatedDate\": \"2022-05-19T13:19:28Z\",\n \"orderStatus\": \"ORDER_COLLECTED\",\n \"deliveryType\": \"STANDARD\",\n \"orderAmount\": {\n \"currency\": \"GBP\",\n \"totalAmount\": 204.00,\n \"vat\": 5.00,\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 3.00\n }\n },\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"string\",\n \"paymentType\": \"CREDIT_CARD || DEBIT_CARD || CASH || GIFT_CARD\",\n \"paymentStatus\": \"PAYMENT_AUTHORISED\",\n \"amount\": 204.00\n }\n ],\n \"orderLineItems\": [\n {\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 4,\n \"fulfilmentChannel\": {\n \"locationId\": 200,\n \"locationName\": \"STORE\"\n },\n \"deliveryType\": \"STANDARD\",\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 47.00,\n \"appliedDiscount\": 3.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124567,\n \"discount\": 1.00\n }\n ]\n }\n ],\n \"customerInfo\": {\n \"emailId\": \"marrie.cze@gmail.com\",\n \"mobileNumber\": \"07898786666\",\n \"billingAddress\": {\n \"name\": \"Marie Culloden\",\n \"houseNameNumber\": \"11\",\n \"streetName\": \"Mellon Lane\",\n \"line2\": \"Byron Apartments\",\n \"line3\": \"Lanes End\",\n \"line4\": \"Manchester\",\n \"country\": \"GB\",\n \"postCode\": \"M33 6PS\"\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Anns Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n }\n },\n \"shipments\": [\n {\n \"shipmentNumber\": \"245645705\",\n \"shipmentType\": \"B2C\",\n \"fulfilmentChannel\": {\n \"locationId\": 200,\n \"locationName\": \"STORE\"\n },\n \"deliveryType\": \"STANDARD\",\n \"shipmentStatus\": \"CLOSED\",\n \"shipmentLines\": [\n {\n \"shipmentLineId\": 202,\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 4,\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 97.00,\n \"appliedDiscount\": 3.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 50.00,\n \"discountAmount\": 1.50\n },\n \"offers\": []\n }\n ],\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 1.00\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Ann's Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n },\n \"parcels\": [\n {\n \"dispatchDate\": \"2022-05-27T13:19:28Z\",\n \"fulfilmentLocationId\": 1021,\n \"dispatchedItems\": [\n {\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"3600520761145\",\n \"quantity\": 2\n }\n ],\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"string\",\n \"paymentType\": \"CREDIT_CARD || DEBIT_CARD || CASH || GIFT_CARD\",\n \"paymentStatus\": \"PAYMENT_CHARGED || PAYMENT_FAILED || PAYMENT_PENDING\",\n \"amount\": {\n \"currency\": \"string\",\n \"value\": 0.00,\n \"vat\": 0.00\n }\n }\n ],\n \"labelBarcode\": \"THG245645704\",\n \"trackingNumber\": \"HZYEJC0131117751\",\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=HZYEJC0131117751\",\n \"parcelId\": \"THG245645704Parcel\"\n },\n {\n \"dispatchDate\": \"2022-05-29T13:19:28Z\",\n \"fulfilmentLocationId\": 1021,\n \"dispatchedItems\": [\n {\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"3600520761145\",\n \"quantity\": 2\n }\n ],\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"string\",\n \"paymentType\": \"CREDIT_CARD || DEBIT_CARD || CASH || GIFT_CARD\",\n \"paymentStatus\": \"PAYMENT_CHARGED || PAYMENT_FAILED || PAYMENT_PENDING\",\n \"amount\": {\n \"currency\": \"string\",\n \"value\": 0.00,\n \"vat\": 0.00\n }\n }\n ],\n \"labelBarcode\": \"THG245645704\",\n \"trackingNumber\": \"HZYEJC0131117751\",\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=HZYEJC0131117751\",\n \"parcelId\": \"THG245645704Parcel\"\n }\n ]\n }\n ],\n \"returns\": [],\n \"refunds\": [],\n \"donations\": []\n}","options":{"raw":{"language":"json"}}},"url":"/order/fullOrderView"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"51c4dc1c-c2e9-4d90-bb59-b8df1e12e15a","name":"FOV (ORDER_CANCELLED - Shipment CLOSED, UNCOLLECTED)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"orderId\": \"405524478\",\n \"orderCreatedDate\": \"2022-05-19T13:19:28Z\",\n \"orderStatus\": \"ORDER_CANCELLED\",\n \"deliveryType\": \"STANDARD\",\n \"orderAmount\": {\n \"currency\": \"GBP\",\n \"totalAmount\": 204.00,\n \"vat\": 5.00,\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 3.00\n }\n },\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"string\",\n \"paymentType\": \"CREDIT_CARD || DEBIT_CARD || CASH || GIFT_CARD\",\n \"paymentStatus\": \"PAYMENT_AUTHORISED\",\n \"amount\": 204.00\n }\n ],\n \"orderLineItems\": [\n {\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 4,\n \"fulfilmentChannel\": {\n \"locationId\": 200,\n \"locationName\": \"STORE\"\n },\n \"deliveryType\": \"STANDARD\",\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 47.00,\n \"appliedDiscount\": 3.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124567,\n \"discount\": 1.00\n }\n ]\n }\n ],\n \"customerInfo\": {\n \"emailId\": \"marrie.cze@gmail.com\",\n \"mobileNumber\": \"07898786666\",\n \"billingAddress\": {\n \"name\": \"Marie Culloden\",\n \"houseNameNumber\": \"11\",\n \"streetName\": \"Mellon Lane\",\n \"line2\": \"Byron Apartments\",\n \"line3\": \"Lanes End\",\n \"line4\": \"Manchester\",\n \"country\": \"GB\",\n \"postCode\": \"M33 6PS\"\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Anns Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n }\n },\n \"shipments\": [\n {\n \"shipmentNumber\": \"245645705\",\n \"shipmentType\": \"B2C\",\n \"fulfilmentChannel\": {\n \"locationId\": 200,\n \"locationName\": \"STORE\"\n },\n \"deliveryType\": \"STANDARD\",\n \"shipmentStatus\": \"CLOSED\",\n \"shipmentLines\": [\n {\n \"shipmentLineId\": 202,\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 1,\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 97.00,\n \"appliedDiscount\": 3.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 50.00,\n \"discountAmount\": 1.50\n },\n \"offers\": []\n }\n ],\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 1.00\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Ann's Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n },\n \"parcels\": [\n {\n \"dispatchDate\": \"2022-05-27T13:19:28Z\",\n \"fulfilmentLocationId\": 1021,\n \"dispatchedItems\": [\n {\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"3600520761145\",\n \"quantity\": 1\n }\n ],\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"string\",\n \"paymentType\": \"CREDIT_CARD || DEBIT_CARD || CASH || GIFT_CARD\",\n \"paymentStatus\": \"PAYMENT_CHARGED || PAYMENT_FAILED || PAYMENT_PENDING\",\n \"amount\": {\n \"currency\": \"string\",\n \"value\": 0.00,\n \"vat\": 0.00\n }\n }\n ],\n \"labelBarcode\": \"THG245645704\",\n \"trackingNumber\": \"HZYEJC0131117751\",\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=HZYEJC0131117751\",\n \"parcelId\": \"THG245645704Parcel\"\n }\n ]\n }\n ],\n \"returns\": [],\n \"refunds\": [],\n \"donations\": []\n}","options":{"raw":{"language":"json"}}},"url":"/order/fullOrderView"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"17789b7d-ab79-42aa-97cb-8d57cde0613e","name":"FOV (ORDER_CANCELLED - Shipment CANCELLED, UNCOLLECTED, REFUNDED)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"orderId\": \"405524478\",\n \"orderCreatedDate\": \"2022-05-19T13:19:28Z\",\n \"orderStatus\": \"ORDER_CANCELLED\",\n \"deliveryType\": \"STANDARD\",\n \"orderAmount\": {\n \"currency\": \"GBP\",\n \"totalAmount\": 204.00,\n \"vat\": 5.00,\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 3.00\n }\n },\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"string\",\n \"paymentType\": \"CREDIT_CARD || DEBIT_CARD || CASH || GIFT_CARD\",\n \"paymentStatus\": \"PAYMENT_AUTHORISED\",\n \"amount\": 204.00\n }\n ],\n \"orderLineItems\": [\n {\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 4,\n \"fulfilmentChannel\": {\n \"locationId\": 200,\n \"locationName\": \"STORE\"\n },\n \"deliveryType\": \"STANDARD\",\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 47.00,\n \"appliedDiscount\": 3.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124567,\n \"discount\": 1.00\n }\n ]\n }\n ],\n \"customerInfo\": {\n \"emailId\": \"marrie.cze@gmail.com\",\n \"mobileNumber\": \"07898786666\",\n \"billingAddress\": {\n \"name\": \"Marie Culloden\",\n \"houseNameNumber\": \"11\",\n \"streetName\": \"Mellon Lane\",\n \"line2\": \"Byron Apartments\",\n \"line3\": \"Lanes End\",\n \"line4\": \"Manchester\",\n \"country\": \"GB\",\n \"postCode\": \"M33 6PS\"\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Anns Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n }\n },\n \"shipments\": [\n {\n \"shipmentNumber\": \"245645705\",\n \"shipmentType\": \"B2C\",\n \"fulfilmentChannel\": {\n \"locationId\": 200,\n \"locationName\": \"STORE\"\n },\n \"deliveryType\": \"STANDARD\",\n \"shipmentStatus\": \"CANCELLED\",\n \"shipmentLines\": [\n {\n \"shipmentLineId\": 202,\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 1,\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 50.00,\n \"appliedDiscount\": 0,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 50.00,\n \"discountAmount\": 0\n },\n \"offers\": []\n }\n ],\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 3.00\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Ann's Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n },\n \"parcels\": [\n {\n \"dispatchDate\": \"2022-05-27T13:19:28Z\",\n \"fulfilmentLocationId\": 1021,\n \"dispatchedItems\": [\n {\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"3600520761145\",\n \"quantity\": 1\n }\n ],\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"string\",\n \"paymentType\": \"CREDIT_CARD || DEBIT_CARD || CASH || GIFT_CARD\",\n \"paymentStatus\": \"PAYMENT_CHARGED || PAYMENT_FAILED || PAYMENT_PENDING\",\n \"amount\": {\n \"currency\": \"string\",\n \"value\": 50.00,\n \"vat\": 0.00\n }\n }\n ],\n \"labelBarcode\": \"THG245645704\",\n \"trackingNumber\": \"HZYEJC0131117751\",\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=HZYEJC0131117751\",\n \"parcelId\": \"THG245645704Parcel\"\n }\n ]\n }\n ],\n \"returns\": [],\n \"refunds\": [\n {\n \"refundId\": \"1235878\",\n \"refundDate\": \"2022-05-30T13:19:28Z\",\n \"refundType\": \"Refund\",\n \"refundStatus\": \"REFUND_SUCCESS\",\n \"totalRefundAmount\": {\n \"includesOrderShippingCost\": true,\n \"shippingAmount\": 3.0,\n \"currency\": \"GBP\",\n \"value\": 50.0\n },\n \"refundItems\": [\n {\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"3600520761145\",\n \"quantity\": 1,\n \"currency\": \"GBP\",\n \"unitPrice\": 24.0,\n \"returnReasonId\": 1\n }\n ],\n \"processedByStore\": \"200\",\n \"updateStoreStock\": true,\n \"fulfilmentChannel\": {\n \"locationId\": 200,\n \"locationName\": \"WEB\"\n }\n }\n ],\n \"donations\": []\n}","options":{"raw":{"language":"json"}}},"url":"/order/fullOrderView"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"b15a78d5-6ab5-43e7-9450-c56352fe47f2","name":"FOV (ORDER_REFUNDED - Shipment REFUNDED when an item is returned to WEB)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"orderId\": \"405524478\",\n \"orderCreatedDate\": \"2022-05-19T13:19:28Z\",\n \"orderStatus\": \"ORDER_REFUNDED\",\n \"deliveryType\": \"STANDARD\",\n \"orderAmount\": {\n \"currency\": \"GBP\",\n \"totalAmount\": 166.00,\n \"vat\": 2.00,\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 3.00\n }\n },\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"string\",\n \"paymentType\": \"CREDIT_CARD\",\n \"paymentStatus\": \"PAYMENT_AUTHORISED\",\n \"amount\": 166.00\n }\n ],\n \"orderLineItems\": [\n {\n \"skuId\": \"Loreal/Black/40\",\n \"barcode\": \"5055964790059\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790059\"\n ],\n \"UPC\": [\n \"5055964790010\"\n ]\n },\n \"quantity\": 2,\n \"fulfilmentChannel\": {\n \"locationId\": 100,\n \"locationName\": \"WEB\"\n },\n \"deliveryType\": \"STANDARD\",\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 48.00,\n \"appliedDiscount\": 2.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124567,\n \"discount\": 1.00\n }\n ]\n },\n {\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 4,\n \"fulfilmentChannel\": {\n \"locationId\": 100,\n \"locationName\": \"WEB\"\n },\n \"deliveryType\": \"STANDARD\",\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 96.00,\n \"appliedDiscount\": 4.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124568,\n \"discount\": 1.00\n }\n ]\n },\n {\n \"skuId\": \"MALIN/Medium/12\",\n \"barcode\": \"5055964790061\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790061\"\n ],\n \"UPC\": [\n \"5055964790012\"\n ]\n },\n \"quantity\": 1,\n \"fulfilmentChannel\": {\n \"locationId\": 100,\n \"locationName\": \"WEB\"\n },\n \"deliveryType\": \"STANDARD\",\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 24.00,\n \"appliedDiscount\": 1.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124569,\n \"discount\": 1.00\n }\n ]\n }\n ],\n \"customerInfo\": {\n \"emailId\": \"marrie.cze@gmail.com\",\n \"mobileNumber\": \"07898786666\",\n \"billingAddress\": {\n \"name\": \"Marie Culloden\",\n \"houseNameNumber\": \"11\",\n \"streetName\": \"Mellon Lane\",\n \"line2\": \"Byron Apartments\",\n \"line3\": \"Lanes End\",\n \"line4\": \"Manchester\",\n \"country\": \"GB\",\n \"postCode\": \"M33 6PS\"\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Anns Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n }\n },\n \"shipments\": [\n {\n \"shipmentNumber\": \"245645704\",\n \"shipmentType\": \"B2C\",\n \"fulfilmentChannel\": {\n \"locationId\": 100,\n \"locationName\": \"WEB\"\n },\n \"deliveryType\": \"STANDARD\",\n \"shipmentStatus\": \"REFUNDED\",\n \"shipmentLines\": [\n {\n \"shipmentLineId\": 201,\n \"skuId\": \"Loreal/Black/40\",\n \"barcode\": \"5055964790059\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790059\"\n ],\n \"UPC\": [\n \"5055964790010\"\n ]\n },\n \"quantity\": 2,\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 48.00,\n \"appliedDiscount\": 2.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124567,\n \"discount\": 1.00\n }\n ]\n },\n {\n \"shipmentLineId\": 202,\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 4,\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 96.00,\n \"appliedDiscount\": 4.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124568,\n \"discount\": 1.00\n }\n ]\n },\n {\n \"shipmentLineId\": 203,\n \"skuId\": \"MALIN/Medium/12\",\n \"barcode\": \"5055964790061\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790061\"\n ],\n \"UPC\": [\n \"5055964790012\"\n ]\n },\n \"quantity\": 1,\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 24.00,\n \"appliedDiscount\": 1.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124569,\n \"discount\": 1.00\n }\n ]\n }\n ],\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 2.00\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Ann's Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n },\n \"parcels\": [\n {\n \"dispatchDate\": \"2022-05-27T13:19:28Z\",\n \"fulfilmentLocationId\": 100,\n \"dispatchedItems\": [\n {\n \"skuId\": \"Loreal/Black/40\",\n \"barcode\": \"5055964790059\",\n \"quantity\": 2\n }\n ],\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"string\",\n \"paymentType\": \"CREDIT_CARD\",\n \"paymentStatus\": \"PAYMENT_CHARGED\",\n \"amount\": {\n \"currency\": \"GBP\",\n \"value\": 48.00,\n \"vat\": 0.00\n }\n }\n ],\n \"labelBarcode\": \"THG245645704\",\n \"trackingNumber\": \"HZYEJC0131117751\",\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=HZYEJC0131117751\",\n \"parcelId\": \"THG245645704Parcel\"\n },\n {\n \"dispatchDate\": \"2022-05-27T13:19:28Z\",\n \"fulfilmentLocationId\": 100,\n \"dispatchedItems\": [\n {\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"quantity\": 4\n }\n ],\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"string\",\n \"paymentType\": \"CREDIT_CARD\",\n \"paymentStatus\": \"PAYMENT_CHARGED\",\n \"amount\": {\n \"currency\": \"GBP\",\n \"value\": 96.00,\n \"vat\": 0.00\n }\n }\n ],\n \"labelBarcode\": \"THG245645705\",\n \"trackingNumber\": \"HZYEJC0131117752\",\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=HZYEJC0131117752\",\n \"parcelId\": \"THG245645705Parcel\"\n },\n {\n \"dispatchDate\": \"2022-05-27T13:19:28Z\",\n \"fulfilmentLocationId\": 100,\n \"dispatchedItems\": [\n {\n \"skuId\": \"MALIN/Medium/12\",\n \"barcode\": \"5055964790061\",\n \"quantity\": 1\n }\n ],\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"string\",\n \"paymentType\": \"CREDIT_CARD\",\n \"paymentStatus\": \"PAYMENT_CHARGED\",\n \"amount\": {\n \"currency\": \"GBP\",\n \"value\": 24.00,\n \"vat\": 0.00\n }\n }\n ],\n \"labelBarcode\": \"THG245645706\",\n \"trackingNumber\": \"HZYEJC0131117753\",\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=HZYEJC0131117753\",\n \"parcelId\": \"THG245645706Parcel\"\n }\n ]\n }\n ],\n \"returns\": [\n {\n \"returnShipmentNumber\": 245645705,\n \"createdDate\": \"2022-05-30T13:19:28Z\",\n \"returnChannel\": {\n \"locationId\": 100,\n \"locationName\": \"WEB\"\n },\n \"returnDate\": \"20220530\",\n \"returnLines\": [\n {\n \"skuId\": \"MALIN/Medium/12\",\n \"barcode\": \"5055964790061\",\n \"productType\": \"DROP\",\n \"sellerId\": \"sellerId\",\n \"quantity\": 1,\n \"returnReason\": {\n \"reasonId\": 1,\n \"reasonName\": \"Damaged item\",\n \"returnStatus\": \"DAMAGED\"\n }\n }\n ]\n }\n ],\n \"refunds\": [\n {\n \"refundId\": \"1235878\",\n \"refundDate\": \"2022-05-30T13:19:28Z\",\n \"refundType\": \"Refund\",\n \"refundStatus\": \"REFUND_SUCCESS\",\n \"totalRefundAmount\": {\n \"includesOrderShippingCost\": true,\n \"shippingAmount\": 3.0,\n \"currency\": \"GBP\",\n \"value\": 27.0\n },\n \"refundItems\": [\n {\n \"skuId\": \"MALIN/Medium/12\",\n \"barcode\": \"5055964790061\",\n \"quantity\": 1,\n \"currency\": \"GBP\",\n \"unitPrice\": 24.0,\n \"returnReasonId\": 1\n }\n ],\n \"processedByStore\": \"sellerId\",\n \"updateStoreStock\": false,\n \"fulfilmentChannel\": {\n \"locationId\": 100,\n \"locationName\": \"WEB\"\n }\n }\n ],\n \"donations\": []\n}","options":{"raw":{"language":"json"}}},"url":"/order/fullOrderView"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"c7680efb-7a5a-4664-b3bb-791382b97e23","name":"FOV (ORDER_REFUNDED - Shipment REFUNDED when an item is returned to STORE)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"orderId\": \"405524478\",\n \"orderCreatedDate\": \"2022-05-19T13:19:28Z\",\n \"orderStatus\": \"ORDER_REFUNDED\",\n \"deliveryType\": \"STANDARD\",\n \"orderAmount\": {\n \"currency\": \"GBP\",\n \"totalAmount\": 166.00,\n \"vat\": 2.00,\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 3.00\n }\n },\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"string\",\n \"paymentType\": \"CREDIT_CARD\",\n \"paymentStatus\": \"PAYMENT_AUTHORISED\",\n \"amount\": 166.00\n }\n ],\n \"orderLineItems\": [\n {\n \"skuId\": \"Loreal/Black/40\",\n \"barcode\": \"5055964790059\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790059\"\n ],\n \"UPC\": [\n \"5055964790010\"\n ]\n },\n \"quantity\": 2,\n \"fulfilmentChannel\": {\n \"locationId\": 100,\n \"locationName\": \"WEB\"\n },\n \"deliveryType\": \"STANDARD\",\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 48.00,\n \"appliedDiscount\": 2.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124567,\n \"discount\": 1.00\n }\n ]\n },\n {\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 4,\n \"fulfilmentChannel\": {\n \"locationId\": 100,\n \"locationName\": \"WEB\"\n },\n \"deliveryType\": \"STANDARD\",\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 96.00,\n \"appliedDiscount\": 4.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124568,\n \"discount\": 1.00\n }\n ]\n },\n {\n \"skuId\": \"MALIN/Medium/12\",\n \"barcode\": \"5055964790061\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790061\"\n ],\n \"UPC\": [\n \"5055964790012\"\n ]\n },\n \"quantity\": 1,\n \"fulfilmentChannel\": {\n \"locationId\": 100,\n \"locationName\": \"WEB\"\n },\n \"deliveryType\": \"STANDARD\",\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 24.00,\n \"appliedDiscount\": 1.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124569,\n \"discount\": 1.00\n }\n ]\n }\n ],\n \"customerInfo\": {\n \"emailId\": \"marrie.cze@gmail.com\",\n \"mobileNumber\": \"07898786666\",\n \"billingAddress\": {\n \"name\": \"Marie Culloden\",\n \"houseNameNumber\": \"11\",\n \"streetName\": \"Mellon Lane\",\n \"line2\": \"Byron Apartments\",\n \"line3\": \"Lanes End\",\n \"line4\": \"Manchester\",\n \"country\": \"GB\",\n \"postCode\": \"M33 6PS\"\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Anns Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n }\n },\n \"shipments\": [\n {\n \"shipmentNumber\": \"245645704\",\n \"shipmentType\": \"B2C\",\n \"fulfilmentChannel\": {\n \"locationId\": 100,\n \"locationName\": \"WEB\"\n },\n \"deliveryType\": \"STANDARD\",\n \"shipmentStatus\": \"REFUNDED\",\n \"shipmentLines\": [\n {\n \"shipmentLineId\": 201,\n \"skuId\": \"Loreal/Black/40\",\n \"barcode\": \"5055964790059\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790059\"\n ],\n \"UPC\": [\n \"5055964790010\"\n ]\n },\n \"quantity\": 2,\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 48.00,\n \"appliedDiscount\": 2.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124567,\n \"discount\": 1.00\n }\n ]\n },\n {\n \"shipmentLineId\": 202,\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 4,\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 96.00,\n \"appliedDiscount\": 4.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124568,\n \"discount\": 1.00\n }\n ]\n },\n {\n \"shipmentLineId\": 203,\n \"skuId\": \"MALIN/Medium/12\",\n \"barcode\": \"5055964790061\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790061\"\n ],\n \"UPC\": [\n \"5055964790012\"\n ]\n },\n \"quantity\": 1,\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 24.00,\n \"appliedDiscount\": 1.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 1.00\n },\n \"offers\": [\n {\n \"offerId\": 124569,\n \"discount\": 1.00\n }\n ]\n }\n ],\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 2.00\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Ann's Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n },\n \"parcels\": [\n {\n \"dispatchDate\": \"2022-05-27T13:19:28Z\",\n \"fulfilmentLocationId\": 100,\n \"dispatchedItems\": [\n {\n \"skuId\": \"Loreal/Black/40\",\n \"barcode\": \"5055964790059\",\n \"quantity\": 2\n }\n ],\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"string\",\n \"paymentType\": \"CREDIT_CARD\",\n \"paymentStatus\": \"PAYMENT_CHARGED\",\n \"amount\": {\n \"currency\": \"GBP\",\n \"value\": 48.00,\n \"vat\": 0.00\n }\n }\n ],\n \"labelBarcode\": \"THG245645704\",\n \"trackingNumber\": \"HZYEJC0131117751\",\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=HZYEJC0131117751\",\n \"parcelId\": \"THG245645704Parcel\"\n },\n {\n \"dispatchDate\": \"2022-05-27T13:19:28Z\",\n \"fulfilmentLocationId\": 100,\n \"dispatchedItems\": [\n {\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"quantity\": 4\n }\n ],\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"string\",\n \"paymentType\": \"CREDIT_CARD\",\n \"paymentStatus\": \"PAYMENT_CHARGED\",\n \"amount\": {\n \"currency\": \"GBP\",\n \"value\": 96.00,\n \"vat\": 0.00\n }\n }\n ],\n \"labelBarcode\": \"THG245645705\",\n \"trackingNumber\": \"HZYEJC0131117752\",\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=HZYEJC0131117752\",\n \"parcelId\": \"THG245645705Parcel\"\n },\n {\n \"dispatchDate\": \"2022-05-27T13:19:28Z\",\n \"fulfilmentLocationId\": 100,\n \"dispatchedItems\": [\n {\n \"skuId\": \"MALIN/Medium/12\",\n \"barcode\": \"5055964790061\",\n \"quantity\": 1\n }\n ],\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"string\",\n \"paymentType\": \"CREDIT_CARD\",\n \"paymentStatus\": \"PAYMENT_CHARGED\",\n \"amount\": {\n \"currency\": \"GBP\",\n \"value\": 24.00,\n \"vat\": 0.00\n }\n }\n ],\n \"labelBarcode\": \"THG245645706\",\n \"trackingNumber\": \"HZYEJC0131117753\",\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=HZYEJC0131117753\",\n \"parcelId\": \"THG245645706Parcel\"\n }\n ]\n }\n ],\n \"returns\": [\n {\n \"returnShipmentNumber\": 245645705,\n \"createdDate\": \"2022-05-30T13:19:28Z\",\n \"returnChannel\": {\n \"locationId\": 101,\n \"locationName\": \"STORE\"\n },\n \"returnDate\": \"20220530\",\n \"returnLines\": [\n {\n \"skuId\": \"MALIN/Medium/12\",\n \"barcode\": \"5055964790061\",\n \"productType\": \"DROP\",\n \"sellerId\": \"sellerId\",\n \"quantity\": 1,\n \"returnReason\": {\n \"reasonId\": 0,\n \"reasonName\": \"Damaged item\",\n \"returnStatus\": \"DAMAGED\"\n }\n }\n ]\n }\n ],\n \"refunds\": [\n {\n \"refundId\": \"1235878\",\n \"refundDate\": \"2022-05-30T13:19:28Z\",\n \"refundType\": \"Refund\",\n \"refundStatus\": \"REFUND_SUCCESS\",\n \"totalRefundAmount\": {\n \"includesOrderShippingCost\": true,\n \"shippingAmount\": 3.0,\n \"currency\": \"GBP\",\n \"value\": 27.0\n },\n \"refundItems\": [\n {\n \"skuId\": \"MALIN/Medium/12\",\n \"barcode\": \"5055964790061\",\n \"quantity\": 1,\n \"currency\": \"GBP\",\n \"unitPrice\": 24.0,\n \"returnReasonId\": 1\n }\n ],\n \"processedByStore\": \"sellerId\",\n \"updateStoreStock\": false,\n \"fulfilmentChannel\": {\n \"locationId\": 101,\n \"locationName\": \"STORE\"\n }\n }\n ],\n \"donations\": []\n}","options":{"raw":{"language":"json"}}},"url":"/order/fullOrderView"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"f1d745e3-c4f7-4788-8a66-178e4672e9ac","name":"FOV (ORDER_PROCESSING - Dropship Shipments Released)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"orderId\": \"405524478\",\n \"orderCreatedDate\": \"2022-05-19T13:19:28Z\",\n \"orderStatus\": \"ORDER_PROCESSING\",\n \"deliveryType\": \"STANDARD\",\n \"orderAmount\": {\n \"currency\": \"GBP\",\n \"totalAmount\": 205.00,\n \"vat\": 0.00,\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 5.00\n }\n },\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"VISA\",\n \"paymentType\": \"CREDIT_CARD\",\n \"paymentStatus\": \"PAYMENT_AUTHORISED\",\n \"amount\": 205.00\n }\n ],\n \"orderLineItems\": [\n {\n \"skuId\": \"MALIN/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 1,\n \"fulfilmentChannel\": {\n \"locationId\": 300,\n \"locationName\": \"DROP\"\n },\n \"deliveryType\": \"STANDARD\",\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 205.00,\n \"appliedDiscount\": 0.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 100.00,\n \"discountAmount\": 0.00\n },\n \"offers\": [\n {\n \"offerId\": 0,\n \"discount\": 0.00\n }\n ]\n }\n ],\n \"customerInfo\": {\n \"emailId\": \"marrie.cze@gmail.com\",\n \"mobileNumber\": \"07898786666\",\n \"billingAddress\": {\n \"name\": \"Marie Culloden\",\n \"houseNameNumber\": \"11\",\n \"streetName\": \"Mellon Lane\",\n \"line2\": \"Byron Apartments\",\n \"line3\": \"Lanes End\",\n \"line4\": \"Manchester\",\n \"country\": \"GB\",\n \"postCode\": \"M33 6PS\"\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Anns Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n }\n },\n \"shipments\": [\n {\n \"shipmentNumber\": \"245645705\",\n \"shipmentType\": \"B2C\",\n \"fulfilmentChannel\": {\n \"locationId\": 300,\n \"locationName\": \"DROP\"\n },\n \"deliveryType\": \"STANDARD\",\n \"shipmentStatus\": \"RELEASED\",\n \"shipmentLines\": [\n {\n \"shipmentLineId\": 202,\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ]\n },\n \"quantity\": 2,\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 205.00,\n \"appliedDiscount\": 0.00,\n \"vat\": 0.00\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 100.00,\n \"discountAmount\": 0.00\n },\n \"offers\": []\n }\n ],\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 5.00\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"companyName\": null,\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Ann's Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n },\n \"parcels\": []\n }\n ],\n \"returns\": [],\n \"refunds\": [],\n \"donations\": []\n}","options":{"raw":{"language":"json"}}},"url":"/order/fullOrderView"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"1a060bb4-9986-44d3-ab95-3a6b75f14ddf","name":"FOV (ORDER_PROCESSING - Dropship Parcel Dispatch, Shipment OPEN)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"orderId\": \"405524478\",\n \"orderCreatedDate\": \"2022-05-19T13:19:28Z\",\n \"orderStatus\": \"ORDER_PROCESSING\",\n \"deliveryType\": \"STANDARD\",\n \"orderAmount\": {\n \"currency\": \"GBP\",\n \"totalAmount\": 205.00,\n \"vat\": 0.00,\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 5.00\n }\n },\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"VISA\",\n \"paymentType\": \"CREDIT_CARD\",\n \"paymentStatus\": \"PAYMENT_AUTHORISED\",\n \"amount\": 205.00\n }\n ],\n \"orderLineItems\": [\n {\n \"skuId\": \"MALIN/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 1,\n \"fulfilmentChannel\": {\n \"locationId\": 300,\n \"locationName\": \"DROP\"\n },\n \"deliveryType\": \"STANDARD\",\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 205.00,\n \"appliedDiscount\": 0.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 100.00,\n \"discountAmount\": 0.00\n },\n \"offers\": [\n {\n \"offerId\": 0,\n \"discount\": 0.00\n }\n ]\n }\n ],\n \"customerInfo\": {\n \"emailId\": \"marrie.cze@gmail.com\",\n \"mobileNumber\": \"07898786666\",\n \"billingAddress\": {\n \"name\": \"Marie Culloden\",\n \"houseNameNumber\": \"11\",\n \"streetName\": \"Mellon Lane\",\n \"line2\": \"Byron Apartments\",\n \"line3\": \"Lanes End\",\n \"line4\": \"Manchester\",\n \"country\": \"GB\",\n \"postCode\": \"M33 6PS\"\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Anns Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n }\n },\n \"shipments\": [\n {\n \"shipmentNumber\": \"222222222\",\n \"shipmentType\": \"B2C\",\n \"fulfilmentChannel\": {\n \"locationId\": 300,\n \"locationName\": \"DROP\"\n },\n \"deliveryType\": \"STANDARD\",\n \"shipmentStatus\": \"OPEN\",\n \"shipmentLines\": [\n {\n \"shipmentLineId\": 202,\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ]\n },\n \"quantity\": 2,\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 205.00,\n \"appliedDiscount\": 0.00,\n \"vat\": 0.00\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 100.00,\n \"discountAmount\": 0.00\n },\n \"offers\": []\n }\n ],\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 5.00\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"companyName\": null,\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Ann's Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n },\n \"parcels\": [\n {\n \"dispatchDate\": \"2022-05-27T13:19:28Z\",\n \"fulfilmentLocationId\": 300,\n \"dispatchedItems\": [\n {\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"3600520761145\",\n \"quantity\": 1\n }\n ],\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"VISA\",\n \"paymentType\": \"CREDIT_CARD\",\n \"paymentStatus\": \"PAYMENT_CHARGED\",\n \"amount\": {\n \"currency\": \"GBP\",\n \"value\": 105.00,\n \"vat\": 0.00\n }\n }\n ],\n \"labelBarcode\": \"Do_We_Get_This_From_Mirakl?\",\n \"trackingNumber\": \"HZYEJC0131117751\",\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=HZYEJC0131117751\",\n \"parcelId\": \"THG245645704Parcel\"\n }\n ]\n }\n ],\n \"returns\": [],\n \"refunds\": [],\n \"donations\": []\n}","options":{"raw":{"language":"json"}}},"url":"/order/fullOrderView"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"95cc36f9-0340-490a-a8f8-4c99e3eb421d","name":"FOV (ORDER_PROCESSING - Dropship Parcel Dispatch, Shipment CLOSED)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"orderId\": \"405524478\",\n \"orderCreatedDate\": \"2022-05-19T13:19:28Z\",\n \"orderStatus\": \"ORDER_PROCESSED\",\n \"deliveryType\": \"STANDARD\",\n \"orderAmount\": {\n \"currency\": \"GBP\",\n \"totalAmount\": 205.00,\n \"vat\": 0.00,\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 5.00\n }\n },\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"VISA\",\n \"paymentType\": \"CREDIT_CARD\",\n \"paymentStatus\": \"PAYMENT_AUTHORISED\",\n \"amount\": 205.00\n }\n ],\n \"orderLineItems\": [\n {\n \"skuId\": \"MALIN/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 1,\n \"fulfilmentChannel\": {\n \"locationId\": 300,\n \"locationName\": \"DROP\"\n },\n \"deliveryType\": \"STANDARD\",\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 205.00,\n \"appliedDiscount\": 0.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 100.00,\n \"discountAmount\": 0.00\n },\n \"offers\": [\n {\n \"offerId\": 0,\n \"discount\": 0.00\n }\n ]\n }\n ],\n \"customerInfo\": {\n \"emailId\": \"marrie.cze@gmail.com\",\n \"mobileNumber\": \"07898786666\",\n \"billingAddress\": {\n \"name\": \"Marie Culloden\",\n \"houseNameNumber\": \"11\",\n \"streetName\": \"Mellon Lane\",\n \"line2\": \"Byron Apartments\",\n \"line3\": \"Lanes End\",\n \"line4\": \"Manchester\",\n \"country\": \"GB\",\n \"postCode\": \"M33 6PS\"\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Anns Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n }\n },\n \"shipments\": [\n {\n \"shipmentNumber\": \"222222222\",\n \"shipmentType\": \"B2C\",\n \"fulfilmentChannel\": {\n \"locationId\": 300,\n \"locationName\": \"DROP\"\n },\n \"deliveryType\": \"STANDARD\",\n \"shipmentStatus\": \"CLOSED\",\n \"shipmentLines\": [\n {\n \"shipmentLineId\": 202,\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ]\n },\n \"quantity\": 2,\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 205.00,\n \"appliedDiscount\": 0.00,\n \"vat\": 0.00\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 100.00,\n \"discountAmount\": 0.00\n },\n \"offers\": []\n }\n ],\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 5.00\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"companyName\": null,\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Ann's Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n },\n \"parcels\": [\n {\n \"dispatchDate\": \"2022-05-27T13:19:28Z\",\n \"fulfilmentLocationId\": 300,\n \"dispatchedItems\": [\n {\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"3600520761145\",\n \"quantity\": 1\n }\n ],\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"VISA\",\n \"paymentType\": \"CREDIT_CARD\",\n \"paymentStatus\": \"PAYMENT_CHARGED\",\n \"amount\": {\n \"currency\": \"GBP\",\n \"value\": 105.00,\n \"vat\": 0.00\n }\n }\n ],\n \"labelBarcode\": \"Jen_to_get_details_from_Mirakl\",\n \"trackingNumber\": \"HZYEJC0131117751\",\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=HZYEJC0131117751\",\n \"parcelId\": \"THG245645704Parcel\"\n }\n ]\n }\n ],\n \"returns\": [],\n \"refunds\": [],\n \"donations\": []\n}","options":{"raw":{"language":"json"}}},"url":"/order/fullOrderView"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"50e2d252-b732-48fc-82ff-2ff51df1b6f2","name":"FOV (Failure)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"orderId\": \"405524478\",\n \"orderCreatedDate\": \"2022-05-19T13:19:28Z\",\n \"orderStatus\": \"ORDER_PLACED\",\n \"orderAmount\": {\n \"currency\": \"GBP\",\n \"totalAmount\": 204.00,\n \"vat\": 5.00,\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 3.00\n }\n },\n \"deliveryType\": \"STANDARD\",\n \"paymentInfo\": [\n {\n \"paymentMethod\": \"string\",\n \"paymentType\": \"CREDIT_CARD || DEBIT_CARD || CASH || GIFT_CARD\",\n \"paymentStatus\": \"PAYMENT_AUTHORISED\",\n \"amount\": 204.00\n }\n ],\n \"orderLineItems\": [\n {\n \"skuId\": \"Loreal/Black/40\",\n \"barcode\": \"5055964790059\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790059\"\n ],\n \"UPC\": [\n \"5055964790010\"\n ]\n },\n \"quantity\": 2,\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 40.00,\n \"appliedDiscount\": 10.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 5.00\n },\n \"offers\": [\n {\n \"offerId\": 124567,\n \"discount\": 10.00\n }\n ]\n },\n {\n \"skuId\": \"TedBaker/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 4,\n \"fulfilmentChannel\": {\n \"locationId\": 200,\n \"locationName\": \"STORE\"\n },\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 75.00,\n \"appliedDiscount\": 25.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 25.00,\n \"discountAmount\": 6.25\n },\n \"offers\": [\n {\n \"offerId\": 124567,\n \"discount\": 25.00\n }\n ]\n },\n {\n \"skuId\": \"MALIN/Medium/12\",\n \"barcode\": \"5055964790060\",\n \"barcodes\": {\n \"EAN\": [\n \"5055964790060\"\n ],\n \"UPC\": [\n \"5055964790011\"\n ]\n },\n \"quantity\": 1,\n \"fulfilmentChannel\": {\n \"locationId\": 300,\n \"locationName\": \"DROP\"\n },\n \"expectedDispatchDate\": \"2022-05-27T13:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 100.00,\n \"appliedDiscount\": 50.00,\n \"vat\": 0\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"actualAmount\": 100.00,\n \"discountAmount\": 50.00\n },\n \"offers\": [\n {\n \"offerId\": 124567,\n \"discount\": 50.00\n }\n ]\n }\n ],\n \"customerInfo\": {\n \"emailId\": \"marrie.cze@gmail.com\",\n \"mobileNumber\": \"07898786666\",\n \"billingAddress\": {\n \"name\": \"Marie Culloden\",\n \"houseNameNumber\": \"11\",\n \"streetName\": \"Mellon Lane\",\n \"line2\": \"Byron Apartments\",\n \"line3\": \"Lanes End\",\n \"line4\": \"Manchester\",\n \"country\": \"GB\",\n \"postCode\": \"M33 6PS\"\n },\n \"shippingAddress\": {\n \"name\": \"Lisa Thomas\",\n \"houseNameNumber\": \"25\",\n \"streetName\": \"St Anns Lane\",\n \"line2\": \"Regency Apartments\",\n \"line3\": \"Abbey Centre\",\n \"line4\": \"Salford\",\n \"country\": \"GB\",\n \"postCode\": \"M17 1HE\"\n }\n },\n \"shipments\": [],\n \"returns\": [],\n \"refunds\": [],\n \"donations\": []\n}","options":{"raw":{"language":"json"}}},"url":"/order/fullOrderView"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"9ba4ea95-a0a7-45e7-9939-35ff5ad06819"}],"id":"1605c13b-47b3-40f7-8893-d2212dbf13ad","_postman_id":"1605c13b-47b3-40f7-8893-d2212dbf13ad","description":""}],"id":"051fb29e-7a95-418c-86e4-20f4d25e10f2","_postman_id":"051fb29e-7a95-418c-86e4-20f4d25e10f2","description":""},{"name":"Pricing","item":[{"name":"Outbound","item":[{"name":"Pricing Update Response ref: PRI.O.01","id":"56dd3c0e-2bd0-4e67-b3fd-121ec0052fd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"To be defined by client","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error	Description
E1	Internal Error , something has gone wrong with the service , please report to Thg. Once resolved please re submit.
E2	Product Does not exists, or Price entry missing please check if product is created in internal systems and price is correct. Once corrected please re submit

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"batchId\": {\n      \"type\": \"string\"\n    },\n    \"products\": {\n      \"type\": \"object\",\n      \"items\": {\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"SKU\": {\n              \"type\": \"string\"\n            },\n            \"success\": {\n              \"type\": \"boolean\"\n            },\n            \"errorCode\": {\n              \"type\": \"string\"\n            },\n            \"errorReason\": {\n              \"type\": \"string\"\n            }\n          },\n          \"required\": [\n            \"SKU\",\n            \"success\"\n          ]\n        }\n      }\n    }\n  },\n  \"required\": [\n    \"batchId\",\n    \"products\"\n  ]\n}\n\n

\n","urlObject":{"host":["To be defined by client"],"query":[],"variable":[]}},"response":[{"id":"665f33a2-a73d-485f-bf16-6301a94b968b","name":"Pricing Update (Success)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"batchId\": \"9709bf12-db55-11ec-9d64-0242ac120002\",\n \"products\": {\n {\n \"SKU\": \"PD234SX\",\n \"success\" : false,\n \"errorCode\" : \"E1\",\n \"errorReason\": \"does not exist\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":"To be defined by client"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"56dd3c0e-2bd0-4e67-b3fd-121ec0052fd2"}],"id":"8fb55b37-9673-478a-943d-733eb4a76dcc","_postman_id":"8fb55b37-9673-478a-943d-733eb4a76dcc","description":""},{"name":"Inbound","item":[{"name":"Pricing Bulk Update ref: PRI.I.01","id":"b7f6f863-0a8d-441f-b2a2-33b15f011e25","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"batchId\": \"string\",\n \"organisation\": \"string\",\n \"site\": \"string\",\n \"locale\": \"string\",\n \"shippingGroup\": \"string\",\n \"currency\": \"GBP\",\n \"products\": [\n {\n \"sku\": \"string\",\n \"rrp\": 0.00,\n \"sellingPrice\": 0.00\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/products/price/bulk ","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

ResponseCode	Meaning
202	Request accepted for Async processing
400	Bad Request , validation failed for the data
500	Internal Error, could not process request. Raise with Thg, Once resolved please re submit the request.

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"batchId\": {\n      \"type\": \"string\"\n    },\n    \"organisation\": {\n      \"type\": \"string\"\n    },\n    \"site\": {\n      \"type\": \"string\"\n    },\n    \"locale\": {\n      \"type\": \"string\"\n    },\n    \"shippingGroup\": {\n      \"type\": \"string\"\n    },\n    \"currency\": {\n      \"type\": \"string\"\n    },\n    \"products\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"sku\": {\n              \"type\": \"string\"\n            },\n            \"rrp\": {\n              \"type\": \"number\"\n            },\n            \"sellingPrice\": {\n              \"type\": \"number\"\n            }\n          },\n          \"required\": [\n            \"sku\",\n            \"rrp\",\n            \"sellingPrice\"\n          ]\n        }\n      ]\n    }\n  },\n  \"required\": [\n    \"batchId\",\n    \"organisation\",\n    \"site\",\n    \"locale\",\n    \"shippingGroup\",\n    \"currency\",\n    \"products\"\n  ]\n}\n\n

\n","urlObject":{"path":["products","price","bulk "],"host":[""],"query":[],"variable":[]}},"response":[{"id":"42c9f03a-c1db-4917-a8c9-6ff9e57b5340","name":"Pricing Bulk Update (Success)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"batchId\": \"9709bf12-db55-11ec-9d64-0242ac120002\",\n \"organisation\": \"matalan\",\n \"site\": \"matalan\",\n \"locale\": \"en_GB\",\n \"shippingGroup\": \"265\",\n \"currency\": \"GBP\",\n \"products\": [\n {\n \"sku\": \"PD234SX\",\n \"rrp\": 86.99,\n \"sellingPrice\": 76.99\n },\n {\n \"sku\": \"PD235SX\",\n \"rrp\": 86.99,\n \"sellingPrice\": 76.99\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/products/price/bulk"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"batchId\": \"9709bf12-db55-11ec-9d64-0242ac120002\"\n}"},{"id":"eee1c99c-692f-4c79-8363-b90e9e6b9500","name":"Pricing Bulk Update (Failure)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"batchId\": \"9709bf12-db55-11ec-9d64-0242ac120002\",\n \"organisation\": \"matalan\",\n \"site\": \"matalan\",\n \"locale\": \"en_GB\",\n \"shippingGroup\": \"265\",\n \"currency\": \"GBP\",\n \"products\": [\n {\n \"sku\": \"PD234SX\",\n \"productId\": \"123456\",\n \"rrp\": 86.99,\n \"sellingprice\": 76.99\n },\n {\n \"sku\": \"PD234SX\",\n \"productId\": \"123456\",\n \"rrp\": 86.99,\n \"sellingprice\": 76.99\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/products/price/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"category\": \"INVALID_ID\",\n \"message\": \"string\"\n }\n ]\n}"},{"id":"a70089fa-bcf5-4036-b962-f7499a3eade7","name":"Pricing Bulk Update ref: PRI.I.01","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"batchId\": \"string\",\n \"organisation\": \"string\",\n \"site\": \"string\",\n \"locale\": \"string\",\n \"shippingGroup\": \"string\",\n \"currency\": \"GBP\",\n \"products\": [\n {\n \"sku\": \"string\",\n \"rrp\": 0.00,\n \"sellingPrice\": 0.00\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/products/price/bulk "},"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null}],"_postman_id":"b7f6f863-0a8d-441f-b2a2-33b15f011e25"}],"id":"ec54411f-a7e1-4709-b763-3788ede8ecc7","_postman_id":"ec54411f-a7e1-4709-b763-3788ede8ecc7","description":""}],"id":"e71ce4e9-45a5-4247-b714-18da942f3f44","_postman_id":"e71ce4e9-45a5-4247-b714-18da942f3f44","description":""},{"name":"Product Information","item":[{"name":"Product created webhook ref: PRO.O.01","id":"c2536f67-e28a-4606-a4bb-e4c23196eb46","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"entityErpId\" : \"THG-en_gb\",\r\n \"itemErpId\": \"SKU\",\r\n \"productID\": \"1234567891234\"\r\n \"success\" : false,\r\n \"errorCode\" : \"E1\",\r\n \"errorReason\" : \"Failure\"\r\n}\r\n"},"url":"POST API URL to be defined by the client. This API must use basic or bearer authentication","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error	Reason
E1	Internal Error, Please raise it with Thg. Once resolved please re submit.

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"entityErpId\": {\n      \"type\": \"string\"\n    },\n    \"itemErpId\": {\n      \"type\": \"string\"\n    },\n    \"productID\": {\n      \"type\": \"string\"\n    },\n    \"success\": {\n      \"type\": \"boolean\"\n    },\n    \"errorCode\": {\n      \"type\": \"string\"\n    },\n    \"errorReason\": {\n      \"type\": \"string\"\n    }\n  },\n  \"required\": [\n    \"entityErpId\",\n    \"itemErpId\",\n    \"productID\",\n    \"success\"\n  ]\n}\n\n

\n","urlObject":{"host":["POST API URL to be defined by the client"," This API must use basic or bearer authentication"],"query":[],"variable":[]}},"response":[],"_postman_id":"c2536f67-e28a-4606-a4bb-e4c23196eb46"},{"name":"Insert and update product and content ref: PRO.I.01","id":"03a48d7b-b377-4df3-92b8-8be1e4e2e4a8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"itemErpId\": \"SKU\",\n \"name\": \"Ryobi ONE+ 18V 4.0Ah Battery RB18L40\",\n \"priority\": true,\n \"enricherErpId\": \"RY001\",\n \"groupErpId\": \"ART_GRASS\",\n \"supplierErpId\" : \"BOSCH\",\n \"content\": [\n {\n \"fieldErpId\": \"FieldErpId\",\n \"value\": [\"Field content\"],\n \"properties\": [\n {\n \"fieldErpId\": \"string\",\n \"value\": [\"string\"]\n }\n ]\n }\n ],\n \"childItems\": [\n {\n \"erpId\": \"string\",\n \"content\": [\n {\n \"fieldErpId\": \"FieldErpId\",\n \"value\": [\"Field content\"]\n }\n ]\n }\n ],\n \"active\": false\n}","options":{"raw":{"language":"json"}}},"url":"/v1/entities/{entityErpId}/items","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Response	Description
200	All OK, Created
400	BAD request. Most likely validation error.

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
itemErpId	String	Yes	The SKU of the MASTER product
name	String	Yes	The name of the MASTER product
priority	Boolean	Yes	The PIM prioritizes priority items, use at your peril
enricherErpId	String	No	Can be left out, will default per collection
groupErpId	String	No	This is the product group ID from Matalan that is configured as erp_id for the product groups
supplier_erp_id	String	No	The code of the supplier for these products if external suppliers are recognised, otherwise default to your own supplier ID
content	Object	Yes	Content (object details below)
childItems	Object	Yes	Contains ERP Identifier & Content (object details below)
active	Boolean	Yes	Set to true this will be enriched, set to false this will stay in the system but not actively enriched

Content

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
fieldErpId	String	Yes	KEY in the Key-Value Pair content collection Allowed Keys: Please refer to KVP-Master & for child items refer to KVP-Child table below
value	String array	Yes	Value in the Key Value Pair content collection which can be multiple values for certain field types, like multi-select, images, documents, video's
properties	Nested content collection	No	This is only used for image properties and values, like ALT text, end of model contract data, disclaimers.

KVP-Master

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Allowed Values	Description
thg.sku	The SKU of the master product
thg.title	The TITLE of the master product
thg.product.type	The product type of the master product. Once we have the product groups defined we can define this on product group level and you can omit it in the product data
thg.length	The LENGTH of the master product in mm
thg.width	The WIDTH of the master product in mm
thg.height	The HEIGHT of the master product in mm
thg.weight	The WEIGHT of the master product in grams
thg.size	The SIZZE of the master product
thg.tax	Vat rate for the product , standard rate, reduced rate or zero rate.
thg.rrp	The RRP of the master product
thg.coo	The COO of the master product (ISO 3166-1 alpha-2 country code)
thg.hscode	The HSCODE of the master product
thg.hazmat	The HAZMAT of the master product (Yes/No)
thg.ean.barcode	BARCODE of the master or just default value

KVP-Child

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Allowed Values	Description
thg.sku	The SKU of the child product
thg.tax	VAT for the child product
barcode_list	Comma separated barcodes for child.
child size description	Size for the children.

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"itemErpId\": {\n      \"type\": \"string\"\n    },\n    \"name\": {\n      \"type\": \"string\"\n    },\n    \"priority\": {\n      \"type\": \"boolean\"\n    },\n    \"enricherErpId\": {\n      \"type\": \"string\"\n    },\n    \"groupErpId\": {\n      \"type\": \"string\"\n    },\n    \"supplierErpId\": {\n      \"type\": \"string\"\n    },\n    \"content\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"fieldErpId\": {\n              \"type\": \"string\"\n            },\n            \"value\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"string\"\n                }\n              ]\n            },\n            \"properties\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"fieldErpId\": {\n                      \"type\": \"string\"\n                    },\n                    \"value\": {\n                      \"type\": \"array\",\n                      \"items\": [\n                        {\n                          \"type\": \"string\"\n                        }\n                      ]\n                    }\n                  },\n                  \"required\": [\n                    \"fieldErpId\",\n                    \"value\"\n                  ]\n                }\n              ]\n            }\n          },\n          \"required\": [\n            \"fieldErpId\",\n            \"value\",\n            \"properties\"\n          ]\n        }\n      ]\n    },\n    \"childItems\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"erpId\": {\n              \"type\": \"string\"\n            },\n            \"content\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"fieldErpId\": {\n                      \"type\": \"string\"\n                    },\n                    \"value\": {\n                      \"type\": \"array\",\n                      \"items\": [\n                        {\n                          \"type\": \"string\"\n                        }\n                      ]\n                    }\n                  },\n                  \"required\": [\n                    \"fieldErpId\",\n                    \"value\"\n                  ]\n                }\n              ]\n            }\n          },\n          \"required\": [\n            \"erpId\",\n            \"content\"\n          ]\n        }\n      ]\n    },\n    \"active\": {\n      \"type\": \"boolean\"\n    }\n  },\n  \"required\": [\n    \"itemErpId\",\n    \"name\",\n    \"priority\",\n    \"enricherErpId\",\n    \"groupErpId\",\n    \"supplierErpId\",\n    \"content\",\n    \"childItems\",\n    \"active\"\n  ]\n}\n\n

JSON Example - fieldErpId can be configured and is not fixed.

{\n  \"itemErpId\": \"621215\",\n  \"name\": \"SHORT SAG NAVY\",\n  \"priority\": true,\n  \"groupErpId\": \"ApparelMaster\",\n  \"content\": [\n    {\n      \"fieldErpId\": \"colour\",\n      \"value\": \"NAVY\",\n      \"properties\": []\n    },\n    {\n      \"fieldErpId\": \"seasoncode\",\n      \"value\": \"6/21Q2/STD\",\n      \"properties\": []\n    },\n    {\n      \"fieldErpId\": \"season\",\n      \"value\": \"21Q2\"\n    },\n    {\n      \"fieldErpId\": \"targetgroupname\",\n      \"value\": \"Adult Male\"\n    },\n    {\n      \"fieldErpId\": \"productgroup\",\n      \"value\": \"ApparelMaster\"\n    },\n    {\n      \"fieldErpId\": \"productsubgroup\",\n      \"value\": \"Shorts\"\n    },\n    {\n      \"fieldErpId\": \"featuresAndBenefits\",\n      \"value\": \"Lorem ipsum dolor sit amet. Aut Quis laudantium est velit eius est expedita quia. Vel necessitatibus quisquam ex earum magnam rem doloremque autem. Ab similique aliquam a quas vitae et possimus error et eveniet eveniet. Eos voluptatem suscipit est ipsam iste qui ullam tempore eos illo quidem qui sint rerum ut sapiente quidem.\",\n      \"properties\": []\n    },\n    {\n      \"fieldErpId\": \"productDescription\",\n      \"value\": \"Lorem ipsum dolor sit amet. Aut Quis laudantium est velit eius est expedita quia. Vel necessitatibus quisquam ex earum magnam rem doloremque autem. Ab similique aliquam a quas vitae et possimus error et eveniet eveniet. Eos voluptatem suscipit est ipsam iste qui ullam tempore eos illo quidem qui sint rerum ut sapiente quidem.\",\n      \"properties\": []\n    },\n    {\n      \"fieldErpId\": \"productTitle\",\n      \"value\": \"SHORT SAG NAVY\",\n      \"properties\": []\n    },\n    {\n      \"fieldErpId\": \"productType\",\n      \"value\": \"Apparel\",\n      \"properties\": []\n    },\n    {\n      \"fieldErpId\": \"apparelSubType\",\n      \"value\": \"Shorts\",\n      \"properties\": []\n    },\n    {\n      \"fieldErpId\": \"brand\",\n      \"value\": \"THG\"\n    },\n    {\n      \"fieldErpId\": \"sku\",\n      \"value\": \"621215\"\n    }\n  ],\n  \"childItems\": [\n    {\n      \"erpId\": \"62121540\",\n      \"content\": [\n        {\n          \"fieldErpId\": \"barcode\",\n          \"values\": [\n            \"13081852605477811144724855415\"\n          ]\n        },\n        {\n          \"fieldErpId\": \"name\",\n          \"values\": [\"SHORT SAG NAVY - 40\"]\n        },\n        {\n          \"fieldErpId\": \"sku\",\n          \"values\": [\"62121\"]\n        },\n        {\n          \"fieldErpId\": \"apparelSize\",\n          \"values\": [\"40\"]\n        },\n      ],\n      \"active\": true\n    }\n  ],\n  \"active\": true\n}\n\n

\n","urlObject":{"path":["v1","entities","{entityErpId}","items"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"fa013d95-35d5-45ba-b357-4dfc80be80be","name":"Insert and update product and content (Success)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"itemErpId\": \"SKU\",\n \"name\": \"Ryobi ONE+ 18V 4.0Ah Battery RB18L40\",\n \"priority\": true,\n \"enricherErpId\": \"RY001\",\n \"groupErpId\": \"ART_GRASS\",\n \"active\": false,\n \"supplierErpId\" : \"BOSCH\",\n \"content\": [\n {\n \"fieldErpId\": \"FieldErpId\",\n \"value\": [\"Field content\"],\n \"properties\": [\n {\n \"fieldErpId\": \"string\",\n \"value\": [\"string\"]\n }\n ]\n }\n ],\n \"childItems\": [\n {\n \"erpId\": \"string\",\n \"content\": [\n {\n \"fieldErpId\": \"FieldErpId\",\n \"value\": [\"Field content\"]\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v1/entities/{entityErpId}/items"},"status":"Created","code":201,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"871ca014-4c8d-4031-9879-b0d7127499b2","name":"Insert and update product and content (Failure)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"itemErpId\": \"SKU\",\n \"name\": \"Ryobi ONE+ 18V 4.0Ah Battery RB18L40\",\n \"priority\": true,\n \"enricherErpId\": \"RY001\",\n \"groupErpId\": \"ART_GRASS\",\n \"active\": false,\n \"supplierErpId\" : \"BOSCH\",\n \"content\": [\n {\n \"fieldErpId\": \"FieldErpId\",\n \"value\": [\"Field content\"],\n \"properties\": [\n {\n \"fieldErpId\": \"string\",\n \"value\": [\"string\"]\n }\n ]\n }\n ],\n \"childItems\": [\n {\n \"erpId\": \"string\",\n \"content\": [\n {\n \"fieldErpId\": \"FieldErpId\",\n \"value\": [\"Field content\"]\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v1/entities/{entityErpId}/items"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"errors\": [\r\n {\r\n \"category\": \"INVALID_REQUEST\", //INTERNAL_SERVER_ERROR || RESOURCE_NOT_FOUND || UNKNOWN_ERROR || FORBIDDEN\r\n \"code\": \"UniqueOnCreate\",\r\n \"target\": \"erpId\",\r\n \"message\": \"item [erp-100] for an entity [erp_1] already exists\"\r\n }\r\n ]\r\n}"}],"_postman_id":"03a48d7b-b377-4df3-92b8-8be1e4e2e4a8"},{"name":"Retrieve product and content information ref: PRO.I.03","id":"3208df1d-ceea-4245-b852-f318d37010df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/v1/entities/{entityErpId}/items/erp-id/{itemErpId}","description":"

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Response	Description
200	All OK
400	Bad Request. Data not valid.

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
itemErpId	String	Yes	The SKU of the MASTER product

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"itemErpId\": {\n      \"type\": \"string\"\n    },\n    \"name\": {\n      \"type\": \"string\"\n    },\n    \"priority\": {\n      \"type\": \"boolean\"\n    },\n    \"enricherErpId\": {\n      \"type\": \"string\"\n    },\n    \"groupErpId\": {\n      \"type\": \"string\"\n    },\n    \"supplier_erp_id\": {\n      \"type\": \"string\"\n    },\n    \"active\": {\n      \"type\": \"boolean\"\n    },\n    \"content\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"fieldErpId\": {\n              \"type\": \"string\"\n            },\n            \"value\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"string\"\n                }\n              ]\n            },\n            \"properties\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"fieldErpId\": {\n                      \"type\": \"string\"\n                    },\n                    \"value\": {\n                      \"type\": \"array\",\n                      \"items\": [\n                        {\n                          \"type\": \"string\"\n                        }\n                      ]\n                    }\n                  },\n                  \"required\": [\n                    \"fieldErpId\",\n                    \"value\"\n                  ]\n                }\n              ]\n            }\n          },\n          \"required\": [\n            \"fieldErpId\",\n            \"value\",\n            \"properties\"\n          ]\n        }\n      ]\n    },\n    \"childItems\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"erpId\": {\n              \"type\": \"string\"\n            },\n            \"content\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"fieldErpId\": {\n                      \"type\": \"string\"\n                    },\n                    \"value\": {\n                      \"type\": \"array\",\n                      \"items\": [\n                        {\n                          \"type\": \"string\"\n                        }\n                      ]\n                    }\n                  },\n                  \"required\": [\n                    \"fieldErpId\",\n                    \"value\"\n                  ]\n                }\n              ]\n            }\n          },\n          \"required\": [\n            \"erpId\",\n            \"content\"\n          ]\n        }\n      ]\n    }\n  },\n  \"required\": [\n    \"itemErpId\",\n    \"name\",\n    \"priority\",\n    \"enricherErpId\",\n    \"groupErpId\",\n    \"supplier_erp_id\",\n    \"active\",\n    \"content\",\n    \"childItems\"\n  ]\n}\n\n

\n","urlObject":{"path":["v1","entities","{entityErpId}","items","erp-id","{itemErpId}"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"743196b0-d9c1-4f5d-a177-a85b7972d1c1","name":"Retrieve product and content information ref: PRO.I.03","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/v1/entities/{entityErpId}/items/erp-id/{itemErpId}"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":[],"cookie":[],"responseTime":null,"body":"{\n \"itemErpId\": \"621218\",\n \"name\": \"RALLAN POLO SAG WHITE TIE DYE\",\n \"priority\": true,\n \"groupErpId\": \"ApparelMaster\",\n \"content\": [\n {\n \"fieldErpId\": \"colour\",\n \"value\": \"OTHER\"\n },\n {\n \"fieldErpId\": \"seasoncode\",\n \"value\": \"6/21Q2/STD\"\n },\n {\n \"fieldErpId\": \"season\",\n \"value\": \"21Q2\"\n },\n {\n \"fieldErpId\": \"targetgroupname\",\n \"value\": \"Adult Male\"\n },\n {\n \"fieldErpId\": \"productgroup\",\n \"value\": \"ApparelMaster\"\n },\n {\n \"fieldErpId\": \"productsubgroup\",\n \"value\": \"Polo shirt\"\n },\n {\n \"fieldErpId\": \"brand\",\n \"value\": \"Elle\"\n },\n {\n \"fieldErpId\": \"productname\",\n \"value\": \"RALLAN POLO SAG WHITE TIE DYE\"\n },\n {\n \"fieldErpId\": \"sku\",\n \"value\": \"621218\"\n }\n ],\n \"childItems\": [\n {\n \"erpId\": \"621218L\",\n \"content\": [\n { \"fieldErpId\": \"barcode\", \"value\": \"5059732033904\" },\n {\n \"fieldErpId\": \"productname\",\n \"value\": \"RALLAN POLO SAG WHITE TIE DYE - L\"\n },\n { \"fieldErpId\": \"sku\", \"value\": \"621218\" },\n { \"fieldErpId\": \"accessoriessize\", \"value\": \"L\" }\n ]\n }\n ],\n \"active\": true\n}"},{"id":"b8c2b62d-b539-4f05-aa81-c610fe346cef","name":"Retrieve product and content information (Failure)","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"itemErpId\": \"SKU\",\n \"name\": \"Ryobi ONE+ 18V 4.0Ah Battery RB18L40\",\n \"priority\": true,\n \"enricherErpId\": \"RY001\",\n \"groupErpId\": \"ART_GRASS\",\n \"supplier_erp_id\": \"MTL\",\n \"active\": false,\n \"content\": [\n {\n \"fieldErpId\": \"FieldErpId\",\n \"value\": [\"Field content\"],\n \"properties\": [\n {\n \"fieldErpId\": \"string\",\n \"value\": [\"string\"]\n }\n ]\n }\n ],\n \"childItems\": [\n {\n \"erpId\": \"string\",\n \"content\": [\n {\n \"fieldErpId\": \"FieldErpId\",\n \"value\": [\"Field content\"]\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v1/entities/{entityErpId}/items/erp-id/{itemErpId}"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"errors\": [\r\n {\r\n \"category\": \"RESOURCE_NOT_FOUND\",\r\n \"message\": \"{erpId} not found for this collection\"\r\n }\r\n ]\r\n }"}],"_postman_id":"3208df1d-ceea-4245-b852-f318d37010df"},{"name":"Image list ref: PRO.I.04","id":"7882513e-8180-4e05-ac48-94ede2322714","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"description":"

Products images are normally used in many systems of our clients.

Instead of providing a dedicated integration to every platform that needs product imagery we will export every night a list of SKU's, the corresponding THG product ID and the location of one or more main product images on the THG CDN.

This will be a .csv file with the following fields:

SKU (Clients SKU)
\n
Product_id (THG product ID)
\n
URL (CDN image URL for size 0000x0000)
\n

\n","urlObject":{"query":[],"variable":[]},"url":""},"response":[],"_postman_id":"7882513e-8180-4e05-ac48-94ede2322714"},{"name":"Product Update","id":"f9f3ce27-9528-4f57-88d8-d839a4038f15","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v2/entities/{entityErpId}/items/{itemErpId}/product-fields","urlObject":{"path":["v2","entities","{entityErpId}","items","{itemErpId}","product-fields"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"f9f3ce27-9528-4f57-88d8-d839a4038f15"}],"id":"f752c34e-9821-49a0-b23f-cd6825cc8d42","description":"

Our product information API's are connected to THG Ingenuity's PIM (Product Information Manager), an optional module that can be used to manage content and properties of your products.

If you are using the standard product suite you will create and manage your products using the New Line Form, which is processed by the THG Ingenuity content team. In that case you cannot use thsi set of API's.

\n","_postman_id":"f752c34e-9821-49a0-b23f-cd6825cc8d42"},{"name":"Self Replenishment","item":[{"name":"Replenishment Request","item":[{"name":"Submit a new replenishment request","id":"a75bfdf9-fa24-4e4f-b9ed-dedb0a22bcce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"clientReferenceId\": \"\",\n \"supplierSiteId\": \"\",\n \"warehouseErpId\": \"\",\n \"deliveryBookingType\": \"\",\n \"freightMode\": \"\",\n \"pallets\": \"\",\n \"boxes\": \"\",\n \"requestedDeliveryDate\": \"\",\n \"products\": [\n {\n \"productId\": \"\",\n \"quantity\": \"\"\n },\n {\n \"productId\": \"\",\n \"quantity\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/self-replenishment","description":"

This endpoint allows the caller to create a 'Self Replenishment Request'.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
clientReferenceId	string	Y	Client's reference for the replenishment request. This is used to query the status of the request
supplierSiteId	string	Y
warehouseErpId	string	Y	THG identifier for the receiving warehouse.
deliveryBookingType	enum	Y	How the delivery will be packed. `PALLETISED` `BOXED`
freightMode	enum	Y	How the delivery will be shipped. `FTL` - Full Truck Load `LTL` - Less than Truck Load `CP` - Courier / Parcel
pallets	integer	Y	Number of pallets being delivered. Must be >0 for `PALLETISED`
boxes	integer	Y	Number of boxes being delivered. Must be >0 for `BOXED`
requestedDeliveryDate	string	Y	Date format: YYYY-MM-DD Used to generate a delivery booking if the request is approved. The booking will be created on or after this date based on availability.
products { productId quantity }	object[] string integer	Y Y Y	The products and quantities being delivered. `productId` is the THG product identifier.

","urlObject":{"path":["self-replenishment"],"host":["{{baseUrl}}"],"query":[],"variable":[]}},"response":[{"id":"dcd233ab-731a-45cf-a913-d285b73b1b80","name":"201 Replenishment request successfully created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: oauth2"}],"body":{"mode":"raw","raw":"{\n \"clientReferenceId\": \"ABC100\",\n \"supplierSiteId\": \"1EL\",\n \"warehouseErpId\": \"31\",\n \"deliveryBookingType\": \"PALLETISED\",\n \"freightMode\": \"LTL\",\n \"pallets\": \"2\",\n \"boxes\": \"8\",\n \"requestedDeliveryDate\": \"2025-02-01\",\n \"products\": [\n {\n \"productId\": \"123456\",\n \"quantity\": \"250\"\n },\n {\n \"productId\": \"654321\",\n \"quantity\": \"1000\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/self-replenishment"},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"c6dabe80-361d-4b6d-b79a-a84f7f8d4fb0","name":"400 Invalid request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: oauth2"}],"body":{"mode":"raw","raw":"{\n \"clientReferenceId\": \"ABC100\",\n \"supplierSiteId\": \"1EL\",\n \"warehouseErpId\": \"31\",\n \"deliveryBookingType\": \"PALLETISED\",\n \"freightMode\": \"LTL\",\n \"pallets\": \"2\",\n \"boxes\": \"8\",\n \"requestedDeliveryDate\": \"2025-02-01\",\n \"products\": [\n {\n \"productId\": \"123456\",\n \"quantity\": \"250\"\n },\n {\n \"productId\": \"654321\",\n \"quantity\": \"1000\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/self-replenishment"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"category\": \"\",\n \"message\": \"\"\n },\n {\n \"category\": \"\",\n \"message\": \"\"\n }\n ]\n}"},{"id":"94e77994-0348-42c9-aacc-ad7c229f14d6","name":"500 Unexpected error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: oauth2"}],"body":{"mode":"raw","raw":"{\n \"clientReferenceId\": \"ABC100\",\n \"supplierSiteId\": \"1EL\",\n \"warehouseErpId\": \"31\",\n \"deliveryBookingType\": \"PALLETISED\",\n \"freightMode\": \"LTL\",\n \"pallets\": \"2\",\n \"boxes\": \"8\",\n \"requestedDeliveryDate\": \"2025-02-01\",\n \"products\": [\n {\n \"productId\": \"123456\",\n \"quantity\": \"250\"\n },\n {\n \"productId\": \"654321\",\n \"quantity\": \"1000\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/self-replenishment"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"category\": \"\",\n \"message\": \"\"\n },\n {\n \"category\": \"\",\n \"message\": \"\"\n }\n ]\n}"}],"_postman_id":"a75bfdf9-fa24-4e4f-b9ed-dedb0a22bcce"},{"name":"Summary of a replenishment request","id":"ac5e3b9d-2a9a-4755-8bb3-f4840add7304","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"{{baseUrl}}/self-replenishment?clientReferenceId={{clientReferenceId}}&bookingReferenceId={{bookingReferenceId}}","description":"

This GET endpoint allows the caller to retrieve the latest information on a 'Self Replenishment Request'.

This will include the status of the request and, if it has been accepted and supplemented with an ASN and then receipted in the warehouse, further information up until the status of the ASN reaching Receipted and the receipts being included.

One of clientReferenceId or bookingReferenceId must be provided for this request.

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
clientReferenceId	string
supplierSiteId	string
warehouseId	string
pallets	integer
boxes	integer
requestedDeliveryDate	string
products { productId quantity }	object[] string integer
replenishmentRequestStatus	enum	Status of the request from: `Pending approval`, `Approved`, `Rejected`
purchaseOrderStatusName	enum	For an `Approved` request, the status of the ASN from: `Cancelled`, `Cancelled by supplier`, `Sent to supplier`, `Confirmed`, `Confirming discrepancies`, `Pending approval`, `ASN Confirming Discrepancies`, `ASN Partially Received`, `Final ASN Received`, `Pending approval for ASN`, `Partially receipted`, `Receipted`
deliveryBookings { warehouseReference warehouseStatus palletsQuantity boxesQuantity unitsQuantity bookingDate asns {} receipts{}	object[] string enum integer integer integer string object[] object[]	- Delivery booking ID Values as below. As below As below
warehouseStatus possible values:	`Open`, `Arrived`, `Started`, `Finished`, `Closed`, `Discrepancy`, `Cancelled`	`Approved`, `Reopened after redline`, `Pending approval for delivery`
asns { asnReference asnStatus errors asnLines {} }	object[] string string string[] object[]	One per Delivery Auto-generated reference. Current status of the ASN. Errors found during validation. As below
asnLines { productId quantity }	object[] string integer
receipts { productId receiptedGood receiptedDamaged }	object[] string integer integer	Only available after the delivery is approved. Qty Good status receipted Qty Damaged status receipted

","urlObject":{"path":["self-replenishment"],"host":["{{baseUrl}}"],"query":[{"description":{"content":"

The reference provided by the client when a replenishment request was raised. Either clientReferenceId or bookingReferenceId must be provided.

\n","type":"text/plain"},"key":"clientReferenceId","value":"{{clientReferenceId}}"},{"description":{"content":"

The booking reference. Can only be used after the replenishment request has been approved. Either clientReferenceId or bookingReferenceId must be provided.

\n","type":"text/plain"},"key":"bookingReferenceId","value":"{{bookingReferenceId}}"}],"variable":[]}},"response":[{"id":"147c3368-7011-4396-868e-75def2930bc6","name":"200 Summary about a replenishment request by ID","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: oauth2"}],"url":{"raw":"{{baseUrl}}/self-replenishment?clientReferenceId=&bookingReferenceId=","host":["{{baseUrl}}"],"path":["self-replenishment"],"query":[{"key":"clientReferenceId","value":"","description":"The reference provided by the client when a replenishment request was raised. Either clientReferenceId or bookingReferenceId must be provided."},{"key":"bookingReferenceId","value":"","description":"The booking reference. Can only be used after the replenishment request has been approved. Either clientReferenceId or bookingReferenceId must be provided."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"replenishmentRequestDetails\": {\n \"clientReferenceId\": \"ABC100\",\n \"supplierSiteId\": \"1EL\",\n \"warehouseId\": \"31\",\n \"pallets\": 2,\n \"boxes\": 8,\n \"requestedDeliveryDate\": \"2025-02-01\",\n \"products\": [\n {\n \"productId\": \"123456\",\n \"quantity\": 250\n },\n {\n \"productId\": \"654321\",\n \"quantity\": 1000\n }\n ]\n },\n \"replenishmentRequestStatus\": \"Approved\",\n \"purchaseOrderStatusName\": \"Receipted\",\n \"deliveryBookings\": [\n {\n \"warehouseReference\": \"31-250201-007\",\n \"warehouseStatus\": \"Approved\",\n \"palletsQuantity\": 2,\n \"boxesQuantity\": 8,\n \"unitsQuantity\": 1250,\n \"bookingDate\": \"2025-02-01T11:00:00Z\",\n \"asns\": [\n {\n \"asnReference\": \"1EL1003106-ASN001\",\n \"asnStatus\": \"FAILED\",\n \"errors\": {\n \"Scannable type set when no scannable fields provided\": [\n {\n \"productErpId\": \"33587371\",\n \"scannableType\": \"SSCC\"\n }\n ]\n },\n \"asnLines\": [\n {\n \"productId\": \"123456\",\n \"quantity\": 250\n },\n {\n \"productId\": \"654321\",\n \"quantity\": 1000\n }\n ]\n }\n ],\n \"receipts\": [\n {\n \"productId\": \"123456\",\n \"receiptedGood\": 250,\n \"receiptedDamaged\": 0\n },\n {\n \"productId\": \"654321\",\n \"receiptedGood\": 1000,\n \"receiptedDamaged\": 0\n }\n ]\n }\n ]\n}"},{"id":"236f6877-9857-4d57-9e20-db2a77aceff1","name":"400 Invalid request","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"{{baseUrl}}/self-replenishment?clientReferenceId=&bookingReferenceId=","host":["{{baseUrl}}"],"path":["self-replenishment"],"query":[{"description":"The reference provided by the client when a replenishment request was raised. Either clientReferenceId or bookingReferenceId must be provided.","key":"clientReferenceId","value":""},{"description":"The booking reference. Can only be used after the replenishment request has been approved. Either clientReferenceId or bookingReferenceId must be provided.","key":"bookingReferenceId","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"category\": \"\",\n \"message\": \"\"\n },\n {\n \"category\": \"\",\n \"message\": \"\"\n }\n ]\n}"},{"id":"221477c4-22d2-4852-bc9b-9d671890f41a","name":"404 Replenishment request not found","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"{{baseUrl}}/self-replenishment?clientReferenceId=&bookingReferenceId=","host":["{{baseUrl}}"],"path":["self-replenishment"],"query":[{"description":"The reference provided by the client when a replenishment request was raised. Either clientReferenceId or bookingReferenceId must be provided.","key":"clientReferenceId","value":""},{"description":"The booking reference. Can only be used after the replenishment request has been approved. Either clientReferenceId or bookingReferenceId must be provided.","key":"bookingReferenceId","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"category\": \"\",\n \"message\": \"\"\n },\n {\n \"category\": \"\",\n \"message\": \"\"\n }\n ]\n}"},{"id":"673cf46e-02ee-4412-9ac7-b7633ae84c3b","name":"500 Unexpected error","originalRequest":{"method":"GET","header":[{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"url":{"raw":"{{baseUrl}}/self-replenishment?clientReferenceId=&bookingReferenceId=","host":["{{baseUrl}}"],"path":["self-replenishment"],"query":[{"description":"The reference provided by the client when a replenishment request was raised. Either clientReferenceId or bookingReferenceId must be provided.","key":"clientReferenceId","value":""},{"description":"The booking reference. Can only be used after the replenishment request has been approved. Either clientReferenceId or bookingReferenceId must be provided.","key":"bookingReferenceId","value":""}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"category\": \"\",\n \"message\": \"\"\n },\n {\n \"category\": \"\",\n \"message\": \"\"\n }\n ]\n}"}],"_postman_id":"ac5e3b9d-2a9a-4755-8bb3-f4840add7304"}],"id":"bbc94e45-d074-4309-9ca9-a6f40efa0f38","description":"

The initial Replenishment Request is made to create a delivery booking slot for the final delivery.

\n","_postman_id":"bbc94e45-d074-4309-9ca9-a6f40efa0f38"},{"name":"ASN","item":[{"name":"v2 Submit a new ASN","id":"a3a63074-016c-4712-a9f0-dd3f3add4f39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"asnLines\": [\n {\n \"productErpId\": \"\",\n \"barcode\": \"\",\n \"catalogueNumber\": \"\",\n \"quantity\": \"\",\n \"batchNo\": \"\",\n \"bestBeforeDate\": \"\",\n \"boxScannable\": \"\",\n \"palletScannable\": \"\",\n \"scannableType\": \"SSCC\"\n },\n {\n \"productErpId\": \"\",\n \"barcode\": \"\",\n \"catalogueNumber\": \"\",\n \"quantity\": \"\",\n \"batchNo\": \"\",\n \"bestBeforeDate\": \"\",\n \"boxScannable\": \"\",\n \"palletScannable\": \"\",\n \"scannableType\": \"SSCC\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/v2/self-replenishment/asn/:bookingReferenceId","description":"

This v2 version is the latest version of the endpoint to Submit a new ASN. Improvements to v1 include:

Asynchronous validation and creation of the ASN. Status can be chacked by querying the GET /self-replenishment endpoint.
\n
A list of error messages are given if validation of the ASN fails.
\n
Multiple versions of an ASN can be sent for validation with only those that pass remaining active.
\n

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
asnLines{}	Object[]	Y	An array of ASN lines, the following fields are the definition of an `asnLine` object.
productErpId	string	Y	THG Product ID. Product must exist, be active, and be included on the replenishment request.
barcode	string	Y	Barcode of the product. If `productErpId` is not found/supplied, `barcode` will be used as the identifier.
catalogueNumber	string	Y	Catalogue Number of the product. If `productErpId` and `barcode` are not found/supplied then `catalogueNumber` will be used as the identifier.
quantity	integer	Y	Quantity of the product being delivered.
batchNo	string	N	Batch / Lot number of the product.
bestBeforeDate	string	N	Date format: YYYY-MM-DD Expiry Date or Best Before Date of the product.
boxScannable	string	N	Scannable and globally unique identifier of the box/carton the product is being delivered in.
palletScannable	string	N	Scannable and globally unique identifier of the pallet the product is being delivered in.
scannableType	enum	N	Mandatory if `boxScannable` or `palletScannable` are supplied. Possible values: `SSCC`, `CUSTOM`

Scannable Requirements

For Pallet deliveries:

palletScannable is mandatory
\n
- Required by the WMS during unloading and marshalling.
\n
boxScannable is mandatory
\n
- Required by the WMS for putaway.
\n

For Parcel / Box deliveries:

palletScannable is to be left empty
\n
boxScannable is mandatory
\n
- Required by the WMS for putaway.
\n

\n","urlObject":{"path":["v2","self-replenishment","asn",":bookingReferenceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"bb2e75fb-5f4d-4632-970b-45682269fa4b","description":{"content":"

(Required) The booking reference of the delivery booking.

\n","type":"text/plain"},"type":"any","value":"","key":"bookingReferenceId"}]}},"response":[{"id":"e05dead4-271b-42bd-905a-a6fbe9f9ee98","name":"200 ASN successfully submitted","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: oauth2"}],"body":{"mode":"raw","raw":"{\n \"asnLines\": [\n {\n \"productErpId\": \"123456\",\n \"barcode\": \"\",\n \"catalogueNumber\": \"\",\n \"quantity\": \"250\",\n \"batchNo\": \"1234\",\n \"bestBeforeDate\": \"2026-12-31\",\n \"boxScannable\": \"123456789\",\n \"palletScannable\": \"\",\n \"scannableType\": \"SSCC\"\n },\n {\n \"productErpId\": \"654321\",\n \"barcode\": \"\",\n \"catalogueNumber\": \"\",\n \"quantity\": \"1000\",\n \"batchNo\": \"\",\n \"bestBeforeDate\": \"\",\n \"boxScannable\": \"\",\n \"palletScannable\": \"ABC123\",\n \"scannableType\": \"CUSTOM\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/v2/self-replenishment/asn/:bookingReferenceId","host":["{{baseUrl}}"],"path":["v2","self-replenishment","asn",":bookingReferenceId"],"variable":[{"key":"bookingReferenceId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"asnReference\": \"ABC100\"\n}"},{"id":"4fba50db-3fc8-4c5d-8fff-5bc360e48458","name":"400 Invalid request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: oauth2"}],"body":{"mode":"raw","raw":"{\n \"asnLines\": [\n {\n \"productErpId\": \"123456\",\n \"barcode\": \"\",\n \"catalogueNumber\": \"\",\n \"quantity\": \"250\",\n \"batchNo\": \"1234\",\n \"bestBeforeDate\": \"2026-12-31\",\n \"boxScannable\": \"123456789\",\n \"palletScannable\": \"\",\n \"scannableType\": \"SSCC\"\n },\n {\n \"productErpId\": \"654321\",\n \"barcode\": \"\",\n \"catalogueNumber\": \"\",\n \"quantity\": \"1000\",\n \"batchNo\": \"\",\n \"bestBeforeDate\": \"\",\n \"boxScannable\": \"\",\n \"palletScannable\": \"ABC123\",\n \"scannableType\": \"CUSTOM\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/v2/self-replenishment/asn/:bookingReferenceId","host":["{{baseUrl}}"],"path":["v2","self-replenishment","asn",":bookingReferenceId"],"variable":[{"key":"bookingReferenceId","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"category\": \"INVALID_REQUEST\",\n \"message\": \"Delivery booking Invalid for Booking Reference Id: 31-240817-0022\"\n },\n {\n \"category\": \"INVALID_REQUEST\",\n \"message\": \"Delivery Booking Date 2025-01-24 can't be in the past for the Booking Reference Id: 31-240817-0022\"\n }\n ]\n}"},{"id":"1f9d0d4c-98f0-47b9-9ece-17b6c7650def","name":"403 Forbidden","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: oauth2"}],"body":{"mode":"raw","raw":"{\n \"asnLines\": [\n {\n \"productErpId\": \"123456\",\n \"barcode\": \"\",\n \"catalogueNumber\": \"\",\n \"quantity\": \"250\",\n \"batchNo\": \"1234\",\n \"bestBeforeDate\": \"2026-12-31\",\n \"boxScannable\": \"123456789\",\n \"palletScannable\": \"\",\n \"scannableType\": \"SSCC\"\n },\n {\n \"productErpId\": \"654321\",\n \"barcode\": \"\",\n \"catalogueNumber\": \"\",\n \"quantity\": \"1000\",\n \"batchNo\": \"\",\n \"bestBeforeDate\": \"\",\n \"boxScannable\": \"\",\n \"palletScannable\": \"ABC123\",\n \"scannableType\": \"CUSTOM\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/v2/self-replenishment/asn/:bookingReferenceId","host":["{{baseUrl}}"],"path":["v2","self-replenishment","asn",":bookingReferenceId"],"variable":[{"key":"bookingReferenceId","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"category\": \"INVALID_REQUEST\",\n \"message\": \"No Self Replenishment Delivery Booking Available for Booking Reference Id: 31-240817-0022\"\n },\n {\n \"category\": \"INVALID_REQUEST\",\n \"message\": \"Client ID not found\"\n },\n {\n \"category\": \"INVALID_REQUEST\",\n \"message\": \"Purchase Order Conflicting for Booking Reference Id: 31-240817-0022\"\n }\n ]\n}"},{"id":"eeb541d7-25f7-47b5-b143-c93254fb4a63","name":"404 No purchase order available for Booking Reference Id","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: oauth2"}],"body":{"mode":"raw","raw":"{\n \"asnLines\": [\n {\n \"productErpId\": \"123456\",\n \"barcode\": \"\",\n \"catalogueNumber\": \"\",\n \"quantity\": \"250\",\n \"batchNo\": \"1234\",\n \"bestBeforeDate\": \"2026-12-31\",\n \"boxScannable\": \"123456789\",\n \"palletScannable\": \"\",\n \"scannableType\": \"SSCC\"\n },\n {\n \"productErpId\": \"654321\",\n \"barcode\": \"\",\n \"catalogueNumber\": \"\",\n \"quantity\": \"1000\",\n \"batchNo\": \"\",\n \"bestBeforeDate\": \"\",\n \"boxScannable\": \"\",\n \"palletScannable\": \"ABC123\",\n \"scannableType\": \"CUSTOM\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/v2/self-replenishment/asn/:bookingReferenceId","host":["{{baseUrl}}"],"path":["v2","self-replenishment","asn",":bookingReferenceId"],"variable":[{"key":"bookingReferenceId","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"category\": \"INVALID_REQUEST\",\n \"message\": \"Can't find purchase order with id: 31-240817-0022\"\n }\n ]\n}"},{"id":"a5f0914e-5b4c-4c1d-9e0e-025c3efa40a8","name":"500 Unexpected error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"key":"Authorization","value":"","description":"Added as a part of security scheme: oauth2"}],"body":{"mode":"raw","raw":"{\n \"asnLines\": [\n {\n \"productErpId\": \"123456\",\n \"barcode\": \"\",\n \"catalogueNumber\": \"\",\n \"quantity\": \"250\",\n \"batchNo\": \"1234\",\n \"bestBeforeDate\": \"2026-12-31\",\n \"boxScannable\": \"123456789\",\n \"palletScannable\": \"\",\n \"scannableType\": \"SSCC\"\n },\n {\n \"productErpId\": \"654321\",\n \"barcode\": \"\",\n \"catalogueNumber\": \"\",\n \"quantity\": \"1000\",\n \"batchNo\": \"\",\n \"bestBeforeDate\": \"\",\n \"boxScannable\": \"\",\n \"palletScannable\": \"ABC123\",\n \"scannableType\": \"CUSTOM\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/v2/self-replenishment/asn/:bookingReferenceId","host":["{{baseUrl}}"],"path":["v2","self-replenishment","asn",":bookingReferenceId"],"variable":[{"key":"bookingReferenceId","value":""}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"category\": \"INTERNAL_SERVER_ERROR\",\n \"message\": \"Internal server error, please try again.\"\n }\n ]\n}"}],"_postman_id":"a3a63074-016c-4712-a9f0-dd3f3add4f39"},{"name":"Submit a new ASN","id":"e0fcd6df-975f-4e74-b8b7-c67f4d0603c8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"asnLines\": [\n {\n \"productErpId\": \"\",\n \"barcode\": \"\",\n \"catalogueNumber\": \"\",\n \"quantity\": \"\",\n \"batchNo\": \"\",\n \"bestBeforeDate\": \"\",\n \"boxScannable\": \"\",\n \"palletScannable\": \"\",\n \"scannableType\": \"SSCC\"\n },\n {\n \"productErpId\": \"\",\n \"barcode\": \"\",\n \"catalogueNumber\": \"\",\n \"quantity\": \"\",\n \"batchNo\": \"\",\n \"bestBeforeDate\": \"\",\n \"boxScannable\": \"\",\n \"palletScannable\": \"\",\n \"scannableType\": \"SSCC\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"{{baseUrl}}/self-replenishment/asn/:bookingReferenceId","description":"

This is the deprecated v1 version of the 'Submit a new ASN' endpoint and prioritisation should be given to using the v2 version above for new integrations.

\n","urlObject":{"path":["self-replenishment","asn",":bookingReferenceId"],"host":["{{baseUrl}}"],"query":[],"variable":[{"id":"04661b36-81be-4080-a5ef-945fee6c23a3","description":{"content":"

(Required) The booking reference of the delivery booking.

\n","type":"text/plain"},"type":"any","value":"","key":"bookingReferenceId"}]}},"response":[{"id":"159b3229-9c0f-4236-8657-2e5f17439b79","name":"ASN successfully submitted","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"asnLines\": [\n {\n \"productErpId\": \"\",\n \"barcode\": \"\",\n \"catalogueNumber\": \"\",\n \"quantity\": \"\",\n \"batchNo\": \"\",\n \"bestBeforeDate\": \"\",\n \"boxScannable\": \"\",\n \"palletScannable\": \"\",\n \"scannableType\": \"SSCC\"\n },\n {\n \"productErpId\": \"\",\n \"barcode\": \"\",\n \"catalogueNumber\": \"\",\n \"quantity\": \"\",\n \"batchNo\": \"\",\n \"bestBeforeDate\": \"\",\n \"boxScannable\": \"\",\n \"palletScannable\": \"\",\n \"scannableType\": \"SSCC\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/self-replenishment/asn/:bookingReferenceId","host":["{{baseUrl}}"],"path":["self-replenishment","asn",":bookingReferenceId"],"variable":[{"key":"bookingReferenceId"}]}},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"4cc2e214-2dd3-4ca8-8e8f-2f1bbb154654","name":"Invalid request","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"asnLines\": [\n {\n \"productErpId\": \"\",\n \"barcode\": \"\",\n \"catalogueNumber\": \"\",\n \"quantity\": \"\",\n \"batchNo\": \"\",\n \"bestBeforeDate\": \"\",\n \"boxScannable\": \"\",\n \"palletScannable\": \"\",\n \"scannableType\": \"SSCC\"\n },\n {\n \"productErpId\": \"\",\n \"barcode\": \"\",\n \"catalogueNumber\": \"\",\n \"quantity\": \"\",\n \"batchNo\": \"\",\n \"bestBeforeDate\": \"\",\n \"boxScannable\": \"\",\n \"palletScannable\": \"\",\n \"scannableType\": \"SSCC\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/self-replenishment/asn/:bookingReferenceId","host":["{{baseUrl}}"],"path":["self-replenishment","asn",":bookingReferenceId"],"variable":[{"key":"bookingReferenceId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"category\": \"\",\n \"message\": \"\"\n },\n {\n \"category\": \"\",\n \"message\": \"\"\n }\n ]\n}"},{"id":"b3d12ac2-23ea-4214-a32f-df43ead9e10a","name":"Product not found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"asnLines\": [\n {\n \"productErpId\": \"\",\n \"barcode\": \"\",\n \"catalogueNumber\": \"\",\n \"quantity\": \"\",\n \"batchNo\": \"\",\n \"bestBeforeDate\": \"\",\n \"boxScannable\": \"\",\n \"palletScannable\": \"\",\n \"scannableType\": \"SSCC\"\n },\n {\n \"productErpId\": \"\",\n \"barcode\": \"\",\n \"catalogueNumber\": \"\",\n \"quantity\": \"\",\n \"batchNo\": \"\",\n \"bestBeforeDate\": \"\",\n \"boxScannable\": \"\",\n \"palletScannable\": \"\",\n \"scannableType\": \"SSCC\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/self-replenishment/asn/:bookingReferenceId","host":["{{baseUrl}}"],"path":["self-replenishment","asn",":bookingReferenceId"],"variable":[{"key":"bookingReferenceId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"category\": \"\",\n \"message\": \"\"\n },\n {\n \"category\": \"\",\n \"message\": \"\"\n }\n ]\n}"},{"id":"2ac1b723-ae25-4bc2-95b8-da2bcfaee137","name":"Unexpected error","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"},{"description":"Added as a part of security scheme: oauth2","key":"Authorization","value":""}],"body":{"mode":"raw","raw":"{\n \"asnLines\": [\n {\n \"productErpId\": \"\",\n \"barcode\": \"\",\n \"catalogueNumber\": \"\",\n \"quantity\": \"\",\n \"batchNo\": \"\",\n \"bestBeforeDate\": \"\",\n \"boxScannable\": \"\",\n \"palletScannable\": \"\",\n \"scannableType\": \"SSCC\"\n },\n {\n \"productErpId\": \"\",\n \"barcode\": \"\",\n \"catalogueNumber\": \"\",\n \"quantity\": \"\",\n \"batchNo\": \"\",\n \"bestBeforeDate\": \"\",\n \"boxScannable\": \"\",\n \"palletScannable\": \"\",\n \"scannableType\": \"SSCC\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"{{baseUrl}}/self-replenishment/asn/:bookingReferenceId","host":["{{baseUrl}}"],"path":["self-replenishment","asn",":bookingReferenceId"],"variable":[{"key":"bookingReferenceId"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"errors\": [\n {\n \"category\": \"\",\n \"message\": \"\"\n },\n {\n \"category\": \"\",\n \"message\": \"\"\n }\n ]\n}"}],"_postman_id":"e0fcd6df-975f-4e74-b8b7-c67f4d0603c8"}],"id":"85e013a0-f83f-42a3-9c9d-6905542089f9","description":"

Once a Replenishment Request is made and it is Approved (the replenishmentRequestStatus is Approved) an ASN can be submitted against the Delivery Booking Reference ID.

The ASN (Advanced Shipping Notice) contains the precise information about what products and quantities are on the delivery.

\n","_postman_id":"85e013a0-f83f-42a3-9c9d-6905542089f9"}],"id":"a1ead1cd-c118-45cb-b4b3-3209124e5023","description":"

The Self Replenishment API allows the caller to request a Delivery Booking for a delivery into THG Ingenuity warehouses.

If approved, this request can then be furnished with full ASN details in preparation for the delivery to the warehouse.

Once the delivery has been made and the warehouse are working on receiving the stock, the API provides updates on the receipt of the stock.

\n","_postman_id":"a1ead1cd-c118-45cb-b4b3-3209124e5023"},{"name":"Stock","item":[{"name":"Stock API","item":[{"name":"Set Warehouse Stock Level for Product","id":"6a17e807-7ea8-45ee-a9b0-5830f08d93f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"PUT","header":[{"key":"accept","value":"application/json"},{"key":"organisation","value":"client-name"}],"body":{"mode":"raw","raw":"{\n \"available\": true,\n \"productId\": \"string\",\n \"quantity\": 0,\n \"warehouseId\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"/v1/stock/warehouse-stock","description":"

The purpose of this API call is to ensure that the client warehouse is synchronised with THG's stock position. Therefore, the \"quantity\" field should be populated by the amount of good units present in the warehouse.

Valid reasons for sending up-to-date stock position for a given product includes:

New stock receipted in the client warehouse
Returns received in the warehouse (where applicable, and unit is still purchasable and not damaged)
Adjustments made in the warehouse, changing the total good units (e.g. if some units got damaged or lost in the warehouse)
Despatched stock left the warehouse

Important remark. The good stock being processed by the warehouse that is still within warehouse must not decrement the quantity until it has been despatched. This means that good stock must include allocated stock. For example: units allocated to an order, that is being prepared for fulfilment, but it is not despatched yet, client must NOT decrement stock. Allocation logic and its effects on website availability is taken into account by THG Platform already.

This API call overwrites the warehouse quantity for a given product and warehouse. For cases, where \"available\" is true, the warehouse quantity set is as \"quantity\" field provided. If \"available is false, the warehouse quantity is overwritten to be 0, regardless of whatever is sent in the \"quantity field.

Product Identifier

The “productId” field is a string which represents one of the following product values depending on the product creation method followed during the Client onboarding process.

Barcodes as defined in the product new line form (i.e 8905550083102).
\n
ExternalProductId - this option is only applicable when the products are onboarded with PIM (i.e S2812393_C000_000).
\n

Please verify with your THG Project Manager with regards to which of the above options is most appropriate for your integration.

Warehouse Identifier

The \"warehouseId\" field is an integer and is the external client warehouseId that is mapped to an internal THG warehouseId.

If neither productId or warehouseId mapping do not exist, the request will fail as THG internal services will be unable to determine internal product or warehouse identifiers to translate to, with respect to the organisation/client token.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Response Code	Description
200	Success
404	Product mapping cannot be found for organisation and external productId provided Warehouse mapping cannot be found for organisation and external warehouseId provided Warehouse not permitted to be overwritten by this organisation

Successful responses should return 200 and the warehouse stock that was uploaded to the THG internal systems. Unsuccessful responses should return 404 and a string of the a brief description of the error reason.

\n","urlObject":{"path":["v1","stock","warehouse-stock"],"host":[""],"query":[],"variable":[]}},"response":[],"_postman_id":"6a17e807-7ea8-45ee-a9b0-5830f08d93f6"},{"name":"Get Warehouse Stock Level for Product","id":"eb761c2e-c7f5-4e19-8fda-0574257618d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"organisation","value":"client-name"}],"url":"/v1/stock/warehouse-stock/productId/{productId}","description":"

This endpoint is used to get total good stock details for the requested product id.

The product id can be either a barcode or an internal THG product id, depending on the customer's needs. However, only one type of product id is supported at a time. If the customer chooses to use barcodes, they cannot be mixed with internal THG product ids.

The response includes available, productId, quantity and warehouseId.

Quantity returned by API represents total good stock product quantity which is the quantity of the product currently stored in the inventory, including any unfulfilled quantities.

Request

Authorization:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
Token	Bearer Token	The access token issued by the our customer specyfic autentication provider service.

Headers:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
accept	String	Media types which are acceptable for the response. Only supported value is application/json.
organisation	String	Client-name that has been agreed on during the onbording.

Path Paramaters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
productId	String	The “productId” field is a string which represents one of the following product values depending on the product creation method followed during the Client onboarding process. 1. Barcodes - as defined in the product new line form (i.e 8905550083102). 2. ExternalProductId - this option is only applicable when the products are onboarded with PIM (i.e S2812393_C000_000). 3. Internal THG product ID - Product Id as defined in the THG systems (i.e 1402123) Please verify with your THG Project Manager with regards to which of the above options is most appropriate for your integration.

Response

Returns the list of the following parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
available	Boolean	True/False indicator - When the quantity is greater than 0, the \"available\" status will be set to TRUE. If the quantity is zero or less, the \"available\" status will be set to FALSE.
productId	String	The product identifier that has been provided in request path parameters.
quantity	String	The \"quantity\" field is an integer and represents total good stock quantity for a given product is provided warehouse. This is the quantity of the product currently stored in the inventory, including any unfulfilled quantities.
warehouseId	String	The \"warehouseId\" field is a String and is the external client warehouseId that is mapped to an internal THG warehouseId.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Response Code	Description
200	Success
404	Product mapping cannot be found for organisation and external productId provided organisation
500	Internal Server Error

Response JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"array\",\n  \"items\": [\n    {\n      \"type\": \"object\",\n      \"properties\": {\n        \"available\": {\n          \"type\": \"Boolean\"\n        },\n        \"productId\": {\n          \"type\": \"String\"\n        },\n        \"quantity\": {\n          \"type\": \"integer\"\n        },\n        \"warehouseId\": {\n          \"type\": \"String\"\n        }\n      },\n      \"required\": [\n        \"available\",\n        \"productId\",\n        \"quantity\",\n        \"warehouseId\"\n      ]\n    }\n  ]\n}\n\n

Response Body (raw)

[\n    {\n        \"available\": true,\n        \"productId\": \"string\",\n        \"quantity\": 0,\n        \"warehouseId\": \"string\"\n    }\n]\n\n

\n","urlObject":{"path":["v1","stock","warehouse-stock","productId","{productId}"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"c36f64fe-242a-4e6f-87f1-ae6912ff2787","name":"HTTP 200","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"organisation","value":"client-name"}],"url":"/v1/stock/warehouse-stock/productId/{productId}"},"status":"HTTP 200","_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"available\": true,\n \"productId\": \"string\",\n \"quantity\": 0,\n \"warehouseId\": \"string\"\n },\n {\n \"available\": true,\n \"productId\": \"string\",\n \"quantity\": 0,\n \"warehouseId\": \"string\"\n }\n]"},{"id":"af8b422e-e4f3-4c58-a8c1-205280738197","name":"HTTP 404","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"organisation","value":"client-name"}],"url":"/v1/stock/warehouse-stock/productId/{productId}"},"status":"HTTP 404","_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\"Failed to get internal product id by external product id and organisation due to issue with client - url: Hidden\""},{"id":"fd01512c-8d28-4f7f-a5e3-f4827ed5a482","name":"HTTP 500","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"organisation","value":"client-name"}],"url":"/v1/stock/warehouse-stock/productId/{productId}"},"status":"HTTP 500","_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2023-01-26T12:23:30.210+00:00\",\n \"path\": \"/api/v1/stock/warehouse-stock/productId/99999\",\n \"status\": 504,\n \"error\": \"Gateway Timeout\",\n \"requestId\": \"6e5b5f66-1\"\n}"}],"_postman_id":"eb761c2e-c7f5-4e19-8fda-0574257618d3"}],"id":"436c8933-5a51-4e78-bc8e-b3ab5984bc60","_postman_id":"436c8933-5a51-4e78-bc8e-b3ab5984bc60","description":""}],"id":"de0de57e-a662-45a8-8de5-2bff98765d9a","_postman_id":"de0de57e-a662-45a8-8de5-2bff98765d9a","description":""},{"name":"THG Fulfil","item":[{"name":"D2C Orders","item":[{"name":"Outbound","item":[{"name":"Send Order State Update","id":"89862012-61dd-4027-96b7-3e7e9610930a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"client-order-reference","value":"ClientOrder00001","description":"

The client order reference that the update is for

\n","type":"text"},{"key":"X-THG-Channel","value":"Channel","description":"

The client channel name.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"platformOrderReference\": \"AB_1234\",\r\n \"clientOrderReference\": \"ClientOrder00001\",\r\n \"productSummaries\": [\r\n {\r\n \"allocatedProductBarcode\": \"BARCODE\",\r\n \"allocatedProductCode\": \"Product1\",\r\n \"fulfilmentStateQuantities\": {\r\n \"PROCESSING\": 2,\r\n \"DISPATCHED\": 1\r\n },\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"requestedProductCode\": \"Product1\"\r\n }\r\n ],\r\n \"shipments\": [\r\n {\r\n \"courierDetails\": {\r\n \"courierProviderId\": 150,\r\n \"courierProviderName\": \"UPS\",\r\n \"courierServiceId\": 356,\r\n \"courierServiceName\": \"UPS Mail Innovation Standard LightWeight\",\r\n \"trackingNumber\": \"EK510223258GB\",\r\n \"courierCode\": \"UPSN\"\r\n },\r\n \"despatchedDate\": \"2020-10-22T00:00:00.000Z\",\r\n \"productSummaries\": [\r\n {\r\n \"quantity\": 1,\r\n \"requestedProductBarcode\": \"Product1\",\r\n \"serialNumbers\": [\r\n \"TEST99998\",\r\n \"TEST99999\"\r\n ],\r\n \"batchExpiryInformation\": [\r\n {\r\n \"quantity\": 1,\r\n \"batchNumber\": \"BATCH-1\",\r\n \"expiryDate\": \"2026-01-01T00:00:00.000Z\"\r\n }\r\n ],\r\n \"identifiers\": [\r\n {\r\n \"type\": \"SERIAL_NUMBER\",\r\n \"values\": [\r\n \"TEST99998\",\r\n \"TEST99999\"\r\n ]\r\n },\r\n {\r\n \"type\": \"IMEI\",\r\n \"values\": [\r\n \"351234567890123\",\r\n \"351234567890124\"\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"shipmentNumber\": 23124013,\r\n \"shipmentState\": \"DISPATCHED\",\r\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=283183247102380\",\r\n \"warehouseDetails\": {\r\n \"warehouse\": \"Omega\",\r\n \"warehouseId\": 31\r\n }\r\n }\r\n ],\r\n \"cancellation\": [\r\n {\r\n \"productCode\": \"Product1\",\r\n \"quantity\": 1,\r\n \"reason\": \"Damaged\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/v1/sendOrderStateUpdate","description":"

This result of this request is a call out to the client-provided URL whenever there is an order state update for a client's order. The body of the subsequent request is the same as the body on the original request.

Request

Request Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`client-order-reference`	string	The client order reference that the update is for. Example: ClientOrder00001
`X-THG-Channel`	string	The client channel name.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`platformOrderReference`	string	Y	The THG-generated internal order reference.
`clientOrderReference`	string	Y	Order reference from client which is sent to THG during order creation
`productSummaries`	Array of ProductSummary	Y	Summary of the requested products including status of the product quantities.
`shipments`	Array of Shipment	Y	Shipment information
`cancellation`	Array of Cancellation	N	This section is available if any of the order items are cancelled. This will detail out the item and its quantity cancelled along with reason for cancel. If there are no cancellations then this will be an empty array.

ProductSummary

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`requestedProductBarcode`	string	Y	Barcode of the requested product.
`requestedProductCode`	string	Y	Product code of the requested product.
`allocatedProductBarcode`	string	N	Barcode of the allocated product, if applicable.
`allocatedProductCode`	string	N	Product code of the allocated product, if applicable.
`fulfilmentStateQuantities`	Map [ state string : quantity integer ]	Y	States supported: `PROCESSING`, `DISPATCHED`, `CANCELLED`.

Shipment

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`shipmentNumber`	integer	Y	Shipment number.
`shipmentState`	string	Y	Current state of the shipment.
`despatchedDate`	string	Y	Date when shipment was dispatched. Format: yyyy-MM-ddTHH:mm:ssZ.
`trackingUrl`	string	Y	Shipment tracking URL.
`courierDetails`	CourierDetails	N	Information about the shipment's courier.
`productSummaries`	Array of ShipmentProductSummary	Y	Summary of product information within a shipment.
`warehouseDetails`	WarehouseDetail	N	Warehouse information for the shipment.

CourierDetails

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`courierProviderId`	integer	Y	THG Ingenuity courier identifier.
`courierProviderName`	string	Y	Name of courier provider.
`courierServiceId`	integer	Y	THG Ingenuity courier service identifier.
`courierServiceName`	string	Y	Name of courier service.
`trackingNumber`	string	Y	Shipment courier tracking number.
`courierCode`	string	N	Standard Carrier Alpha Code (SCAC)

ShipmentProductSummary

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`requestedProductBarcode`	string	Y	Product Code of the requested product. This is not the barcode.
`quantity`	integer	Y	Quantity of the requested product in the shipment.
`serialNumbers`	Array of string	N	List of serial numbers associated with the dispatched product, where provided.
`batchExpiryInformation`	Array of BatchExpiryInformation	N	Array of batch and expiry information for the given product, where provided.
`identifiers`	Array of Identifiers	N	Array of all identifiers associated with the product, where provided. If no values are available for any of the identifiers then this will be an empty array.

Identifiers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`type`	string	Y	Type of identifier, eg. SERIAL_NUMBER, IMEI
`values`	Array of string	Y	List of values associated with identifier.

BatchExpiryInformation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`quantity`	integer	Y	Quantity of product associated with batch number and expiry date.
`batchNumber`	string	Y	Batch/Lot number of the product.
`expiryDate`	string	Y	Expiry date of the product. Format: yyyy-MM-ddTHH:mm:ssZ

WarehouseDetail

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`warehouse`	string	Y	Warehouse name.
`warehouseId`	integer	Y	THG Ingenuity warehouse ID.

Cancellation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`productCode`	string	Y	Product code of cancelled product
`quantity`	integer	Y	Quantity of the cancelled product
`reason`	string	Y	Reason to cancel the product. Reasons supported:`DAMAGED`, `CUSTOMER`, `CLIENT`, `LOST`

Request Body JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"platformOrderReference\": {\n      \"type\": \"string\"\n    },\n    \"clientOrderReference\": {\n      \"type\": \"string\"\n    },\n    \"productSummaries\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"allocatedProductBarcode\": {\n              \"type\": \"string\"\n            },\n            \"allocatedProductCode\": {\n              \"type\": \"string\"\n            },\n            \"fulfilmentStateQuantities\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"any-key\": {\n                  \"type\": \"integer\"\n                }\n              }\n            },\n            \"requestedProductBarcode\": {\n              \"type\": \"string\"\n            },\n            \"requestedProductCode\": {\n              \"type\": \"string\"\n            }\n          },\n          \"required\": [\n            \"allocatedProductBarcode\",\n            \"allocatedProductCode\",\n            \"fulfilmentStateQuantities\",\n            \"requestedProductBarcode\",\n            \"requestedProductCode\"\n          ]\n        }\n      ]\n    },\n    \"shipments\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"courierDetails\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"courierProviderId\": {\n                  \"type\": \"integer\"\n                },\n                \"courierProviderName\": {\n                  \"type\": \"string\"\n                },\n                \"courierServiceId\": {\n                  \"type\": \"integer\"\n                },\n                \"courierServiceName\": {\n                  \"type\": \"string\"\n                },\n                \"trackingNumber\": {\n                  \"type\": \"string\"\n                },\n                \"courierCode\": {\n                  \"type\": \"string\"\n                }\n              },\n              \"required\": [\n                \"courierProviderId\",\n                \"courierProviderName\",\n                \"courierServiceId\",\n                \"courierServiceName\",\n                \"trackingNumber\"\n              ]\n            },\n            \"despatchedDate\": {\n              \"type\": \"string\"\n            },\n            \"productSummaries\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"quantity\": {\n                      \"type\": \"integer\"\n                    },\n                    \"requestedProductBarcode\": {\n                      \"type\": \"string\"\n                    },\n                    \"serialNumbers\": {\n                      \"type\": \"array\",\n                      \"items\": [\n                        {\n                          \"type\": \"string\"\n                        }\n                      ]\n                    },\n                    \"batchExpiryInformation\": {\n                      \"type\": \"array\",\n                      \"items\": [\n                        {\n                          \"type\": \"object\",\n                          \"properties\": {\n                            \"quantity\": {\n                              \"type\": \"integer\"\n                            },\n                            \"batchNumber\": {\n                              \"type\": \"string\"\n                            },\n                            \"expiryDate\": {\n                              \"type\": \"string\"\n                            }\n                          },\n                          \"required\": [\n                            \"quantity\",\n                            \"batchNumber\",\n                            \"expiryDate\"\n                          ]\n                        }\n                      ]\n                    },\n                    \"identifiers\": {\n                      \"type\": \"array\",\n                      \"items\": [\n                        {\n                          \"type\": \"object\",\n                          \"properties\": {\n                            \"type\": {\n                              \"type\": \"string\"\n                            },\n                            \"values\": {\n                              \"type\": \"array\",\n                              \"items\": [\n                                {\n                                  \"type\": \"string\"\n                                }\n                              ]\n                            }\n                          },\n                          \"required\": [\n                            \"type\",\n                            \"values\",\n                          ]\n                        }\n                      ]\n                    }                   \n                  },\n                  \"required\": [\n                    \"quantity\",\n                    \"requestedProductBarcode\"\n                  ]\n                }        \n              ]\n            },\n            \"shipmentNumber\": {\n              \"type\": \"integer\"\n            },\n            \"shipmentState\": {\n              \"type\": \"string\"\n            },\n            \"trackingUrl\": {\n              \"type\": \"string\"\n            },\n            \"warehouseDetails\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"warehouse\": {\n                  \"type\": \"string\"\n                },\n                \"warehouseId\": {\n                  \"type\": \"integer\"\n                }\n              },\n              \"required\": [\n                \"warehouse\",\n                \"warehouseId\"\n              ]\n            }\n          },\n          \"required\": [\n            \"courierDetails\",\n            \"despatchedDate\",\n            \"productSummaries\",\n            \"shipmentNumber\",\n            \"shipmentState\"\n          ]\n        }\n      ]\n    },\n    \"cancellation\": {\n      \"type\": \"array\",\n        \"items\": [\n          {\n            \"type\": \"object\",\n              \"properties\": {\n                \"productCode\": {\n                  \"type\": \"string\"\n                },\n                \"quantity\": {\n                  \"type\": \"integer\"\n                },\n                \"reason\": {\n                  \"type\": \"string\"\n                },\n              },\n              \"required\": [\n                \"productCode\",\n                \"quantity\",\n                \"reason\"\n              ]\n          }\n        ]  \n     }\n  },\n  \"required\": [\n    \"platformOrderReference\",\n    \"productSummaries\",\n    \"shipments\"\n  ]\n}\n\n

\n","urlObject":{"path":["v1","sendOrderStateUpdate"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"b973ecde-a4df-43ca-ab9c-e7143cafcdd2","name":"Success 200","originalRequest":{"method":"POST","header":[{"key":"client-order-reference","value":"ClientOrder00001","description":"The client order reference that the update is for","type":"text"},{"key":"X-THG-Channel","value":"Channel","description":"The client channel name.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"platformOrderReference\": \"AB_1234\",\r\n \"clientOrderReference\": \"ClientOrder00001\",\r\n \"productSummaries\": [\r\n {\r\n \"allocatedProductBarcode\": \"BARCODE\",\r\n \"allocatedProductCode\": \"Product1\",\r\n \"fulfilmentStateQuantities\": {\r\n \"PROCESSING\": 1,\r\n \"CANCELLED\": 1,\r\n \"DISPATCHED\": 1\r\n },\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"requestedProductCode\": \"Product1\"\r\n }\r\n ],\r\n \"shipments\": [\r\n {\r\n \"courierDetails\": {\r\n \"courierProviderId\": 150,\r\n \"courierProviderName\": \"UPS\",\r\n \"courierServiceId\": 356,\r\n \"courierServiceName\": \"UPS Mail Innovation Standard LightWeight\",\r\n \"trackingNumber\": \"EK510223258GB\",\r\n \"courierCode\": \"UPSN\"\r\n },\r\n \"despatchedDate\": \"2020-10-22T00:00:00.000Z\",\r\n \"productSummaries\": [\r\n {\r\n \"quantity\": 1,\r\n \"requestedProductBarcode\": \"Product1\",\r\n \"serialNumbers\": [\r\n \"TEST99998\",\r\n \"TEST99999\"\r\n ],\r\n \"batchExpiryInformation\": [\r\n {\r\n \"quantity\": 1,\r\n \"batchNumber\": \"BATCH-1\",\r\n \"expiryDate\": \"2026-01-01T00:00:00.000Z\"\r\n }\r\n ],\r\n \"identifiers\": [\r\n {\r\n \"type\": \"SERIAL_NUMBER\",\r\n \"values\": [\r\n \"TEST99998\",\r\n \"TEST99999\"\r\n ]\r\n },\r\n {\r\n \"type\": \"IMEI\",\r\n \"values\": [\r\n \"351234567890123\",\r\n \"351234567890124\"\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"shipmentNumber\": 23124013,\r\n \"shipmentState\": \"DISPATCHED\",\r\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=283183247102380\",\r\n \"warehouseDetails\": {\r\n \"warehouse\": \"Omega\",\r\n \"warehouseId\": 31\r\n }\r\n }\r\n ],\r\n \"cancellation\": [\r\n {\r\n \"productCode\": \"Product1\",\r\n \"quantity\": 1,\r\n \"reason\": \"Damaged\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/v1/sendOrderStateUpdate"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"96ef1495-7b6f-40db-8196-9da9fe6a52e0","name":"Success 200 - No identifiers and cancellations","originalRequest":{"method":"POST","header":[{"key":"client-order-reference","value":"ClientOrder00001","description":"The client order reference that the update is for","type":"text"},{"key":"X-THG-Channel","value":"Channel","description":"The client channel name.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"platformOrderReference\": \"AB_1234\",\r\n \"clientOrderReference\": \"ClientOrder00001\",\r\n \"productSummaries\": [\r\n {\r\n \"allocatedProductBarcode\": \"BARCODE\",\r\n \"allocatedProductCode\": \"Product1\",\r\n \"fulfilmentStateQuantities\": {\r\n \"PROCESSING\": 1,\r\n \"DISPATCHED\": 1\r\n },\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"requestedProductCode\": \"Product1\"\r\n }\r\n ],\r\n \"shipments\": [\r\n {\r\n \"courierDetails\": {\r\n \"courierProviderId\": 150,\r\n \"courierProviderName\": \"UPS\",\r\n \"courierServiceId\": 356,\r\n \"courierServiceName\": \"UPS Mail Innovation Standard LightWeight\",\r\n \"trackingNumber\": \"EK510223258GB\",\r\n \"courierCode\": \"UPSN\"\r\n },\r\n \"despatchedDate\": \"2020-10-22T00:00:00.000Z\",\r\n \"productSummaries\": [\r\n {\r\n \"quantity\": 1,\r\n \"requestedProductBarcode\": \"Product1\",\r\n \"batchExpiryInformation\": [\r\n {\r\n \"quantity\": 1,\r\n \"batchNumber\": \"BATCH-1\",\r\n \"expiryDate\": \"2026-01-01T00:00:00.000Z\"\r\n }\r\n ],\r\n \"identifiers\": []\r\n }\r\n ],\r\n \"shipmentNumber\": 23124013,\r\n \"shipmentState\": \"DISPATCHED\",\r\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=283183247102380\",\r\n \"warehouseDetails\": {\r\n \"warehouse\": \"Omega\",\r\n \"warehouseId\": 31\r\n }\r\n }\r\n ],\r\n \"cancellation\": []\r\n}","options":{"raw":{"language":"json"}}},"url":"/v1/sendOrderStateUpdate"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"3db68740-b3ec-4c9c-8729-106786a6efb3","name":"Success 200 - Split Shipments - 1 Shipment Dispatched the other Cancelled","originalRequest":{"method":"POST","header":[{"key":"client-order-reference","value":"ClientOrder00001","description":"The client order reference that the update is for","type":"text"},{"key":"X-THG-Channel","value":"Channel","description":"The client channel name.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"platformOrderReference\": \"AB_1234\",\r\n \"clientOrderReference\": \"ClientOrder00001\",\r\n \"productSummaries\": [\r\n {\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"requestedProductCode\": \"Product1\",\r\n \"allocatedProductBarcode\": \"BARCODE\",\r\n \"allocatedProductCode\": \"Product1\",\r\n \"fulfilmentStateQuantities\": {\r\n \"DISPATCHED\": 1\r\n }\r\n },\r\n {\r\n \"requestedProductCode\": \"Product2\",\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"fulfilmentStateQuantities\": {\r\n \"CANCELLED\": 1\r\n }\r\n }\r\n ],\r\n \"shipments\": [\r\n {\r\n \"courierDetails\": {\r\n \"courierProviderId\": 150,\r\n \"courierProviderName\": \"UPS\",\r\n \"courierServiceId\": 356,\r\n \"courierServiceName\": \"UPS Mail Innovation Standard LightWeight\",\r\n \"trackingNumber\": \"EK510223258GB\",\r\n \"courierCode\": \"UPSN\"\r\n },\r\n \"despatchedDate\": \"2020-10-22T00:00:00.000Z\",\r\n \"productSummaries\": [\r\n {\r\n \"quantity\": 1,\r\n \"requestedProductBarcode\": \"Product1\",\r\n \"serialNumbers\": [\r\n \"TEST99998\",\r\n \"TEST99999\"\r\n ],\r\n \"identifiers\": [\r\n {\r\n \"type\": \"SERIAL_NUMBER\",\r\n \"values\": [\r\n \"TEST99998\",\r\n \"TEST99999\"\r\n ]\r\n },\r\n {\r\n \"type\": \"IMEI\",\r\n \"values\": [\r\n \"351234567890123\",\r\n \"351234567890124\"\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"shipmentNumber\": 23124013,\r\n \"shipmentState\": \"DISPATCHED\",\r\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=283183247102380\",\r\n \"warehouseDetails\": {\r\n \"warehouse\": \"Omega\",\r\n \"warehouseId\": 31\r\n }\r\n }\r\n ],\r\n \"cancellation\": [\r\n {\r\n \"productCode\": \"Product2\",\r\n \"quantity\": 1,\r\n \"reason\": \"Damaged\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/v1/sendOrderStateUpdate"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"84623339-9e5d-4663-aac6-af2539356478","name":"Failure 400","originalRequest":{"method":"POST","header":[{"key":"client-order-reference","value":"ClientOrder00001","description":"The client order reference that the update is for","type":"text"},{"key":"X-THG-Channel","value":"Channel","description":"The client channel name.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"productSummaries\": [\r\n {\r\n \"allocatedProductBarcode\": \"BARCODE\",\r\n \"allocatedProductCode\": \"Product1\",\r\n \"fulfilmentStateQuantities\": {\r\n \"PROCESSING\": 2,\r\n \"DISPATCHED\": 1\r\n },\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"requestedProductCode\": \"Product1\"\r\n }\r\n ],\r\n \"shipments\": [\r\n {\r\n \"courierDetails\": {\r\n \"courierProviderId\": 150,\r\n \"courierProviderName\": \"UPS\",\r\n \"courierServiceId\": 356,\r\n \"courierServiceName\": \"UPS Mail Innovation Standard LightWeight\",\r\n \"trackingNumber\": \"EK510223258GB\",\r\n \"courierCode\": \"UPSN\"\r\n },\r\n \"despatchedDate\": \"2020-10-22T00:00:00.000Z\",\r\n \"productSummaries\": [\r\n {\r\n \"quantity\": 1,\r\n \"requestedProductBarcode\": \"Product1\",\r\n \"serialNumbers\": [\r\n \"TEST99998\",\r\n \"TEST99999\"\r\n ]\r\n }\r\n ],\r\n \"shipmentNumber\": 23124013,\r\n \"shipmentState\": \"DISPATCHED\",\r\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=283183247102380\",\r\n \"warehouseDetails\": {\r\n \"warehouse\": \"Omega\",\r\n \"warehouseId\": 31\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/v1/sendOrderStateUpdate"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"a4c9bcc3-0c5e-4c3d-a406-f0e6cd50ed3e","name":"Failure 404","originalRequest":{"method":"POST","header":[{"key":"client-order-reference","value":"ClientOrder00001","description":"The client order reference that the update is for","type":"text"},{"key":"X-THG-Channel","value":"Channel","description":"The client channel name.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"platformOrderReference\": \"AB_1234\",\r\n \"productSummaries\": [\r\n {\r\n \"allocatedProductBarcode\": \"BARCODE\",\r\n \"allocatedProductCode\": \"Product1\",\r\n \"fulfilmentStateQuantities\": {\r\n \"PROCESSING\": 2,\r\n \"DISPATCHED\": 1\r\n },\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"requestedProductCode\": \"Product1\"\r\n }\r\n ],\r\n \"shipments\": [\r\n {\r\n \"courierDetails\": {\r\n \"courierProviderId\": 150,\r\n \"courierProviderName\": \"UPS\",\r\n \"courierServiceId\": 356,\r\n \"courierServiceName\": \"UPS Mail Innovation Standard LightWeight\",\r\n \"trackingNumber\": \"EK510223258GB\",\r\n \"courierCode\": \"UPSN\"\r\n },\r\n \"despatchedDate\": \"2020-10-22T00:00:00.000Z\",\r\n \"productSummaries\": [\r\n {\r\n \"quantity\": 1,\r\n \"requestedProductBarcode\": \"Product1\",\r\n \"serialNumbers\": [\r\n \"TEST99998\",\r\n \"TEST99999\"\r\n ]\r\n }\r\n ],\r\n \"shipmentNumber\": 23124013,\r\n \"shipmentState\": \"DISPATCHED\",\r\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=283183247102380\",\r\n \"warehouseDetails\": {\r\n \"warehouse\": \"Omega\",\r\n \"warehouseId\": 31\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/v1/sendOrderStateUpdate"},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"Order Not Found."},{"id":"84f5f2b1-4598-4111-96b8-5cacc1dc6afb","name":"Failure 500","originalRequest":{"method":"POST","header":[{"key":"client-order-reference","value":"ClientOrder00001","description":"The client order reference that the update is for","type":"text"},{"key":"X-THG-Channel","value":"Channel","description":"The client channel name.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"platformOrderReference\": \"AB_1234\",\r\n \"productSummaries\": [\r\n {\r\n \"allocatedProductBarcode\": \"BARCODE\",\r\n \"allocatedProductCode\": \"Product1\",\r\n \"fulfilmentStateQuantities\": {\r\n \"PROCESSING\": 2,\r\n \"DISPATCHED\": 1\r\n },\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"requestedProductCode\": \"Product1\"\r\n }\r\n ],\r\n \"shipments\": [\r\n {\r\n \"courierDetails\": {\r\n \"courierProviderId\": 150,\r\n \"courierProviderName\": \"UPS\",\r\n \"courierServiceId\": 356,\r\n \"courierServiceName\": \"UPS Mail Innovation Standard LightWeight\",\r\n \"trackingNumber\": \"EK510223258GB\",\r\n \"courierCode\": \"UPSN\"\r\n },\r\n \"despatchedDate\": \"2020-10-22T00:00:00.000Z\",\r\n \"productSummaries\": [\r\n {\r\n \"quantity\": 1,\r\n \"requestedProductBarcode\": \"Product1\",\r\n \"serialNumbers\": [\r\n \"TEST99998\",\r\n \"TEST99999\"\r\n ],\r\n \"identifiers\": [\r\n {\r\n \"type\": \"SERIAL_NUMBER\",\r\n \"values\": [\r\n \"TEST99998\",\r\n \"TEST99999\"\r\n ]\r\n },\r\n {\r\n \"type\": \"IMEI\",\r\n \"values\": [\r\n \"351234567890123\",\r\n \"351234567890124\"\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"shipmentNumber\": 23124013,\r\n \"shipmentState\": \"DISPATCHED\",\r\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=283183247102380\",\r\n \"warehouseDetails\": {\r\n \"warehouse\": \"Omega\",\r\n \"warehouseId\": 31\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/v1/sendOrderStateUpdate"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"89862012-61dd-4027-96b7-3e7e9610930a"},{"name":"Send Order State Update v3","id":"83f84da5-2711-486b-a106-9cf3d4db170a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"client-order-reference","value":"ClientOrder00001","description":"

The client order reference that the update is for

\n","type":"text"},{"key":"X-THG-Channel","value":"Channel","description":"

The client channel name.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"platformOrderReference\": \"AB_1234\",\r\n \"clientOrderReference\": \"ClientOrder00001\",\r\n \"productSummaries\": [\r\n {\r\n \"allocatedProductBarcode\": \"BARCODE\",\r\n \"allocatedProductCode\": \"Product1\",\r\n \"fulfilmentStateQuantities\": {\r\n \"PROCESSING\": 1,\r\n \"DISPATCHED\": 1,\r\n \"CANCELLED\": 1,\r\n \"ALLOCATED_TO_WAREHOUSE\": 1\r\n },\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"requestedProductCode\": \"Product1\"\r\n },\r\n {\r\n \"allocatedProductBarcode\": \"BARCODE2\",\r\n \"allocatedProductCode\": \"Product2\",\r\n \"fulfilmentStateQuantities\": {\r\n \"ALLOCATED_TO_WAREHOUSE\": 1,\r\n \"AWAITING_DISPATCH\": 1\r\n },\r\n \"requestedProductBarcode\": \"BARCODE2\",\r\n \"requestedProductCode\": \"Product2\"\r\n }\r\n ],\r\n \"shipments\": [\r\n {\r\n \"courierDetails\": {\r\n \"courierProviderId\": 150,\r\n \"courierProviderName\": \"UPS\",\r\n \"courierServiceId\": 356,\r\n \"courierServiceName\": \"UPS Mail Innovation Standard LightWeight\",\r\n \"trackingNumber\": \"EK510223258GB\",\r\n \"trackingUrl\": \"https://www.ups.com/track?loc=en_US&tracknum=EK510223258GB\"\r\n },\r\n \"despatchedDate\": \"2020-10-22T15:10:12.000Z\",\r\n \"productSummaries\": [\r\n {\r\n \"quantity\": 1,\r\n \"requestedProductCode\": \"Product1\",\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"batchExpiryInformation\": [\r\n {\r\n \"quantity\": 1,\r\n \"batchNumber\": \"BATCH-1\",\r\n \"expiryDate\": \"2026-01-01T00:00:00.000Z\"\r\n }\r\n ],\r\n \"identifiers\": [\r\n {\r\n \"type\": \"SERIAL_NUMBER\",\r\n \"values\": [\r\n \"TEST99998\",\r\n \"TEST99999\"\r\n ]\r\n },\r\n {\r\n \"type\": \"IMEI\",\r\n \"values\": [\r\n \"351234567890123\",\r\n \"351234567890124\"\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"shipmentNumber\": 23124013,\r\n \"shipmentState\": \"DISPATCHED\"\r\n }\r\n ],\r\n \"cancellation\": [\r\n {\r\n \"productCode\": \"Product1\",\r\n \"quantity\": 1,\r\n \"reason\": \"Damaged\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/sendOrderStateUpdate","description":"

Request

Request Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`client-order-reference`	string	The client order reference that the update is for. Example: ClientOrder00001
`X-THG-Channel`	string	The client channel name.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`platformOrderReference`	string	Y	The THG-generated internal order reference.
`clientOrderReference`	string	Y	Order reference from client which is sent to THG during order creation
`productSummaries`	Array of ProductSummary	Y	Summary of the requested products including status of the product quantities.
`shipments`	Array of Shipment	Y	Shipment information
`cancellation`	Array of Cancellation	N	This section is available if any of the order items are cancelled. This will detail out the item and its quantity cancelled along with reason to cancel. If there are no cancellations then this will be an empty array.

ProductSummary

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`requestedProductBarcode`	string	Y	Barcode of the requested product.
`requestedProductCode`	string	Y	THG product id of the requested product.
`allocatedProductBarcode`	string	N	Barcode of the allocated product, if applicable.
`allocatedProductCode`	string	N	THG product id of the allocated product, if applicable.
`fulfilmentStateQuantities`	Map [ state string : quantity integer ]	Y	Statuses: `PROCESSING`, `DISPATCHED`, `CANCELLED`, `ALLOCATED_TO_WAREHOUSE` Additional statuses, available only if requested: `AWAITING_DISPATCH` These could be any combination of above statuses, user should ignore any unwanted statuses that appear in this section.

Shipment

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`shipmentNumber`	integer	Y	Shipment number.
`shipmentState`	string	Y	Current state of the shipment.
`despatchedDate`	string	Y	Date when shipment was dispatched. Format: yyyy-MM-ddTHH:mm:ssZ.
`courierDetails`	CourierDetails	N	Information about the shipment's courier.
`productSummaries`	Array of ShipmentProductSummary	Y	Summary of product information within a shipment.
`warehouseDetails`	WarehouseDetail	N	Warehouse information for the shipment.

CourierDetails

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`courierProviderId`	integer	Y	THG Ingenuity courier identifier.
`courierProviderName`	string	Y	Name of courier provider.
`courierServiceId`	integer	Y	THG Ingenuity courier service identifier.
`courierServiceName`	string	Y	Name of courier service.
`trackingNumber`	string	Y	Shipment courier tracking number.
`trackingUrl`	string	Y	Shipment tracking url

ShipmentProductSummary

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`requestedProductCode`	string	Y	THG product id of the requested product.
`requestedProductBarcode`	string	Y	Barcode of the requested product.
`quantity`	integer	Y	Quantity of the requested product in the shipment.
`batchExpiryInformation`	Array of BatchExpiryInformation	N	Array of batch and expiry information for the given product, where provided.
`identifiers`	Array of Identifiers	N	Array of all identifiers associated with the product, where provided. If no values are avaiable for any of the identifiers then this will be an empty array.

Identifiers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`type`	string	Y	Type of identifier, eg. SERIAL_NUMBER, IMEI
`values`	Array of string	Y	List of values associated with identifier.

BatchExpiryInformation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`quantity`	integer	Y	Quantity of product associated with batch number and expiry date.
`batchNumber`	string	Y	Batch/Lot number of the product.
`expiryDate`	string	Y	Expiry date of the product. Format: yyyy-MM-ddTHH:mm:ssZ

WarehouseDetail

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`warehouse`	string	Y	Warehouse name.
`warehouseId`	integer	Y	THG Ingenuity warehouse ID.

Cancellation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`productCode`	string	Y	THG product id of the cancelled product
`quantity`	integer	Y	Quantity of the cancelled product
`reason`	string	Y	Reason to cancel the product. Reasons supported: `DAMAGED`, `CUSTOMER`, `CLIENT`, `LOST`

Request Body JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"platformOrderReference\": {\n      \"type\": \"string\"\n    },\n    \"clientOrderReference\": {\n      \"type\": \"string\"\n    },\n    \"productSummaries\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"allocatedProductBarcode\": {\n              \"type\": \"string\"\n            },\n            \"allocatedProductCode\": {\n              \"type\": \"string\"\n            },\n            \"fulfilmentStateQuantities\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"any-key\": {\n                  \"type\": \"integer\"\n                }\n              }\n            },\n            \"requestedProductBarcode\": {\n              \"type\": \"string\"\n            },\n            \"requestedProductCode\": {\n              \"type\": \"string\"\n            }\n          },\n          \"required\": [\n            \"allocatedProductBarcode\",\n            \"allocatedProductCode\",\n            \"fulfilmentStateQuantities\",\n            \"requestedProductBarcode\",\n            \"requestedProductCode\"\n          ]\n        }\n      ]\n    },\n    \"shipments\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"courierDetails\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"courierProviderId\": {\n                  \"type\": \"integer\"\n                },\n                \"courierProviderName\": {\n                  \"type\": \"string\"\n                },\n                \"courierServiceId\": {\n                  \"type\": \"integer\"\n                },\n                \"courierServiceName\": {\n                  \"type\": \"string\"\n                },\n                \"trackingNumber\": {\n                  \"type\": \"string\"\n                },\n                \"trackingUrl\": {\n                  \"type\": \"string\"\n                }\n              },\n              \"required\": [\n                \"courierProviderId\",\n                \"courierProviderName\",\n                \"courierServiceId\",\n                \"courierServiceName\",\n                \"trackingNumber\",\n                \"trackingUrl\"\n              ]\n            },\n            \"despatchedDate\": {\n              \"type\": \"string\"\n            },\n            \"productSummaries\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"quantity\": {\n                      \"type\": \"integer\"\n                    },\n                    \"requestedProductCode\": {\n                      \"type\": \"string\"\n                    },\n                    \"requestedProductBarcode\": {\n                      \"type\": \"string\"\n                    },\n                    \"batchExpiryInformation\": {\n                      \"type\": \"array\",\n                      \"items\": [\n                        {\n                          \"type\": \"object\",\n                          \"properties\": {\n                            \"quantity\": {\n                              \"type\": \"integer\"\n                            },\n                            \"batchNumber\": {\n                              \"type\": \"string\"\n                            },\n                            \"expiryDate\": {\n                              \"type\": \"string\"\n                            }\n                          },\n                          \"required\": [\n                            \"quantity\",\n                            \"batchNumber\",\n                            \"expiryDate\"\n                          ]\n                        }\n                      ]\n                    },\n                    \"identifiers\": {\n                      \"type\": \"array\",\n                      \"items\": [\n                        {\n                          \"type\": \"object\",\n                          \"properties\": {\n                            \"type\": {\n                              \"type\": \"string\"\n                            },\n                            \"values\": {\n                              \"type\": \"array\",\n                              \"items\": [\n                                {\n                                  \"type\": \"string\"\n                                }\n                              ]\n                            }\n                          },\n                          \"required\": [\n                            \"type\",\n                            \"values\",\n                          ]\n                        }\n                      ]\n                    }                   \n                  },\n                  \"required\": [\n                    \"quantity\",\n                    \"requestedProductCode\",\n                    \"requestedProductBarcode\"\n                  ]\n                }        \n              ]\n            },\n            \"shipmentNumber\": {\n              \"type\": \"integer\"\n            },\n            \"shipmentState\": {\n              \"type\": \"string\"\n            },\n            \"warehouseDetails\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"warehouse\": {\n                  \"type\": \"string\"\n                },\n                \"warehouseId\": {\n                  \"type\": \"integer\"\n                }\n              },\n              \"required\": [\n                \"warehouse\",\n                \"warehouseId\"\n              ]\n            }\n          },\n          \"required\": [\n            \"courierDetails\",\n            \"despatchedDate\",\n            \"productSummaries\",\n            \"shipmentNumber\",\n            \"shipmentState\"\n          ]\n        }\n      ]\n    },\n    \"cancellation\": {\n      \"type\": \"array\",\n        \"items\": [\n          {\n            \"type\": \"object\",\n              \"properties\": {\n                \"productCode\": {\n                  \"type\": \"string\"\n                },\n                \"quantity\": {\n                  \"type\": \"integer\"\n                },\n                \"reason\": {\n                  \"type\": \"string\"\n                },\n              },\n              \"required\": [\n                \"productCode\",\n                \"quantity\",\n                \"reason\"\n              ]\n          }\n        ]  \n     }\n  },\n  \"required\": [\n    \"platformOrderReference\",\n    \"productSummaries\",\n    \"shipments\"\n  ]\n}\n\n

\n","urlObject":{"path":["v3","sendOrderStateUpdate"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"f14547d5-8148-4034-a610-b8aaa3a5e480","name":"Success 200","originalRequest":{"method":"POST","header":[{"key":"client-order-reference","value":"ClientOrder00001","description":"The client order reference that the update is for","type":"text"},{"key":"X-THG-Channel","value":"Channel","description":"The client channel name.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"platformOrderReference\": \"AB_1234\",\r\n \"clientOrderReference\": \"ClientOrder00001\",\r\n \"productSummaries\": [\r\n {\r\n \"allocatedProductBarcode\": \"BARCODE\",\r\n \"allocatedProductCode\": \"Product1\",\r\n \"fulfilmentStateQuantities\": {\r\n \"PROCESSING\": 1,\r\n \"DISPATCHED\": 1,\r\n \"CANCELLED\": 1,\r\n \"ALLOCATED_TO_WAREHOUSE\": 1\r\n },\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"requestedProductCode\": \"Product1\"\r\n },\r\n {\r\n \"allocatedProductBarcode\": \"BARCODE2\",\r\n \"allocatedProductCode\": \"Product2\",\r\n \"fulfilmentStateQuantities\": {\r\n \"ALLOCATED_TO_WAREHOUSE\": 1,\r\n \"AWAITING_DISPATCH\": 1\r\n },\r\n \"requestedProductBarcode\": \"BARCODE2\",\r\n \"requestedProductCode\": \"Product2\"\r\n }\r\n ],\r\n \"shipments\": [\r\n {\r\n \"courierDetails\": {\r\n \"courierProviderId\": 150,\r\n \"courierProviderName\": \"UPS\",\r\n \"courierServiceId\": 356,\r\n \"courierServiceName\": \"UPS Mail Innovation Standard LightWeight\",\r\n \"trackingNumber\": \"EK510223258GB\",\r\n \"trackingUrl\": \"https://www.ups.com/track?loc=en_US&tracknum=EK510223258GB\"\r\n },\r\n \"despatchedDate\": \"2020-10-22T15:10:12.000Z\",\r\n \"productSummaries\": [\r\n {\r\n \"quantity\": 1,\r\n \"requestedProductCode\": \"Product1\",\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"batchExpiryInformation\": [\r\n {\r\n \"quantity\": 1,\r\n \"batchNumber\": \"BATCH-1\",\r\n \"expiryDate\": \"2026-01-01T00:00:00.000Z\"\r\n }\r\n ],\r\n \"identifiers\": [\r\n {\r\n \"type\": \"SERIAL_NUMBER\",\r\n \"values\": [\r\n \"TEST99998\",\r\n \"TEST99999\"\r\n ]\r\n },\r\n {\r\n \"type\": \"IMEI\",\r\n \"values\": [\r\n \"351234567890123\",\r\n \"351234567890124\"\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"shipmentNumber\": 23124013,\r\n \"shipmentState\": \"DISPATCHED\",\r\n \"warehouseDetails\": {\r\n \"warehouse\": \"Omega\",\r\n \"warehouseId\": 31\r\n }\r\n }\r\n ],\r\n \"cancellation\": [\r\n {\r\n \"productCode\": \"Product1\",\r\n \"quantity\": 1,\r\n \"reason\": \"Damaged\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/sendOrderStateUpdate"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"34b92b1b-7101-494d-a9df-7943615014ed","name":"Success 200 - No identifiers and cancellations","originalRequest":{"method":"POST","header":[{"key":"client-order-reference","value":"ClientOrder00001","description":"The client order reference that the update is for","type":"text"},{"key":"X-THG-Channel","value":"Channel","description":"The client channel name.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"platformOrderReference\": \"AB_1234\",\r\n \"clientOrderReference\": \"ClientOrder00001\",\r\n \"productSummaries\": [\r\n {\r\n \"allocatedProductBarcode\": \"BARCODE\",\r\n \"allocatedProductCode\": \"Product1\",\r\n \"fulfilmentStateQuantities\": {\r\n \"PROCESSING\": 1,\r\n \"DISPATCHED\": 1,\r\n \"ALLOCATED_TO_WAREHOUSE\": 1\r\n },\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"requestedProductCode\": \"Product1\"\r\n }\r\n ],\r\n \"shipments\": [\r\n {\r\n \"courierDetails\": {\r\n \"courierProviderId\": 150,\r\n \"courierProviderName\": \"UPS\",\r\n \"courierServiceId\": 356,\r\n \"courierServiceName\": \"UPS Mail Innovation Standard LightWeight\",\r\n \"trackingNumber\": \"EK510223258GB\",\r\n \"trackingUrl\": \"https://www.ups.com/track?loc=en_US&tracknum=EK510223258GB\"\r\n },\r\n \"despatchedDate\": \"2020-10-22T00:00:00.000Z\",\r\n \"productSummaries\": [\r\n {\r\n \"quantity\": 1,\r\n \"requestedProductCode\": \"Product1\",\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"batchExpiryInformation\": [\r\n {\r\n \"quantity\": 1,\r\n \"batchNumber\": \"BATCH-1\",\r\n \"expiryDate\": \"2026-01-01T00:00:00.000Z\"\r\n }\r\n ],\r\n \"identifiers\": []\r\n }\r\n ],\r\n \"shipmentNumber\": 23124013,\r\n \"shipmentState\": \"DISPATCHED\",\r\n \"warehouseDetails\": {\r\n \"warehouse\": \"Omega\",\r\n \"warehouseId\": 31\r\n }\r\n }\r\n ],\r\n \"cancellation\": []\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/sendOrderStateUpdate"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"9d6718c4-5411-43d9-bfbd-48b8dcd8037a","name":"Success 200 - Split Shipments - 1 Shipment Dispatched the other Cancelled","originalRequest":{"method":"POST","header":[{"key":"client-order-reference","value":"ClientOrder00001","description":"The client order reference that the update is for","type":"text"},{"key":"X-THG-Channel","value":"Channel","description":"The client channel name.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"platformOrderReference\": \"AB_1234\",\r\n \"clientOrderReference\": \"ClientOrder00001\",\r\n \"productSummaries\": [\r\n {\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"requestedProductCode\": \"Product1\",\r\n \"allocatedProductBarcode\": \"BARCODE\",\r\n \"allocatedProductCode\": \"Product1\",\r\n \"fulfilmentStateQuantities\": {\r\n \"DISPATCHED\": 1,\r\n \"ALLOCATED_TO_WAREHOUSE\": 1\r\n }\r\n },\r\n {\r\n \"requestedProductCode\": \"Product2\",\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"fulfilmentStateQuantities\": {\r\n \"CANCELLED\": 1\r\n }\r\n }\r\n ],\r\n \"shipments\": [\r\n {\r\n \"courierDetails\": {\r\n \"courierProviderId\": 150,\r\n \"courierProviderName\": \"UPS\",\r\n \"courierServiceId\": 356,\r\n \"courierServiceName\": \"UPS Mail Innovation Standard LightWeight\",\r\n \"trackingNumber\": \"EK510223258GB\",\r\n \"trackingUrl\": \"https://www.ups.com/track?loc=en_US&tracknum=EK510223258GB\"\r\n },\r\n \"despatchedDate\": \"2020-10-22T15:10:12.000Z\",\r\n \"productSummaries\": [\r\n {\r\n \"quantity\": 1,\r\n \"requestedProductCode\": \"Product1\",\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"identifiers\": [\r\n {\r\n \"type\": \"SERIAL_NUMBER\",\r\n \"values\": [\r\n \"TEST99998\",\r\n \"TEST99999\"\r\n ]\r\n },\r\n {\r\n \"type\": \"IMEI\",\r\n \"values\": [\r\n \"351234567890123\",\r\n \"351234567890124\"\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"shipmentNumber\": 23124013,\r\n \"shipmentState\": \"DISPATCHED\",\r\n \"warehouseDetails\": {\r\n \"warehouse\": \"Omega\",\r\n \"warehouseId\": 31\r\n }\r\n }\r\n ],\r\n \"cancellation\": [\r\n {\r\n \"productCode\": \"Product2\",\r\n \"quantity\": 1,\r\n \"reason\": \"Damaged\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/sendOrderStateUpdate"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"14dd2fde-29fe-444f-a4cd-e8ebff99d862","name":"Failure 400","originalRequest":{"method":"POST","header":[{"key":"client-order-reference","value":"ClientOrder00001","description":"The client order reference that the update is for","type":"text"},{"key":"X-THG-Channel","value":"Channel","description":"The client channel name.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"productSummaries\": [\r\n {\r\n \"allocatedProductBarcode\": \"BARCODE\",\r\n \"allocatedProductCode\": \"Product1\",\r\n \"fulfilmentStateQuantities\": {\r\n \"PROCESSING\": 2,\r\n \"DISPATCHED\": 1\r\n },\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"requestedProductCode\": \"Product1\"\r\n }\r\n ],\r\n \"shipments\": [\r\n {\r\n \"courierDetails\": {\r\n \"courierProviderId\": 150,\r\n \"courierProviderName\": \"UPS\",\r\n \"courierServiceId\": 356,\r\n \"courierServiceName\": \"UPS Mail Innovation Standard LightWeight\",\r\n \"trackingNumber\": \"EK510223258GB\",\r\n \"trackingUrl\": \"https://www.ups.com/track?loc=en_US&tracknum=EK510223258GB\"\r\n },\r\n \"despatchedDate\": \"2020-10-22T15:10:12.000Z\",\r\n \"productSummaries\": [\r\n {\r\n \"quantity\": 1,\r\n \"requestedProductCode\": \"Product1\",\r\n \"requestedProductBarcode\": \"BARCODE\"\r\n }\r\n ],\r\n \"shipmentNumber\": 23124013,\r\n \"shipmentState\": \"DISPATCHED\",\r\n \"warehouseDetails\": {\r\n \"warehouse\": \"Omega\",\r\n \"warehouseId\": 31\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/sendOrderStateUpdate"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"89dd6fc1-61e9-4923-a6cf-26a207388b24","name":"Failure 404","originalRequest":{"method":"POST","header":[{"key":"client-order-reference","value":"ClientOrder00001","description":"The client order reference that the update is for","type":"text"},{"key":"X-THG-Channel","value":"Channel","description":"The client channel name.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"platformOrderReference\": \"AB_1234\",\r\n \"productSummaries\": [\r\n {\r\n \"allocatedProductBarcode\": \"BARCODE\",\r\n \"allocatedProductCode\": \"Product1\",\r\n \"fulfilmentStateQuantities\": {\r\n \"PROCESSING\": 2,\r\n \"DISPATCHED\": 1\r\n },\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"requestedProductCode\": \"Product1\"\r\n }\r\n ],\r\n \"shipments\": [\r\n {\r\n \"courierDetails\": {\r\n \"courierProviderId\": 150,\r\n \"courierProviderName\": \"UPS\",\r\n \"courierServiceId\": 356,\r\n \"courierServiceName\": \"UPS Mail Innovation Standard LightWeight\",\r\n \"trackingNumber\": \"EK510223258GB\",\r\n \"trackingUrl\": \"https://www.ups.com/track?loc=en_US&tracknum=EK510223258GB\"\r\n },\r\n \"despatchedDate\": \"2020-10-22T00:00:00.000Z\",\r\n \"productSummaries\": [\r\n {\r\n \"quantity\": 1,\r\n \"requestedProductCode\": \"Product1\",\r\n \"requestedProductBarcode\": \"BARCODE\"\r\n }\r\n ],\r\n \"shipmentNumber\": 23124013,\r\n \"shipmentState\": \"DISPATCHED\",\r\n \"warehouseDetails\": {\r\n \"warehouse\": \"Omega\",\r\n \"warehouseId\": 31\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/sendOrderStateUpdate"},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"Order Not Found."},{"id":"8f0a3fb5-7884-4845-81eb-90717af52efc","name":"Failure 500","originalRequest":{"method":"POST","header":[{"key":"client-order-reference","value":"ClientOrder00001","description":"The client order reference that the update is for","type":"text"},{"key":"X-THG-Channel","value":"Channel","description":"The client channel name.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"platformOrderReference\": \"AB_1234\",\r\n \"productSummaries\": [\r\n {\r\n \"allocatedProductBarcode\": \"BARCODE\",\r\n \"allocatedProductCode\": \"Product1\",\r\n \"fulfilmentStateQuantities\": {\r\n \"PROCESSING\": 2,\r\n \"DISPATCHED\": 1\r\n },\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"requestedProductCode\": \"Product1\"\r\n }\r\n ],\r\n \"shipments\": [\r\n {\r\n \"courierDetails\": {\r\n \"courierProviderId\": 150,\r\n \"courierProviderName\": \"UPS\",\r\n \"courierServiceId\": 356,\r\n \"courierServiceName\": \"UPS Mail Innovation Standard LightWeight\",\r\n \"trackingNumber\": \"EK510223258GB\",\r\n \"trackingUrl\": \"https://www.ups.com/track?loc=en_US&tracknum=EK510223258GB\"\r\n },\r\n \"despatchedDate\": \"2020-10-22T15:10:12.000Z\",\r\n \"productSummaries\": [\r\n {\r\n \"quantity\": 1,\r\n \"requestedProductCode\": \"Product1\",\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"identifiers\": [\r\n {\r\n \"type\": \"SERIAL_NUMBER\",\r\n \"values\": [\r\n \"TEST99998\",\r\n \"TEST99999\"\r\n ]\r\n },\r\n {\r\n \"type\": \"IMEI\",\r\n \"values\": [\r\n \"351234567890123\",\r\n \"351234567890124\"\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"shipmentNumber\": 23124013,\r\n \"shipmentState\": \"DISPATCHED\",\r\n \"warehouseDetails\": {\r\n \"warehouse\": \"Omega\",\r\n \"warehouseId\": 31\r\n }\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/v3/sendOrderStateUpdate"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"83f84da5-2711-486b-a106-9cf3d4db170a"}],"id":"76015759-306f-40b7-8f05-5b60e9a7d14d","description":"

Endpoints in the 'Outbound' folder are requests which can be sent from THG Ingenuity API to a client URL.

The client must provide the URL to hit with each request and any authentication method which is required.

\n","_postman_id":"76015759-306f-40b7-8f05-5b60e9a7d14d"},{"name":"Create order","id":"c5767dae-6930-46c0-9b2d-38d7d848efc3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"address\": {\r\n \"city\": \"Salford\",\r\n \"countryCode\": \"GB\",\r\n \"customerName\": \"John Smith\",\r\n \"customerOrganisationName\": \"THG\",\r\n \"houseNumberOrName\": \"Floor 10\",\r\n \"line1\": \"Orange Tower\",\r\n \"line2\": \"Media City\",\r\n \"postcode\": \"M50 2HF\",\r\n \"state\": \"Manchester\"\r\n },\r\n \"clientOrderReference\": \"ClientOrder00001\",\r\n \"contact\": {\r\n \"email\": \"customer@test.com\",\r\n \"mobile\": \"+447700900123\",\r\n \"telephone\": \"+441614960123\"\r\n },\r\n \"currency\": \"GBP\",\r\n \"fillOrKill\": 1,\r\n \"locale\": \"en_GB\",\r\n \"marketplaceCreatedDate\": \"2024-01-01T00:00:00Z\",\r\n \"orderLines\": [\r\n {\r\n \"chargePricePerUnit\": 9.99,\r\n \"deliveryTypeId\": 1,\r\n \"productBarcode\": \"BARCODE\",\r\n \"productCode\": \"Product1\",\r\n \"quantity\": 4,\r\n \"taxAppliedPerUnit\": 1.66,\r\n \"personalisationId\": \"ABC999\",\r\n \"vatCode\": \"VATZ\",\r\n \"orderLineMetadata\":[\r\n {\r\n \"key\":\"OFFER_ID\",\r\n \"value\":\"5056644d-407b179d3c53\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"orderType\": \"B2C_FULFILMENT_ONLY\",\r\n \"personalisationUniqueIdentifier\": \"12345\",\r\n \"shippingCost\": 3.99,\r\n \"shippingTaxCost\": 1.5,\r\n \"clientFulfilmentLocationId\": \"1009999\",\r\n \"orderMetadata\":[\r\n {\r\n \"key\":\"PARTNER_ORDER_REFERENCE\",\r\n \"value\":\"5056644d-407b179d3c53\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order","description":"

This endpoint is used to send order creation request to THG Ingenuity. In response to this an Ingenuity-generated internal order number is sent to the client.

Request

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`address`	Address	Y	Shipping address.
`clientOrderReference`	string	Y	The client's order reference. Regex format `\\[A-Za-z0-9_:\\\\-.\\]+` with 64 character limit.
`contact`	Contact	Y	Contact details.
`currency`	string	Y	The currency used to on this order. ISO 4217 three-letter code e.g. `GBP`.
`fillOrKill`	integer	N	Set to false(`0`). This flag is not supported.
`locale`	string	Y	The locale the order was placed in. Use ISO-3166 Country Codes and ISO-639 Language Codes separated by a `_` e.g. `en_GB`.
`marketplaceCreatedDate`	string	N	The date and time the order was created. If not populated, current datetime in UTC is used. Expected format is UTC yyyy-MM-ddTHH:mm:ssZ
`orderLines`	Array of OrderLine	Y	The products and quantities that make up the order.
`orderType`	enum	Y	Allowed: `B2C_FULFILMENT_ONLY`
`personalisationUniqueIdentifier`	string	N	The identifier THG Ingenuity can use later to retrieve the personalisation information from the client. Should only be used when advised.
`shippingCost`	number	Y	The shipping cost the customer paid.
`shippingTaxCost`	number	N	Cost of shipping tax.
`clientFulfilmentLocationId`	string	N	The fulfilment location id for the order (e.g. a store ID). Required when the delivery type involves collection from a location.
`orderMetadata`	KV Pair	N	An array of Key/Value pairs used to supply additional data for the order. Valid keys are listed below

Address

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`city`	string	N	The city name. Max. 64 characters.
`countryCode`	string	Y	Two character country code - ISO 3166-1 alpha-2.
`customerName`	string	Y	The customer's name. Max. 64 characters.
`customerOrganisationName`	string	N	The organisation's name. Max. 64 characters.
`houseNumberOrName`	string	Y	The house number/name. Max. 32 characters.
`line1`	string	N	The first address line. Max. 64 characters.
`line2`	string	N	The second address line. Max. 64 characters.
`postcode`	string	Y	The post/zip code. Max. 16 characters. For territories without postal codes (e.g. Dubai) the field should be populated with `000000`.
`state`	string	N	For most territories, this is the region of the country, but for the USA it is mandatory. Use 2 or 3 letter state codes for United States, Canada and Australia e.g. `AL` for Alabama, `NSW` for New South Wales.

Contact

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`email`	string	N	The customer's email address, the address must pass validation as a valid email address format.
`mobile`	string	Y	The customer's mobile / cell number. Format of the number is validated.
`telephone`	string	N	The customer's telephone number. Format of the number is validated.

OrderLine

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`chargePricePerUnit`	number	Y	The amount charged per unit including tax charged.
`deliveryTypeId`	integer	Y	The delivery type identifier to be used.
`productBarcode`	string	N	The ordered product's barcode. Must be supplied if `productCode` is not provided.
`productCode`	string	Y	The ordered product code.
`quantity`	integer	Y	The ordered quantity of the product.
`taxAppliedPerUnit`	number	Y	The amount of tax charged per unit.
`personalisationId`	string	N	The identifier for the personalisation information for this order line.
`vatCode`	string	N	Alphanumeric with max. 32 characters.
`orderLineMetadata`	KV Pair	N	An array of Key/Value pairs used to supply additional data for the order line. Valid keys are listed below

KV Pair

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`key`	string	Y	Key, valid keys listed below.
`value`	string	Y	Value, mandatory if a Key is provided.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Context	Valid Keys	Notes
orderLineMetadata	OFFER_ID	Sample Key, not in live use.
orderMetadata	PARTNER_ORDER_REFERENCE	To specify additional order reference required later in the fulfilment process.

Duplicate/Repeated Order Line Behaviour

There are two different scenarios whereby duplicate or repeated Order Lines may attempt to be created.

Duplicate Order Line - where there is at least two Order Lines on the Order object with the same productCode and all other fields within the Order Line object have the same values as each other. The second (and any subsequent) line for the same productCode is treated as a duplicate and ignored. The Order is created if it passes all other validation and the created Order contains only one instance of the duplicated Order Line.
\n
Repeated Product Code - where there is at least two Order Lines on the Order object with the same productCode but at least one of the other fields' values within the Order Line object differs from the other Order Line. In this case, the Order creation fails, and the caller receives an error message Response.
\n

Duplicate Order Line Snippet Example

All values in the two lines are identical.

...\n{\n     \"chargePricePerUnit\": 2,\n     \"deliveryTypeId\": \"6\",\n     \"productCode\": \"11223344\",\n     \"quantity\": 1,\n     \"taxAppliedPerUnit\": 0\n   },\n{\n     \"chargePricePerUnit\": 2,\n     \"deliveryTypeId\": \"6\",\n     \"productCode\": \"11223344\",\n     \"quantity\": 1,\n     \"taxAppliedPerUnit\": 0\n   }\n...\n\n

Repeated Product Code Snippet Example

At least one value between the two objects differs. In this case, the chargePricePerUnit.

...\n{\n     \"chargePricePerUnit\": 0,\n     \"deliveryTypeId\": \"6\",\n     \"productCode\": \"11223344\",\n     \"quantity\": 1,\n     \"taxAppliedPerUnit\": 0\n   },\n{\n     \"chargePricePerUnit\": 5,\n     \"deliveryTypeId\": \"6\",\n     \"productCode\": \"11223344\",\n     \"quantity\": 1,\n     \"taxAppliedPerUnit\": 0\n   }\n...\n\n

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"address\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"city\": {\n          \"type\": \"string\"\n        },\n        \"countryCode\": {\n          \"type\": \"string\"\n        },\n        \"customerName\": {\n          \"type\": \"string\"\n        },\n        \"customerOrganisationName\": {\n          \"type\": \"string\"\n        },\n        \"houseNumberOrName\": {\n          \"type\": \"string\"\n        },\n        \"line1\": {\n          \"type\": \"string\"\n        },\n        \"line2\": {\n          \"type\": \"string\"\n        },\n        \"postcode\": {\n          \"type\": \"string\"\n        },\n        \"state\": {\n          \"type\": \"string\"\n        }\n      },\n      \"required\": [\n        \"countryCode\",\n        \"customerName\",\n        \"houseNumberOrName\",\n        \"postcode\"\n      ]\n    },\n    \"clientOrderReference\": {\n      \"type\": \"string\"\n    },\n    \"contact\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"email\": {\n          \"type\": \"string\"\n        },\n        \"mobile\": {\n          \"type\": \"string\"\n        },\n        \"telephone\": {\n          \"type\": \"string\"\n        }\n      },\n      \"required\": [\n        \"mobile\"\n      ]\n    },\n    \"currency\": {\n      \"type\": \"string\"\n    },\n    \"fillOrKill\": {\n      \"type\": \"integer\"\n    },\n    \"locale\": {\n      \"type\": \"string\"\n    },\n    \"marketplaceCreatedDate\": {\n      \"type\": \"string\"\n    },\n    \"orderLines\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"chargePricePerUnit\": {\n              \"type\": \"number\"\n            },\n            \"deliveryTypeId\": {\n              \"type\": \"integer\"\n            },\n            \"productBarcode\": {\n              \"type\": \"string\"\n            },\n            \"productCode\": {\n              \"type\": \"string\"\n            },\n            \"quantity\": {\n              \"type\": \"integer\"\n            },\n            \"taxAppliedPerUnit\": {\n              \"type\": \"number\"\n            },\n            \"personalisationId\": {\n              \"type\": \"string\"\n            },\n            \"vatCode\": {\n              \"type\": \"string\"\n            }\n          },\n          \"required\": [\n            \"chargePricePerUnit\",\n            \"deliveryTypeId\",\n            \"productCode\",\n            \"quantity\",\n            \"taxAppliedPerUnit\"\n          ]\n        }\n      ]\n    },\n    \"orderType\": {\n      \"type\": \"string\"\n    },\n    \"personalisationUniqueIdentifier\": {\n      \"type\": \"string\"\n    },\n    \"shippingCost\": {\n      \"type\": \"number\"\n    },\n    \"shippingTaxCost\": {\n      \"type\": \"number\"\n    },\n    \"clientFulfilmentLocationId\": {\n      \"type\": \"string\"\n    }\n  },\n  \"required\": [\n    \"address\",\n    \"clientOrderReference\",\n    \"contact\",\n    \"currency\",\n    \"locale\",\n    \"orderLines\",\n    \"orderType\",\n    \"shippingCost\"\n  ]\n}\n\n

\n","urlObject":{"path":["v2","order"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"997456d6-0e36-46d5-a174-60312a6ec86b","name":"Success 200","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"address\": {\r\n \"city\": \"Salford\",\r\n \"countryCode\": \"GB\",\r\n \"customerName\": \"John Smith\",\r\n \"customerOrganisationName\": \"THG\",\r\n \"houseNumberOrName\": \"Floor 10\",\r\n \"line1\": \"Orange Tower\",\r\n \"line2\": \"Media City\",\r\n \"postcode\": \"M50 2HF\",\r\n \"state\": \"Manchester\"\r\n },\r\n \"clientOrderReference\": \"ClientOrder00001\",\r\n \"contact\": {\r\n \"email\": \"customer@test.com\",\r\n \"mobile\": \"+447700900123\",\r\n \"telephone\": \"+441614960123\"\r\n },\r\n \"currency\": \"GBP\",\r\n \"fillOrKill\": 1,\r\n \"locale\": \"en_GB\",\r\n \"marketplaceCreatedDate\": \"2024-01-01T00:00:00Z\",\r\n \"orderLines\": [\r\n {\r\n \"chargePricePerUnit\": 9.99,\r\n \"deliveryTypeId\": 1,\r\n \"productBarcode\": \"BARCODE\",\r\n \"productCode\": \"Product1\",\r\n \"quantity\": 4,\r\n \"taxAppliedPerUnit\": 1.66,\r\n \"personalisationId\": \"ABC999\",\r\n \"vatCode\": \"VATZ\",\r\n \"orderLineMetadata\":[\r\n {\r\n \"key\":\"OFFER_ID\",\r\n \"value\":\"5056644d-407b179d3c53\"\r\n }\r\n ]\r\n }\r\n ],\r\n \"orderType\": \"B2C_FULFILMENT_ONLY\",\r\n \"personalisationUniqueIdentifier\": \"12345\",\r\n \"shippingCost\": 3.99,\r\n \"shippingTaxCost\": 1.5,\r\n \"clientFulfilmentLocationId\": \"1009999\",\r\n \"orderMetadata\":[\r\n {\r\n \"key\":\"PARTNER_ORDER_REFERENCE\",\r\n \"value\":\"5056644d-407b179d3c53\"\r\n }\r\n ]\r\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"AB_1234"},{"id":"ed323fd4-e28a-4347-b889-9ef42b26a79a","name":"Failure 400","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"address\": {\r\n \"city\": \"Salford\",\r\n \"countryCode\": \"GBC\",\r\n \"customerName\": \"John Smith\",\r\n \"customerOrganisationName\": \"THG\",\r\n \"houseNumberOrName\": \"Floor 10\",\r\n \"line1\": \"Orange Tower\",\r\n \"line2\": \"Media City\",\r\n \"postcode\": \"M50 2HF\",\r\n \"state\": \"Manchester\"\r\n },\r\n \"clientOrderReference\": \"ClientOrder00001\",\r\n \"contact\": {\r\n \"email\": \"customer@test.com\",\r\n \"mobile\": \"+447700900123\",\r\n \"telephone\": \"+441614960123\"\r\n },\r\n \"currency\": \"GBP\",\r\n \"fillOrKill\": 1,\r\n \"locale\": \"en_GB\",\r\n \"marketplaceCreatedDate\": \"2024-01-01T00:00:00Z\",\r\n \"orderLines\": [\r\n {\r\n \"chargePricePerUnit\": 9.99,\r\n \"deliveryTypeId\": 1,\r\n \"productBarcode\": \"BARCODE\",\r\n \"productCode\": \"Product1\",\r\n \"quantity\": 4,\r\n \"taxAppliedPerUnit\": 1.66,\r\n \"personalisationId\": \"ABC999\",\r\n \"vatCode\": \"VATZ\"\r\n }\r\n ],\r\n \"orderType\": \"B2C_FULFILMENT_ONLY\",\r\n \"personalisationUniqueIdentifier\": \"12345\",\r\n \"shippingCost\": 3.99,\r\n \"shippingTaxCost\": 1.5,\r\n \"clientFulfilmentLocationId\": \"1009999\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"Request failed validation. - com.thehutgroup.orderprocessingapi.ingestion.domain.exception.InvalidStringException: Field incorrect length. Contents: GBB , Required Length: 2"},{"id":"d7fa6fda-798b-47cc-b747-0084be6c2e3a","name":"Failure 400 Repeated Product Code","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"address\": {\r\n \"city\": \"Salford\",\r\n \"countryCode\": \"GB\",\r\n \"customerName\": \"John Smith\",\r\n \"customerOrganisationName\": \"THG\",\r\n \"houseNumberOrName\": \"Floor 10\",\r\n \"line1\": \"Orange Tower\",\r\n \"line2\": \"Media City\",\r\n \"postcode\": \"M50 2HF\",\r\n \"state\": \"Manchester\"\r\n },\r\n \"clientOrderReference\": \"ClientOrder00001\",\r\n \"contact\": {\r\n \"email\": \"customer@test.com\",\r\n \"mobile\": \"+447700900123\",\r\n \"telephone\": \"+441614960123\"\r\n },\r\n \"currency\": \"GBP\",\r\n \"fillOrKill\": 1,\r\n \"locale\": \"en_GB\",\r\n \"marketplaceCreatedDate\": \"2024-01-01T00:00:00Z\",\r\n \"orderLines\": [\r\n {\r\n \"chargePricePerUnit\": 9.99,\r\n \"deliveryTypeId\": 1,\r\n \"productCode\": \"11223344\",\r\n \"quantity\": 1,\r\n \"taxAppliedPerUnit\": 0\r\n },\r\n {\r\n \"chargePricePerUnit\": 0.01,\r\n \"deliveryTypeId\": 1,\r\n \"productCode\": \"11223344\",\r\n \"quantity\": 1,\r\n \"taxAppliedPerUnit\": 0\r\n }\r\n ],\r\n \"orderType\": \"B2C_FULFILMENT_ONLY\",\r\n \"personalisationUniqueIdentifier\": \"12345\",\r\n \"shippingCost\": 3.99,\r\n \"shippingTaxCost\": 1.5,\r\n \"clientFulfilmentLocationId\": \"1009999\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"Request failed validation. - Order lines are not distinct. At least one product id is duplicated."},{"id":"543fedfe-0c1c-4b8c-a7ad-feb33bf9cdb0","name":"Failure 409","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"address\": {\r\n \"city\": \"Salford\",\r\n \"countryCode\": \"GB\",\r\n \"customerName\": \"John Smith\",\r\n \"customerOrganisationName\": \"THG\",\r\n \"houseNumberOrName\": \"Floor 10\",\r\n \"line1\": \"Orange Tower\",\r\n \"line2\": \"Media City\",\r\n \"postcode\": \"M50 2HF\",\r\n \"state\": \"Manchester\"\r\n },\r\n \"clientOrderReference\": \"ClientOrder00001\",\r\n \"contact\": {\r\n \"email\": \"customer@test.com\",\r\n \"mobile\": \"+447700900123\",\r\n \"telephone\": \"+441614960123\"\r\n },\r\n \"currency\": \"GBP\",\r\n \"fillOrKill\": 1,\r\n \"locale\": \"en_GB\",\r\n \"marketplaceCreatedDate\": \"2024-01-01T00:00:00Z\",\r\n \"orderLines\": [\r\n {\r\n \"chargePricePerUnit\": 9.99,\r\n \"deliveryTypeId\": 1,\r\n \"productBarcode\": \"BARCODE\",\r\n \"productCode\": \"Product1\",\r\n \"quantity\": 4,\r\n \"taxAppliedPerUnit\": 1.66,\r\n \"personalisationId\": \"ABC999\",\r\n \"vatCode\": \"VATZ\"\r\n }\r\n ],\r\n \"orderType\": \"B2C_FULFILMENT_ONLY\",\r\n \"personalisationUniqueIdentifier\": \"12345\",\r\n \"shippingCost\": 3.99,\r\n \"shippingTaxCost\": 1.5,\r\n \"clientFulfilmentLocationId\": \"1009999\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order"},"status":"Conflict","code":409,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"Order ingestion failed as the order already exists."},{"id":"65956e98-1acd-4629-a239-cc7afef374ef","name":"Failure 500","originalRequest":{"method":"PUT","header":[],"body":{"mode":"raw","raw":"{\r\n \"address\": {\r\n \"city\": \"Salford\",\r\n \"countryCode\": \"GB\",\r\n \"customerName\": \"John Smith\",\r\n \"customerOrganisationName\": \"THG\",\r\n \"houseNumberOrName\": \"Floor 10\",\r\n \"line1\": \"Orange Tower\",\r\n \"line2\": \"Media City\",\r\n \"postcode\": \"M50 2HF\",\r\n \"state\": \"Manchester\"\r\n },\r\n \"clientOrderReference\": \"ClientOrder00001\",\r\n \"contact\": {\r\n \"email\": \"customer@test.com\",\r\n \"mobile\": \"+447700900123\",\r\n \"telephone\": \"+441614960123\"\r\n },\r\n \"currency\": \"GBP\",\r\n \"fillOrKill\": 1,\r\n \"locale\": \"en_GB\",\r\n \"marketplaceCreatedDate\": \"2024-01-01T00:00:00Z\",\r\n \"orderLines\": [\r\n {\r\n \"chargePricePerUnit\": 9.99,\r\n \"deliveryTypeId\": 1,\r\n \"productBarcode\": \"BARCODE\",\r\n \"productCode\": \"Product1\",\r\n \"quantity\": 4,\r\n \"taxAppliedPerUnit\": 1.66,\r\n \"personalisationId\": \"ABC999\",\r\n \"vatCode\": \"VATZ\"\r\n }\r\n ],\r\n \"orderType\": null,\r\n \"personalisationUniqueIdentifier\": \"12345\",\r\n \"shippingCost\": 3.99,\r\n \"shippingTaxCost\": 1.5,\r\n \"clientFulfilmentLocationId\": \"1009999\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"Server error."}],"_postman_id":"c5767dae-6930-46c0-9b2d-38d7d848efc3"},{"name":"Cancel order lines","id":"17cb95c3-00dc-49ed-aca4-1d841df737a0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"actionLines\": [\r\n {\r\n \"actionQty\": 3,\r\n \"productBarcode\": \"BARCODE\",\r\n \"productCode\": \"Product1\"\r\n }\r\n ],\r\n \"actionType\": \"CANCEL\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/action?client-order-reference=ClientOrder00001&platform-order-reference=AB_1234","description":"

This endpoint can be used to request the cancellation of order lines for the given THG Ingenuity order number or the client order number.

Order lines to action and required action to perform are sent as part of the request body.

As the response, the action performed and the actioned product-quantity details are sent back to the client.

In the case of the action not being able to be completed (e.g. a cancel action was requested, but the cancel could not be completed), the response will be HTTP Status 200 and the array under actionableLines and the action requested (e.g. CANCEL) will be empty. See one of the responses on the opposite panel for an example for how this looks.

Request

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`client-order-reference`	string	The client's order reference. Either this or `platform-order-reference` is required. E.g. `ClientOrder00001`
`platform-order-reference`	string	The THG Ingenuity internal order reference. Either this or `client-order-reference` is required. E.g. `AB_1234`

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`actionType`	string	Y	Value should be set to `CANCEL`.
`actionLines`	Array of ActionLine	Y	List of order lines to be cancelled.

ActionLine

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`actionQty`	integer	Y	Quantity of product to be cancelled.
`productCode`	string	Y	The product code for the product to be cancelled.
`productBarcode`	string	N	The product barcode for the product to be cancelled. This must be supplied if `productCode` is not provided.

Request JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"actionLines\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"actionQty\": {\n              \"type\": \"integer\"\n            },\n            \"productBarcode\": {\n              \"type\": \"string\"\n            },\n            \"productCode\": {\n              \"type\": \"string\"\n            }\n          },\n          \"required\": [\n            \"actionQty\",\n            \"productBarcode\",\n            \"productCode\"\n          ]\n        }\n      ]\n    },\n    \"actionType\": {\n      \"type\": \"string\"\n    }\n  },\n  \"required\": [\n    \"actionLines\",\n    \"actionType\"\n  ]\n}\n\n

","urlObject":{"path":["v2","order","action"],"host":[""],"query":[{"description":{"content":"

The client's order reference. Either this or platform-order-reference is required.
E.g. ClientOrder00001

\n","type":"text/plain"},"key":"client-order-reference","value":"ClientOrder00001"},{"description":{"content":"

The THG Ingenuity internal order reference. Either this or client-order-reference is required.
E.g. AB_1234

\n","type":"text/plain"},"key":"platform-order-reference","value":"AB_1234"}],"variable":[]}},"response":[{"id":"54472e65-5e02-4349-aef4-372ea3854f1a","name":"200 - Cancel Occurred","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"actionLines\": [\r\n {\r\n \"actionQty\": 3,\r\n \"productBarcode\": \"BARCODE\",\r\n \"productCode\": \"Product1\"\r\n }\r\n ],\r\n \"actionType\": \"CANCEL\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/v2/order/action?client-order-reference=ClientOrder00001&platform-order-reference=AB_1234","host":[""],"path":["v2","order","action"],"query":[{"key":"client-order-reference","value":"ClientOrder00001","description":"The client's order reference. Either this or platform-order-reference is required. \nE.g. ClientOrder00001"},{"key":"platform-order-reference","value":"AB_1234","description":"The THG Ingenuity internal order reference. Either this or client-order-reference is required. \nE.g. AB_1234"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"actionableLines\": {\r\n \"CANCEL\": {\r\n \"productBarcode\": \"BARCODE\",\r\n \"productCode\": \"Product1\",\r\n \"actionQty\": 3\r\n }\r\n },\r\n \"platformOrderNumber\": \"AB_1234\"\r\n}"},{"id":"89bebc22-9dff-4437-8010-60c1c21c9efb","name":"200 - No Cancel","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"actionLines\": [\r\n {\r\n \"actionQty\": 3,\r\n \"productBarcode\": \"BARCODE\",\r\n \"productCode\": \"Product1\"\r\n }\r\n ],\r\n \"actionType\": \"CANCEL\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/v2/order/action?client-order-reference=ClientOrder00001&platform-order-reference=AB_1234","host":[""],"path":["v2","order","action"],"query":[{"key":"client-order-reference","value":"ClientOrder00001","description":"The client's order reference. Either this or platform-order-reference is required. \nE.g. ClientOrder00001"},{"key":"platform-order-reference","value":"AB_1234","description":"The THG Ingenuity internal order reference. Either this or client-order-reference is required. \nE.g. AB_1234"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\r\n \"actionableLines\": {\r\n \"CANCEL\": []\r\n },\r\n \"platformOrderNumber\": \"AB_1234\"\r\n}"},{"id":"a43ea1ec-1d8a-4366-84e9-9e6103b6d190","name":"Failure 400 with no client or platform order number in request param","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"actionLines\": [\r\n {\r\n \"actionQty\": 3,\r\n \"productBarcode\": \"BARCODE\",\r\n \"productCode\": \"Product1\"\r\n }\r\n ],\r\n \"actionType\": \"CANCEL\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/action"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"b12b0b07-a936-4fb8-8c2d-10503184f798","name":"Failure 400 with invalid payload field","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"actionLines\": [\r\n {\r\n \"actionQty\": 3,\r\n \"productBarcode\": \"BARCODE\",\r\n \"productCode\": \"Product1\"\r\n }\r\n ],\r\n \"actionType\": null\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/v2/order/action?client-order-reference=ClientOrder00001","host":[""],"path":["v2","order","action"],"query":[{"key":"client-order-reference","value":"ClientOrder00001"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"Action type, actionLines, or first object in actionLines is null."},{"id":"e8a12c77-965c-4495-95d5-3d996b7cf0a4","name":"Failure 404","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"actionLines\": [\r\n {\r\n \"actionQty\": 3,\r\n \"productBarcode\": \"BARCODE\",\r\n \"productCode\": \"Product1\"\r\n }\r\n ],\r\n \"actionType\": \"CANCEL\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/v2/order/action?client-order-reference=ClientOrder11112233","host":[""],"path":["v2","order","action"],"query":[{"key":"client-order-reference","value":"ClientOrder11112233"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"Failed to find order."},{"id":"7fc6188c-ecc3-4208-8863-918c75380a9d","name":"Failure 410","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"actionLines\": [\r\n {\r\n \"actionQty\": 3,\r\n \"productBarcode\": \"BARCODE\",\r\n \"productCode\": \"Product1\"\r\n }\r\n ],\r\n \"actionType\": \"CANCEL\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/v2/order/action?client-order-reference=ClientOrder11112233","host":[""],"path":["v2","order","action"],"query":[{"key":"client-order-reference","value":"ClientOrder11112233"}]}},"status":"Gone","code":410,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"Order has been archived."},{"id":"2cb33e57-46e5-409e-a22b-47835c4be86b","name":"Failure 500","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"actionLines\": [\r\n {\r\n \"actionQty\": 3,\r\n \"productBarcode\": \"BARCODE\",\r\n \"productCode\": \"Product1\"\r\n }\r\n ],\r\n \"actionType\": \"CANCEL\"\r\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/v2/order/action?client-order-reference=ClientOrder11112233","host":[""],"path":["v2","order","action"],"query":[{"key":"client-order-reference","value":"ClientOrder11112233"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"17cb95c3-00dc-49ed-aca4-1d841df737a0"},{"name":"Actionable Order Lines","id":"5dd77e8c-8faa-4a07-984f-4f8e1e6aefa5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/v2/order/action?client-order-reference=ClientOrder00001&platform-order-reference=AB_1234&action-type=CANCEL","description":"

This endpoint can be used to request the 'actionable' order lines for the given THG Ingenuity order number or the client order number.

Currently the valid action-type to be used are:

CANCEL

The response to this request, if successful, is the list of actionable order lines on the order and the action-type that is valid for them.

Request

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`client-order-reference`	string	The client's order reference. Either this or `platform-order-reference` is required. E.g. `ClientOrder00001`
`platform-order-reference`	string	The THG Ingenuity internal order reference. Either this or `client-order-reference` is required. E.g. `AB_1234`
`action-type`	string	The action type to check for.

Response

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`platformOrderNumber`	string	The THG Ingenuity order reference.
`actionableLines`	Array of ActionLine by Action	List of order lines that are actionable by Action (e.g. `CANCEL`)

ActionLine

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`actionQty`	integer	Quantity of product that can be actioned.
`productCode`	string	The THG Ingenuity product ID for the product that can be actioned.
`productBarcode`	string	The barcode for the product that can be actioned.

","urlObject":{"path":["v2","order","action"],"host":[""],"query":[{"description":{"content":"

The client's order reference. Either this or platform-order-reference is required.

\n","type":"text/plain"},"key":"client-order-reference","value":"ClientOrder00001"},{"description":{"content":"

The THG Ingenuity internal order reference. Either this or client-order-reference is required.

\n","type":"text/plain"},"key":"platform-order-reference","value":"AB_1234"},{"description":{"content":"

The action type to check for.

\n","type":"text/plain"},"key":"action-type","value":"CANCEL"}],"variable":[]}},"response":[{"id":"fee289a1-63e4-4b9a-9700-cba1fe6555f3","name":"200 - Actionable","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"/v2/order/action?platform-order-reference=AB_1234&action-type=CANCEL","host":[""],"path":["v2","order","action"],"query":[{"key":"platform-order-reference","value":"AB_1234","description":"The THG Ingenuity internal order reference. Either this or client-order-reference is required."},{"key":"client-order-reference","value":"ClientOrder00001","description":"The client's order reference. Either this or platform-order-reference is required.","disabled":true},{"key":"action-type","value":"CANCEL","description":"The action type to check for."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"platformOrderNumber\": \"AB_1234\",\r\n \"actionableLines\": {\r\n \"CANCEL\": {\r\n \"productBarcode\": \"BARCODE\",\r\n \"productCode\": \"Product1\",\r\n \"actionQty\": 3\r\n }\r\n }\r\n}"},{"id":"9640f0f1-5e2d-4fda-840f-a09b2bedef41","name":"200 - Not Actionable","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"/v2/order/action?platform-order-reference=AB_1234&action-type=CANCEL","host":[""],"path":["v2","order","action"],"query":[{"key":"platform-order-reference","value":"AB_1234","description":"The THG Ingenuity internal order reference. Either this or client-order-reference is required."},{"key":"client-order-reference","value":"ClientOrder00001","description":"The client's order reference. Either this or platform-order-reference is required.","disabled":true},{"key":"action-type","value":"CANCEL","description":"The action type to check for."}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"platformOrderNumber\": \"AB_1234\",\r\n \"actionableLines\": {\r\n \"CANCEL\": []\r\n }\r\n}"},{"id":"09bcf664-a102-40b1-b25c-1b25f4437ffc","name":"Failure 404","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"/v2/order/action?client-order-reference=ClientOrder11112233&action-type=CANCEL","host":[""],"path":["v2","order","action"],"query":[{"key":"client-order-reference","value":"ClientOrder11112233"},{"key":"action-type","value":"CANCEL"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"Failed to find order."},{"id":"f645b590-8e3a-41d9-8033-83e2e99d12d0","name":"Failure 500 - Invalid Action Type","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":{"raw":"/v2/order/action?platform-order-reference=AB_1234&action-type=CANC","host":[""],"path":["v2","order","action"],"query":[{"key":"platform-order-reference","value":"AB_1234"},{"key":"action-type","value":"CANC"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"5dd77e8c-8faa-4a07-984f-4f8e1e6aefa5"},{"name":"Get order status","id":"811d9332-240d-4642-86ea-e134507e0cf9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v2/order/status?client-order-reference=ClientOrder00001&platform-order-reference=AB_1234","description":"

This endpoint is used to get order status details for the given THG Ingenuity order number or the client order number.

Request

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`client-order-reference`	string	The client's order reference. Either this or `platform-order-reference` is required. E.g. `ClientOrder00001`
`platform-order-reference`	string	The THG Ingenuity internal order reference. Either this or `client-order-reference` is required. E.g. `AB_1234`

Response

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`platformOrderReference`	string	Y	The THG Ingenuity internal order reference.
`clientOrderReference`	string	Y	Order reference from client which is sent to THG during order creation
`productSummaries`	Array of ProductSummary	Y	Summary of the requested products including status of the product quantities.
`shipments`	Array of Shipment	Y	Shipment information.
`cancellation`	Array of Cancellation	N	This section is available if any of the order items are cancelled. This will detail out the item and its quantity cancelled along with reason to cancel. If there are no cancellations then this will be an empty array.

ProductSummary

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`requestedProductBarcode`	string	Y	Barcode of the requested product.
`requestedProductCode`	string	Y	Product code of the requested product.
`allocatedProductBarcode`	string	N	Barcode of the allocated product, if applicable.
`allocatedProductCode`	string	N	Product code of the allocated product, if applicable.
`fulfilmentStateQuantities`	Map [ state string : quantity integer ]	Y	States supported: `PROCESSING`, `DISPATCHED`, `CANCELLED`.

Shipment

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`shipmentNumber`	integer	Y	Shipment number.
`shipmentState`	string	Y	Current state of the shipment.
`despatchedDate`	string	Y	Date when shipment was dispatched. Format: yyyy-MM-ddTHH:mm:ssZ.
`trackingUrl`	string	Y	Shipment tracking URL.
`courierDetails`	CourierDetails	N	Information about the shipment's courier.
`productSummaries`	Array of ShipmentProductSummary	Y	Summary of product information within a shipment.
`warehouseDetails`	WarehouseDetail	N	Warehouse information for the shipment.

CourierDetails

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`courierProviderId`	integer	Y	THG Ingenuity courier identifier.
`courierProviderName`	string	Y	Name of courier provider.
`courierServiceId`	integer	Y	THG Ingenuity courier service identifier.
`courierServiceName`	string	Y	Name of courier service.
`trackingNumber`	string	Y	Shipment courier tracking number.
`courierCode`	string	N	Standard Carrier Alpha Code (SCAC)

ShipmentProductSummary

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`requestedProductBarcode`	string	Y	Product Code of the requested product. This is not the barcode.
`quantity`	integer	Y	Quantity of the requested product in the shipment.
`serialNumbers`	Array of string	N	List of serial numbers associated with the dispatched product, where provided.
`batchExpiryInformation`	Array of BatchExpiryInformation	N	Array of batch and expiry information for the given product, where provided.
`identifiers`	Array of Identifiers	N	Array of all identifiers associated with the product, where provided. If no values are available for any of the identifiers then this will be an empty array.

Identifiers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`type`	string	Y	Type of identifier, eg. SERIAL_NUMBER, IMEI
`values`	Array of string	Y	List of values associated with identifier.

BatchExpiryInformation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`quantity`	integer	Y	Quantity of product associated with batch number and expiry date.
`batchNumber`	string	Y	Batch/Lot number of the product.
`expiryDate`	string	Y	Expiry date of the product. Format: yyyy-MM-ddTHH:mm:ssZ

WarehouseDetail

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`warehouse`	string	Y	Warehouse name.
`warehouseId`	integer	Y	THG Ingenuity warehouse ID.

Cancellation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`productCode`	string	Y	Product code of cancelled product
`quantity`	integer	Y	Quantity of the cancelled product
`reason`	string	Y	Reason to cancel the product. Reasons supported: `DAMAGED`, `CUSTOMER`, `CLIENT`, `LOST`

Response Body JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"platformOrderReference\": {\n      \"type\": \"string\"\n    },\n    \"clientOrderReference\": {\n      \"type\": \"string\"\n    },\n    \"productSummaries\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"allocatedProductBarcode\": {\n              \"type\": \"string\"\n            },\n            \"allocatedProductCode\": {\n              \"type\": \"string\"\n            },\n            \"fulfilmentStateQuantities\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"any-key\": {\n                  \"type\": \"integer\"\n                }\n              }\n            },\n            \"requestedProductBarcode\": {\n              \"type\": \"string\"\n            },\n            \"requestedProductCode\": {\n              \"type\": \"string\"\n            }\n          },\n          \"required\": [\n            \"fulfilmentStateQuantities\",\n            \"requestedProductBarcode\",\n            \"requestedProductCode\"\n          ]\n        }\n      ]\n    },\n    \"shipments\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"courierDetails\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"courierProviderId\": {\n                  \"type\": \"integer\"\n                },\n                \"courierProviderName\": {\n                  \"type\": \"string\"\n                },\n                \"courierServiceId\": {\n                  \"type\": \"integer\"\n                },\n                \"courierServiceName\": {\n                  \"type\": \"string\"\n                },\n                \"trackingNumber\": {\n                  \"type\": \"string\"\n                },\n                \"courierCode\": {\n                  \"type\": \"string\"\n                }\n              },\n              \"required\": [\n                \"courierProviderId\",\n                \"courierProviderName\",\n                \"courierServiceId\",\n                \"courierServiceName\",\n                \"trackingNumber\"\n              ]\n            },\n            \"despatchedDate\": {\n              \"type\": \"string\"\n            },\n            \"productSummaries\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"quantity\": {\n                      \"type\": \"integer\"\n                    },\n                    \"requestedProductBarcode\": {\n                      \"type\": \"string\"\n                    },\n                     \"serialNumbers\": {\n                      \"type\": \"array\",\n                      \"items\": [\n                        {\n                          \"type\": \"string\"\n                        }\n                      ]\n                    },\n                    \"batchExpiryInformation\": {\n                      \"type\": \"array\",\n                      \"items\": [\n                        {\n                          \"type\": \"object\",\n                          \"properties\": {\n                            \"quantity\": {\n                              \"type\": \"integer\"\n                            },\n                            \"batchNumber\": {\n                              \"type\": \"string\"\n                            },\n                            \"expiryDate\": {\n                              \"type\": \"string\"\n                            }\n                          },\n                          \"required\": [\n                            \"quantity\",\n                            \"batchNumber\",\n                            \"expiryDate\"\n                          ]\n                        }\n                      ]\n                    },\n                    \"identifiers\": {\n                      \"type\": \"array\",\n                      \"items\": [\n                        {\n                          \"type\": \"object\",\n                          \"properties\": {\n                            \"type\": {\n                              \"type\": \"string\"\n                            },\n                            \"values\": {\n                              \"type\": \"array\",\n                              \"items\": [\n                                {\n                                  \"type\": \"string\"\n                                }\n                              ]\n                            }\n                          },\n                          \"required\": [\n                            \"type\",\n                            \"values\",\n                          ]\n                        }\n                      ]\n                    } \n                  },\n                  \"required\": [\n                    \"quantity\",\n                    \"requestedProductBarcode\"\n                  ]\n                }\n              ]\n            },\n            \"shipmentNumber\": {\n              \"type\": \"integer\"\n            },\n            \"shipmentState\": {\n              \"type\": \"string\"\n            },\n            \"trackingUrl\": {\n              \"type\": \"string\"\n            },\n            \"warehouseDetails\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"warehouse\": {\n                  \"type\": \"string\"\n                },\n                \"warehouseId\": {\n                  \"type\": \"integer\"\n                }\n              },\n              \"required\": [\n                \"warehouse\",\n                \"warehouseId\"\n              ]\n            }\n          },\n          \"required\": [\n            \"courierDetails\",\n            \"despatchedDate\",\n            \"productSummaries\",\n            \"shipmentNumber\",\n            \"shipmentState\"\n          ]\n        }\n      ]\n    },\n     \"cancellation\": {\n      \"type\": \"array\",\n        \"items\": [\n          {\n            \"type\": \"object\",\n              \"properties\": {\n                \"productCode\": {\n                  \"type\": \"string\"\n                },\n                \"quantity\": {\n                  \"type\": \"integer\"\n                },\n                \"reason\": {\n                  \"type\": \"string\"\n                },\n              },\n              \"required\": [\n                \"productCode\",\n                \"quantity\",\n                \"reason\"\n              ]\n          }\n        ]  \n     }\n  },\n  \"required\": [\n    \"platformOrderReference\",\n    \"productSummaries\",\n    \"shipments\"\n  ]\n}\n\n

\n","urlObject":{"path":["v2","order","status"],"host":[""],"query":[{"description":{"content":"

The client's order reference. Either this or platform-order-reference is required.
E.g. ClientOrder00001

\n","type":"text/plain"},"key":"client-order-reference","value":"ClientOrder00001"},{"description":{"content":"

The THG Ingenuity internal order reference. Either this or client-order-reference is required.
E.g. AB_1234

\n","type":"text/plain"},"key":"platform-order-reference","value":"AB_1234"}],"variable":[]}},"response":[{"id":"663f4a77-18f8-4fb9-932f-1539fa705efd","name":"Success 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v2/order/status?client-order-reference=ClientOrder00001","host":[""],"path":["v2","order","status"],"query":[{"key":"client-order-reference","value":"ClientOrder00001","description":"The client's order reference. Either this or platform-order-reference is required. \nE.g. ClientOrder00001"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"platformOrderReference\": \"AB_1234\",\r\n \"clientOrderReference\": \"ClientOrder00001\",\r\n \"productSummaries\": [\r\n {\r\n \"allocatedProductBarcode\": \"BARCODE\",\r\n \"allocatedProductCode\": \"Product1\",\r\n \"fulfilmentStateQuantities\": {\r\n \"PROCESSING\": 1,\r\n \"CANCELLED\": 1,\r\n \"DISPATCHED\": 1\r\n },\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"requestedProductCode\": \"Product1\"\r\n }\r\n ],\r\n \"shipments\": [\r\n {\r\n \"courierDetails\": {\r\n \"courierProviderId\": 150,\r\n \"courierProviderName\": \"UPS\",\r\n \"courierServiceId\": 356,\r\n \"courierServiceName\": \"UPS Mail Innovation Standard LightWeight\",\r\n \"trackingNumber\": \"EK510223258GB\",\r\n \"courierCode\": \"UPSN\"\r\n },\r\n \"despatchedDate\": \"2020-10-22T00:00:00.000Z\",\r\n \"productSummaries\": [\r\n {\r\n \"quantity\": 1,\r\n \"requestedProductBarcode\": \"Product1\",\r\n \"serialNumbers\": [\r\n \"TEST99998\",\r\n \"TEST99999\"\r\n ],\r\n \"batchExpiryInformation\": [\r\n {\r\n \"quantity\": 1,\r\n \"batchNumber\": \"BATCH-1\",\r\n \"expiryDate\": \"2026-01-01T00:00:00.000Z\"\r\n }\r\n ],\r\n \"identifiers\": [\r\n {\r\n \"type\": \"SERIAL_NUMBER\",\r\n \"values\": [\r\n \"TEST99998\",\r\n \"TEST99999\"\r\n ]\r\n },\r\n {\r\n \"type\": \"IMEI\",\r\n \"values\": [\r\n \"351234567890123\",\r\n \"351234567890124\"\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"shipmentNumber\": 23124013,\r\n \"shipmentState\": \"DISPATCHED\",\r\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=283183247102380\",\r\n \"warehouseDetails\": {\r\n \"warehouse\": \"Omega\",\r\n \"warehouseId\": 31\r\n }\r\n }\r\n ],\r\n \"cancellation\": [\r\n {\r\n \"productCode\": \"Product1\",\r\n \"quantity\": 1,\r\n \"reason\": \"Damaged\"\r\n }\r\n ]\r\n}"},{"id":"ce305c89-fc93-4f2d-9b6b-36d90d5e563b","name":"Success 200 - No identifiers and cancellations","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v2/order/status?client-order-reference=ClientOrder00001","host":[""],"path":["v2","order","status"],"query":[{"key":"client-order-reference","value":"ClientOrder00001","description":"The client's order reference. Either this or platform-order-reference is required. \nE.g. ClientOrder00001"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"platformOrderReference\": \"AB_1234\",\r\n \"clientOrderReference\": \"ClientOrder00001\",\r\n \"productSummaries\": [\r\n {\r\n \"allocatedProductBarcode\": \"BARCODE\",\r\n \"allocatedProductCode\": \"Product1\",\r\n \"fulfilmentStateQuantities\": {\r\n \"PROCESSING\": 1,\r\n \"DISPATCHED\": 1\r\n },\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"requestedProductCode\": \"Product1\"\r\n }\r\n ],\r\n \"shipments\": [\r\n {\r\n \"courierDetails\": {\r\n \"courierProviderId\": 150,\r\n \"courierProviderName\": \"UPS\",\r\n \"courierServiceId\": 356,\r\n \"courierServiceName\": \"UPS Mail Innovation Standard LightWeight\",\r\n \"trackingNumber\": \"EK510223258GB\",\r\n \"courierCode\": \"UPSN\"\r\n },\r\n \"despatchedDate\": \"2020-10-22T00:00:00.000Z\",\r\n \"productSummaries\": [\r\n {\r\n \"quantity\": 1,\r\n \"requestedProductBarcode\": \"Product1\",\r\n \"batchExpiryInformation\": [\r\n {\r\n \"quantity\": 1,\r\n \"batchNumber\": \"BATCH-1\",\r\n \"expiryDate\": \"2026-01-01T00:00:00.000Z\"\r\n }\r\n ],\r\n \"identifiers\": []\r\n }\r\n ],\r\n \"shipmentNumber\": 23124013,\r\n \"shipmentState\": \"DISPATCHED\",\r\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=283183247102380\",\r\n \"warehouseDetails\": {\r\n \"warehouse\": \"Omega\",\r\n \"warehouseId\": 31\r\n }\r\n }\r\n ],\r\n \"cancellation\": []\r\n}"},{"id":"02865361-13dd-4c04-8bca-029f594c945e","name":"Success 200 Split Shipments - 1 Shipment Dispatched and 1 Shipment Cancelled","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v2/order/status?client-order-reference=ClientOrder00001","host":[""],"path":["v2","order","status"],"query":[{"key":"client-order-reference","value":"ClientOrder00001"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"platformOrderReference\": \"AB_1234\",\r\n \"clientOrderReference\": \"ClientOrder00001\",\r\n \"productSummaries\": [\r\n {\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"requestedProductCode\": \"Product1\",\r\n \"allocatedProductBarcode\": \"BARCODE\",\r\n \"allocatedProductCode\": \"Product1\",\r\n \"fulfilmentStateQuantities\": {\r\n \"DISPATCHED\": 1\r\n }\r\n },\r\n {\r\n \"requestedProductCode\": \"Product2\",\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"fulfilmentStateQuantities\": {\r\n \"CANCELLED\": 1\r\n }\r\n }\r\n ],\r\n \"shipments\": [\r\n {\r\n \"courierDetails\": {\r\n \"courierProviderId\": 150,\r\n \"courierProviderName\": \"UPS\",\r\n \"courierServiceId\": 356,\r\n \"courierServiceName\": \"UPS Mail Innovation Standard LightWeight\",\r\n \"trackingNumber\": \"EK510223258GB\",\r\n \"courierCode\": \"UPSN\"\r\n },\r\n \"despatchedDate\": \"2020-10-22T00:00:00.000Z\",\r\n \"productSummaries\": [\r\n {\r\n \"quantity\": 1,\r\n \"requestedProductBarcode\": \"Product1\",\r\n \"serialNumbers\": [\r\n \"TEST99998\",\r\n \"TEST99999\"\r\n ],\r\n \"identifiers\": [\r\n {\r\n \"type\": \"SERIAL_NUMBER\",\r\n \"values\": [\r\n \"TEST99998\",\r\n \"TEST99999\"\r\n ]\r\n },\r\n {\r\n \"type\": \"IMEI\",\r\n \"values\": [\r\n \"351234567890123\",\r\n \"351234567890124\"\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"shipmentNumber\": 23124013,\r\n \"shipmentState\": \"DISPATCHED\",\r\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=283183247102380\",\r\n \"warehouseDetails\": {\r\n \"warehouse\": \"Omega\",\r\n \"warehouseId\": 31\r\n }\r\n }\r\n ],\r\n \"cancellation\": [\r\n {\r\n \"productCode\": \"Product2\",\r\n \"quantity\": 1,\r\n \"reason\": \"Damaged\"\r\n }\r\n ]\r\n }"},{"id":"645316de-54ee-4b1e-89cb-9a7dc9ab8dcb","name":"Failure 400 No Client or Platform Order Number in Request Param","originalRequest":{"method":"GET","header":[],"url":"/v2/order/status"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"Request parameters failed validation."},{"id":"8930ed50-9bf4-4cb4-9ac0-f8c2d0cd54a2","name":"Failure 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v2/order/status?client-order-reference=ClientOrder11223345","host":[""],"path":["v2","order","status"],"query":[{"key":"client-order-reference","value":"ClientOrder11223345"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"Failed to find order."},{"id":"d59be5bc-4797-42f4-a521-6a3dc42f11fe","name":"Failure 410","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v2/order/status?client-order-reference=ClientOrder11223345","host":[""],"path":["v2","order","status"],"query":[{"key":"client-order-reference","value":"ClientOrder11223345"}]}},"status":"Gone","code":410,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"Order has been archived."},{"id":"fb39d8d1-c4bc-457e-8e39-5187a73b380a","name":"Failure 500","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v2/order/status?client-order-reference=ClientOrder11223345","host":[""],"path":["v2","order","status"],"query":[{"key":"client-order-reference","value":"ClientOrder11223345"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"811d9332-240d-4642-86ea-e134507e0cf9"},{"name":"Get order status v3","id":"7511d338-b14a-40d4-9dae-55d0888abd94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/v3/order/status?client-order-reference=ClientOrder00001&platform-order-reference=AB_1234","description":"

This endpoint is used to get order status details for the given THG Ingenuity order number or the client order number.

Request

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`client-order-reference`	string	The client's order reference. Either this or `platform-order-reference` is required. E.g. `ClientOrder00001`
`platform-order-reference`	string	The THG Ingenuity internal order reference. Either this or `client-order-reference` is required. E.g. `AB_1234`

Response

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`platformOrderReference`	string	Y	The THG Ingenuity internal order reference.
`clientOrderReference`	string	Y	Order reference from client which is sent to THG during order creation
`productSummaries`	Array of ProductSummary	Y	Summary of the requested products including status of the product quantities.
`shipments`	Array of Shipment	Y	Shipment information.
`cancellation`	Array of Cancellation	N	This section is available if any of the order items are cancelled. This will detail out the item and its quantity cancelled along with reason to cancel. If there are no cancellations then this will be an empty array.

ProductSummary

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`requestedProductBarcode`	string	Y	Barcode of the requested product.
`requestedProductCode`	string	Y	THG product id of the requested product.
`allocatedProductBarcode`	string	N	Barcode of the allocated product, if applicable.
`allocatedProductCode`	string	N	THG product id of the allocated product, if applicable.
`fulfilmentStateQuantities`	Map [ state string : quantity integer ]	Y	Statuses `PROCESSING`, `DISPATCHED`, `CANCELLED,` `ALLOCATED_TO_WAREHOUSE` Additional statuses, available only if requested: `AWAITING_DISPATCH` These could be any combination of above statuses, user should ignore any unwanted statuses that appear in this section.

Shipment

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`shipmentNumber`	integer	Y	Shipment number.
`shipmentState`	string	Y	Current state of the shipment.
`despatchedDate`	string	Y	Date when shipment was dispatched. Format: yyyy-MM-ddTHH:mm:ssZ.
`courierDetails`	CourierDetails	N	Information about the shipment's courier.
`productSummaries`	Array of ShipmentProductSummary	Y	Summary of product information within a shipment.
`warehouseDetails`	WarehouseDetail	N	Warehouse information for the shipment.

CourierDetails

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`courierProviderId`	integer	Y	THG Ingenuity courier identifier.
`courierProviderName`	string	Y	Name of courier provider.
`courierServiceId`	integer	Y	THG Ingenuity courier service identifier.
`courierServiceName`	string	Y	Name of courier service.
`trackingNumber`	string	Y	Shipment courier tracking number.
`trackingUrl`	string	Y	Shipment tracking URL.

ShipmentProductSummary

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`requestedProductCode`	string	Y	THG product id of the requested product.
`requestedProductBarcode`	string	Y	Barcode of the requested product.
`quantity`	integer	Y	Quantity of the requested product in the shipment.
`batchExpiryInformation`	Array of BatchExpiryInformation	N	Array of batch and expiry information for the given product, where provided.
`identifiers`	Array of Identifiers	N	Array of all identifiers associated with the product, where provided. If no values are avaiable for any of the identifiers then this will be an empty array.

Identifiers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`type`	string	Y	Type of identifier, eg. `SERIAL_NUMBER`, `IMEI`
`values`	Array of string	Y	List of values associated with identifier.

BatchExpiryInformation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`quantity`	integer	Y	Quantity of product associated with batch number and expiry date.
`batchNumber`	string	Y	Batch/Lot number of the product.
`expiryDate`	string	Y	Expiry date of the product. Format: yyyy-MM-ddTHH:mm:ssZ

WarehouseDetail

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`warehouse`	string	Y	Warehouse name.
`warehouseId`	integer	Y	THG Ingenuity warehouse ID.

Cancellation

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`productCode`	string	Y	THG product id of the cancelled product
`quantity`	integer	Y	Quantity of the cancelled product
`reason`	string	Y	Reason to cancel the product. Reasons supported: `\"DAMAGED\"`, `\"CUSTOMER\"`, `\"CLIENT\"`, `\"LOST\"`

Response Body JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"platformOrderReference\": {\n      \"type\": \"string\"\n    },\n    \"clientOrderReference\": {\n      \"type\": \"string\"\n    },\n    \"productSummaries\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"allocatedProductBarcode\": {\n              \"type\": \"string\"\n            },\n            \"allocatedProductCode\": {\n              \"type\": \"string\"\n            },\n            \"fulfilmentStateQuantities\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"any-key\": {\n                  \"type\": \"integer\"\n                }\n              }\n            },\n            \"requestedProductBarcode\": {\n              \"type\": \"string\"\n            },\n            \"requestedProductCode\": {\n              \"type\": \"string\"\n            }\n          },\n          \"required\": [\n            \"fulfilmentStateQuantities\",\n            \"requestedProductBarcode\",\n            \"requestedProductCode\"\n          ]\n        }\n      ]\n    },\n    \"shipments\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"courierDetails\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"courierProviderId\": {\n                  \"type\": \"integer\"\n                },\n                \"courierProviderName\": {\n                  \"type\": \"string\"\n                },\n                \"courierServiceId\": {\n                  \"type\": \"integer\"\n                },\n                \"courierServiceName\": {\n                  \"type\": \"string\"\n                },\n                \"trackingNumber\": {\n                  \"type\": \"string\"\n                },\n                \"trackingUrl\": {\n                  \"type\": \"string\"\n                }\n              },\n              \"required\": [\n                \"courierProviderId\",\n                \"courierProviderName\",\n                \"courierServiceId\",\n                \"courierServiceName\",\n                \"trackingNumber\",\n                \"trackingUrl\"\n              ]\n            },\n            \"despatchedDate\": {\n              \"type\": \"string\"\n            },\n            \"productSummaries\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"quantity\": {\n                      \"type\": \"integer\"\n                    },\n                    \"requestedProductCode\": {\n                      \"type\": \"string\"\n                    },\n                    \"requestedProductBarcode\": {\n                      \"type\": \"string\"\n                    },\n                    \"batchExpiryInformation\": {\n                      \"type\": \"array\",\n                      \"items\": [\n                        {\n                          \"type\": \"object\",\n                          \"properties\": {\n                            \"quantity\": {\n                              \"type\": \"integer\"\n                            },\n                            \"batchNumber\": {\n                              \"type\": \"string\"\n                            },\n                            \"expiryDate\": {\n                              \"type\": \"string\"\n                            }\n                          },\n                          \"required\": [\n                            \"quantity\",\n                            \"batchNumber\",\n                            \"expiryDate\"\n                          ]\n                        }\n                      ]\n                    },\n                    \"identifiers\": {\n                      \"type\": \"array\",\n                      \"items\": [\n                        {\n                          \"type\": \"object\",\n                          \"properties\": {\n                            \"type\": {\n                              \"type\": \"string\"\n                            },\n                            \"values\": {\n                              \"type\": \"array\",\n                              \"items\": [\n                                {\n                                  \"type\": \"string\"\n                                }\n                              ]\n                            }\n                          },\n                          \"required\": [\n                            \"type\",\n                            \"values\",\n                          ]\n                        }\n                      ]\n                    } \n                  },\n                  \"required\": [\n                    \"quantity\",\n                    \"requestedProductCode\",\n                    \"requestedProductBarcode\"\n                  ]\n                }\n              ]\n            },\n            \"shipmentNumber\": {\n              \"type\": \"integer\"\n            },\n            \"shipmentState\": {\n              \"type\": \"string\"\n            },\n            \"warehouseDetails\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"warehouse\": {\n                  \"type\": \"string\"\n                },\n                \"warehouseId\": {\n                  \"type\": \"integer\"\n                }\n              },\n              \"required\": [\n                \"warehouse\",\n                \"warehouseId\"\n              ]\n            }\n          },\n          \"required\": [\n            \"courierDetails\",\n            \"despatchedDate\",\n            \"productSummaries\",\n            \"shipmentNumber\",\n            \"shipmentState\"\n          ]\n        }\n      ]\n    },\n     \"cancellation\": {\n      \"type\": \"array\",\n        \"items\": [\n          {\n            \"type\": \"object\",\n              \"properties\": {\n                \"productCode\": {\n                  \"type\": \"string\"\n                },\n                \"quantity\": {\n                  \"type\": \"integer\"\n                },\n                \"reason\": {\n                  \"type\": \"string\"\n                },\n              },\n              \"required\": [\n                \"productCode\",\n                \"quantity\",\n                \"reason\"\n              ]\n          }\n        ]  \n     }\n  },\n  \"required\": [\n    \"platformOrderReference\",\n    \"productSummaries\",\n    \"shipments\"\n  ]\n}\n\n

\n","urlObject":{"path":["v3","order","status"],"host":[""],"query":[{"description":{"content":"

The client's order reference. Either this or platform-order-reference is required.
E.g. ClientOrder00001

\n","type":"text/plain"},"key":"client-order-reference","value":"ClientOrder00001"},{"description":{"content":"

The THG Ingenuity internal order reference. Either this or client-order-reference is required.
E.g. AB_1234

\n","type":"text/plain"},"key":"platform-order-reference","value":"AB_1234"}],"variable":[]}},"response":[{"id":"8d051f7c-f6dc-4004-8d20-8bfc6bb28370","name":"Success 200","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v3/order/status?client-order-reference=ClientOrder00001","host":[""],"path":["v3","order","status"],"query":[{"key":"client-order-reference","value":"ClientOrder00001","description":"The client's order reference. Either this or platform-order-reference is required. \nE.g. ClientOrder00001"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"platformOrderReference\": \"AB_1234\",\r\n \"clientOrderReference\": \"ClientOrder00001\",\r\n \"productSummaries\": [\r\n {\r\n \"allocatedProductBarcode\": \"BARCODE\",\r\n \"allocatedProductCode\": \"Product1\",\r\n \"fulfilmentStateQuantities\": {\r\n \"PROCESSING\": 1,\r\n \"CANCELLED\": 1,\r\n \"DISPATCHED\": 1,\r\n \"ALLOCATED_TO_WAREHOUSE\":1\r\n },\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"requestedProductCode\": \"Product1\"\r\n },\r\n {\r\n \"allocatedProductBarcode\": \"BARCODE2\",\r\n \"allocatedProductCode\": \"Product2\",\r\n \"fulfilmentStateQuantities\": {\r\n \"ALLOCATED_TO_WAREHOUSE\":1, \r\n \"AWAITING_DISPATCH\":1\r\n },\r\n \"requestedProductBarcode\": \"BARCODE2\",\r\n \"requestedProductCode\": \"Product2\"\r\n }\r\n ],\r\n \"shipments\": [\r\n {\r\n \"courierDetails\": {\r\n \"courierProviderId\": 150,\r\n \"courierProviderName\": \"UPS\",\r\n \"courierServiceId\": 356,\r\n \"courierServiceName\": \"UPS Mail Innovation Standard LightWeight\",\r\n \"trackingNumber\": \"EK510223258GB\",\r\n \"trackingUrl\": \"https://www.ups.com/track?loc=en_US&tracknum=EK510223258GB\"\r\n },\r\n \"despatchedDate\": \"2020-10-22T15:10:12.000Z\",\r\n \"productSummaries\": [\r\n {\r\n \"quantity\": 1,\r\n \"requestedProductCode\": \"Product1\",\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"batchExpiryInformation\": [\r\n {\r\n \"quantity\": 1,\r\n \"batchNumber\": \"BATCH-1\",\r\n \"expiryDate\": \"2026-01-01T00:00:00.000Z\"\r\n }\r\n ],\r\n \"identifiers\": [\r\n {\r\n \"type\": \"SERIAL_NUMBER\",\r\n \"values\": [\r\n \"TEST99998\",\r\n \"TEST99999\"\r\n ]\r\n },\r\n {\r\n \"type\": \"IMEI\",\r\n \"values\": [\r\n \"351234567890123\",\r\n \"351234567890124\"\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"shipmentNumber\": 23124013,\r\n \"shipmentState\": \"DISPATCHED\",\r\n \"warehouseDetails\": {\r\n \"warehouse\": \"Omega\",\r\n \"warehouseId\": 31\r\n }\r\n }\r\n ],\r\n \"cancellation\": [\r\n {\r\n \"productCode\": \"Product1\",\r\n \"quantity\": 1,\r\n \"reason\": \"Damaged\"\r\n }\r\n ]\r\n}"},{"id":"ef745f6b-77cb-4574-bc05-b81b62553114","name":"Success 200 - No identifiers and cancellations","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v3/order/status?client-order-reference=ClientOrder00001","host":[""],"path":["v3","order","status"],"query":[{"key":"client-order-reference","value":"ClientOrder00001","description":"The client's order reference. Either this or platform-order-reference is required. \nE.g. ClientOrder00001"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"platformOrderReference\": \"AB_1234\",\r\n \"clientOrderReference\": \"ClientOrder00001\",\r\n \"productSummaries\": [\r\n {\r\n \"allocatedProductBarcode\": \"BARCODE\",\r\n \"allocatedProductCode\": \"Product1\",\r\n \"fulfilmentStateQuantities\": {\r\n \"PROCESSING\": 1,\r\n \"DISPATCHED\": 1,\r\n \"ALLOCATED_TO_WAREHOUSE\":1\r\n },\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"requestedProductCode\": \"Product1\"\r\n }\r\n ],\r\n \"shipments\": [\r\n {\r\n \"courierDetails\": {\r\n \"courierProviderId\": 150,\r\n \"courierProviderName\": \"UPS\",\r\n \"courierServiceId\": 356,\r\n \"courierServiceName\": \"UPS Mail Innovation Standard LightWeight\",\r\n \"trackingNumber\": \"EK510223258GB\",\r\n \"trackingUrl\": \"https://www.ups.com/track?loc=en_US&tracknum=EK510223258GB\"\r\n },\r\n \"despatchedDate\": \"2020-10-22T15:10:12.000Z\",\r\n \"productSummaries\": [\r\n {\r\n \"quantity\": 1,\r\n \"requestedProductCode\": \"Product1\",\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"batchExpiryInformation\": [\r\n {\r\n \"quantity\": 1,\r\n \"batchNumber\": \"BATCH-1\",\r\n \"expiryDate\": \"2026-01-01T00:00:00.000Z\"\r\n }\r\n ],\r\n \"identifiers\": []\r\n }\r\n ],\r\n \"shipmentNumber\": 23124013,\r\n \"shipmentState\": \"DISPATCHED\",\r\n \"warehouseDetails\": {\r\n \"warehouse\": \"Omega\",\r\n \"warehouseId\": 31\r\n }\r\n }\r\n ],\r\n \"cancellation\": []\r\n}"},{"id":"32dc04d5-3fbf-4e78-99f2-36aac3747556","name":"Success 200 Split Shipments - 1 Shipment Dispatched and 1 Shipment Cancelled","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v3/order/status?client-order-reference=ClientOrder00001","host":[""],"path":["v3","order","status"],"query":[{"key":"client-order-reference","value":"ClientOrder00001"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\r\n \"platformOrderReference\": \"AB_1234\",\r\n \"clientOrderReference\": \"ClientOrder00001\",\r\n \"productSummaries\": [\r\n {\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"requestedProductCode\": \"Product1\",\r\n \"allocatedProductBarcode\": \"BARCODE\",\r\n \"allocatedProductCode\": \"Product1\",\r\n \"fulfilmentStateQuantities\": {\r\n \"DISPATCHED\": 1,\r\n \"ALLOCATED_TO_WAREHOUSE\":1\r\n }\r\n },\r\n {\r\n \"requestedProductCode\": \"Product2\",\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"fulfilmentStateQuantities\": {\r\n \"CANCELLED\": 1\r\n }\r\n }\r\n ],\r\n \"shipments\": [\r\n {\r\n \"courierDetails\": {\r\n \"courierProviderId\": 150,\r\n \"courierProviderName\": \"UPS\",\r\n \"courierServiceId\": 356,\r\n \"courierServiceName\": \"UPS Mail Innovation Standard LightWeight\",\r\n \"trackingNumber\": \"EK510223258GB\",\r\n \"trackingUrl\": \"https://www.ups.com/track?loc=en_US&tracknum=EK510223258GB\"\r\n },\r\n \"despatchedDate\": \"2020-10-22T15:10:12.000Z\",\r\n \"productSummaries\": [\r\n {\r\n \"quantity\": 1,\r\n \"requestedProductCode\": \"Product1\",\r\n \"requestedProductBarcode\": \"BARCODE\",\r\n \"identifiers\": [\r\n {\r\n \"type\": \"SERIAL_NUMBER\",\r\n \"values\": [\r\n \"TEST99998\",\r\n \"TEST99999\"\r\n ]\r\n },\r\n {\r\n \"type\": \"IMEI\",\r\n \"values\": [\r\n \"351234567890123\",\r\n \"351234567890124\"\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"shipmentNumber\": 23124013,\r\n \"shipmentState\": \"DISPATCHED\",\r\n \"warehouseDetails\": {\r\n \"warehouse\": \"Omega\",\r\n \"warehouseId\": 31\r\n }\r\n }\r\n ],\r\n \"cancellation\": [\r\n {\r\n \"productCode\": \"Product2\",\r\n \"quantity\": 1,\r\n \"reason\": \"Damaged\"\r\n }\r\n ]\r\n }"},{"id":"a99fb879-0e72-418e-971e-05ca75a97485","name":"Failure 400 No Client or Platform Order Number in Request Param","originalRequest":{"method":"GET","header":[],"url":"/v3/order/status"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"Request parameters failed validation."},{"id":"2bb24823-ffcb-44f8-ad87-1501352b94c5","name":"Failure 404","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v3/order/status?client-order-reference=ClientOrder11223345","host":[""],"path":["v3","order","status"],"query":[{"key":"client-order-reference","value":"ClientOrder11223345"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"Failed to find order."},{"id":"64153566-d07a-4efc-b61e-790497c9bb1c","name":"Failure 410","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v3/order/status?client-order-reference=ClientOrder11223345","host":[""],"path":["v3","order","status"],"query":[{"key":"client-order-reference","value":"ClientOrder11223345"}]}},"status":"Gone","code":410,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"Order has been archived."},{"id":"bf5d32cf-974e-4d8f-8102-9c6713198fe1","name":"Failure 500","originalRequest":{"method":"GET","header":[],"url":{"raw":"/v3/order/status?client-order-reference=ClientOrder11223345","host":[""],"path":["v3","order","status"],"query":[{"key":"client-order-reference","value":"ClientOrder11223345"}]}},"status":"Internal Server Error","code":500,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":""}],"_postman_id":"7511d338-b14a-40d4-9dae-55d0888abd94"}],"id":"5510d46d-a0a2-4171-9816-8d920c145f23","_postman_id":"5510d46d-a0a2-4171-9816-8d920c145f23","description":""},{"name":"Goods In","item":[{"name":"Warehouse Availability","item":[{"name":"Delivery Booking Availability","id":"c045fc15-dcdd-45fa-84e0-78031e841145","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"/delivery-booking/{warehouseId}/availability?boxes=Integer&deliveryDate=LocalDate&pallets=Integer&units=Integer","description":"

Delivery Booking Availability

GET /delivery-booking/{warehouseId}/availability

This endpoint retrieves the availability details for a specified warehouse. Checking warehouse availability prior to creating a pre-advice significantly improves the
likelihood of successful acceptance by ensuring that the selected date and product quantities can be accommodated.

Path Variables

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Mandatory	Description
warehouseId	String	Y	Warehouse identifier

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Mandatory	Description	Constraints
boxes	Integer	Y	Number of boxes	Must be >= 0
deliveryDate	String	Y	Delivery date	ISO format: YYYY-MM-DD
pallets	Integer	Y	Number of pallets	Must be >= 0
units	Integer	Y	Number of units	Must be >= 0 if provided

Response

Response Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
`deliveryBookingTimeDtos`	List of DeliveryBookingTimeDto	List of available delivery booking time slots

DeliveryBookingTimeDto

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field Name	Type	Description
bookingDate	String (YYYY-MM-DD)	Date of the booking slot
deliveryHour	String	Delivery hour/time slot
reservedBoxes	Integer (nullable)	Number of boxes already reserved
reservedPallets	Integer (nullable)	Number of pallets already reserved

JSON Schema

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"deliveryBookingTimeDtos\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"bookingDate\": { \"type\": \"string\", \"format\": \"date\" },\n          \"deliveryHour\": { \"type\": \"string\" },\n          \"reservedBoxes\": { \"type\": [\"integer\", \"null\"] },\n          \"reservedPallets\": { \"type\": [\"integer\", \"null\"] }\n        }\n      }\n    }\n  }\n}\n\n

No Available Slots

If there are no delivery slots available for the requested date, the response will return an empty list:

{\n  \"deliveryBookingTimeDtos\": []\n}\n\n

Interpretation:
\n
- An empty list indicates that no delivery time slots can accommodate the requested number of boxes, pallets, and units for the selected date.
  \n
- The client should either select a different delivery date or adjust the quantities before attempting to create a pre-advice.
  \n
\n

\n","urlObject":{"path":["delivery-booking","{warehouseId}","availability"],"host":[""],"query":[{"key":"boxes","value":"Integer"},{"key":"deliveryDate","value":"LocalDate"},{"key":"pallets","value":"Integer"},{"key":"units","value":"Integer"}],"variable":[]}},"response":[{"id":"25e9fb21-9250-4714-92d6-397063bdbcc3","name":"Success - delivery booking availibility","originalRequest":{"method":"GET","header":[],"url":{"raw":"/delivery-booking/89/availability?businessDivisionId=13&boxes=10&deliveryDate=2025-12-15&pallets=1&units=50","host":[""],"path":["delivery-booking","89","availability"],"query":[{"key":"businessDivisionId","value":"13"},{"key":"boxes","value":"10"},{"key":"deliveryDate","value":"2025-12-15"},{"key":"pallets","value":"1"},{"key":"units","value":"50"},{"key":"","value":"","disabled":true}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":"{\n \"deliveryBookingTimeDtos\": [\n {\n \"bookingDate\": \"2025-12-15\",\n \"deliveryHour\": \"07:00\",\n \"reservedBoxes\": null,\n \"reservedPallets\": null\n },\n {\n \"bookingDate\": \"2025-12-15\",\n \"deliveryHour\": \"08:00\",\n \"reservedBoxes\": null,\n \"reservedPallets\": null\n },\n {\n \"bookingDate\": \"2025-12-15\",\n \"deliveryHour\": \"09:00\",\n \"reservedBoxes\": null,\n \"reservedPallets\": null\n },\n {\n \"bookingDate\": \"2025-12-15\",\n \"deliveryHour\": \"10:00\",\n \"reservedBoxes\": null,\n \"reservedPallets\": null\n },\n {\n \"bookingDate\": \"2025-12-15\",\n \"deliveryHour\": \"11:00\",\n \"reservedBoxes\": null,\n \"reservedPallets\": null\n },\n {\n \"bookingDate\": \"2025-12-15\",\n \"deliveryHour\": \"12:00\",\n \"reservedBoxes\": null,\n \"reservedPallets\": null\n },\n {\n \"bookingDate\": \"2025-12-15\",\n \"deliveryHour\": \"13:00\",\n \"reservedBoxes\": null,\n \"reservedPallets\": null\n },\n {\n \"bookingDate\": \"2025-12-15\",\n \"deliveryHour\": \"14:00\",\n \"reservedBoxes\": null,\n \"reservedPallets\": null\n },\n {\n \"bookingDate\": \"2025-12-15\",\n \"deliveryHour\": \"15:00\",\n \"reservedBoxes\": null,\n \"reservedPallets\": null\n }\n ]\n}"},{"id":"c8e32fd1-10c6-47c2-99b0-8516598cda93","name":"Unavailable Reponse","originalRequest":{"method":"GET","header":[],"url":{"raw":"/delivery-booking/89/availability?businessDivisionId=13&boxes=10&deliveryDate=2025-12-15&pallets=1&units=500000","host":[""],"path":["delivery-booking","89","availability"],"query":[{"key":"businessDivisionId","value":"13"},{"key":"boxes","value":"10"},{"key":"deliveryDate","value":"2025-12-15"},{"key":"pallets","value":"1"},{"key":"units","value":"500000"}]}},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{\n \"deliveryBookingTimeDtos\": []\n}"}],"_postman_id":"c045fc15-dcdd-45fa-84e0-78031e841145"}],"id":"de1cba88-51d2-4e96-b107-d59ad3b74c62","description":"

Delivery Booking Availability

Before creating a pre-advice for an inbound delivery, it is important to check warehouse delivery slot availability. This endpoint allows you to determine which delivery dates and time slots can accommodate the requested products, boxes, pallets, and units. By verifying availability beforehand, you increase the likelihood that your pre-advice will be successfully accepted.

Checking Availability

To check delivery availability:

Provide the required number of boxes, pallets, units.
\n
Specify the desired delivery date.
\n

The endpoint will return all available delivery time slots for the specified date, including the number of boxes and pallets already reserved in each slot.

This allows you to make informed decisions when creating pre-advice and ensures smooth warehouse operations.

\n","_postman_id":"de1cba88-51d2-4e96-b107-d59ad3b74c62"},{"name":"Pre-Advice","item":[{"name":"Create Pre-Advice","id":"f7f6f090-9ec2-483f-9471-83d82efde1be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n \"clientReference\": \"string\",\n \"warehouseId\": 0,\n \"asnType\": \"enum\",\n \"delivery\": {\n \"estimatedNumberOfLogisticsUnits\": 0,\n \"logisticsUnitType\": \"enum\",\n \"requestedDeliveryDate\": \"2025-03-24T09:41:23.989Z\",\n \"deliveryType\": \"enum\"\n },\n \"products\": [\n {\n \"clientReference\": \"string\",\n \"productId\": \"string\",\n \"advisedQuantity\": 0,\n \"advisedCondition\": \"enum\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/goods-in/pre-advice","description":"

This endpoint is used to create a pre-advice for deliveries, allowing clients to notify the system about incoming deliveries and their expected details.

Request

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`clientReference`	string	N	Client's reference to the pre-advice.
`warehouseId`	integer	Y	The ID of the warehouse where the goods will be arriving.
`asnType`	ClientAsnType	N	Type of ASN to generate. Defaults to `DEFAULT` if not provided.
`delivery`	Delivery	Y	Details of this pre-advice delivery.
`products`	Array of PreAdviceItem	Y	List of items included in the pre-advice, must contain at least one item.

Delivery

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`estimatedNumberOfLogisticsUnits`	integer	Y	Estimated number of logistics units in the delivery, must be a positive non-zero value.
`logisticsUnitType`	string	Y	Type of logistics unit being delivered (e.g., `PALLET`, `CARTON`).
`requestedDeliveryDate`	string (DateTime)	Y	Date and time when the delivery is requested, in ISO 8601 Zulu format. Must be in the future.
`deliveryType`	string	Y	Mode of delivery (e.g., `FREIGHT`, `COURIER`).

PreAdviceItem

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`clientReference`	string	N	Client's reference to this pre-advice item.
`productId`	string	Y	Reference to the product.
`advisedQuantity`	integer	Y	The quantity of this item, must be at least 1.
`advisedCondition`	string	N	The condition of the inventory item. Defaults to `GOOD`.

ClientAsnType

Possible values:

DEFAULT
\n
QC
\n
TRANSFER
\n
KITTING
\n
B2B
\n

Warehouse ID and Client ASN Type Relationship

The system categorizes warehouses into two types:

1. B2B Warehouses

Warehouse IDs: 55, 59, 88, 114, 115, 130, 133

Only supports: asnType = B2B

2. B2C Warehouses

All other warehouse IDs

Supports: DEFAULT, QC, TRANSFER, KITTING
\n
Does NOT support: B2B\n
\n

Validation Rules

The system enforces strict validation between asnType and warehouseId.

Rule 1: B2B ASN Type Validation

If asnType = B2B, the warehouseId must be a B2B warehouse
(55, 59, 88, 114, 115, 130, 133)

Rule 2: Non-B2B ASN Type Validation

If asnType is DEFAULT, QC, TRANSFER, or KITTING,
the warehouseId must NOT be a B2B warehouse

Rule 3: Default Behavior

If asnType is not provided in the request, it defaults to DEFAULT
\n
The default validation still applies based on the warehouseId
\n

JSON Schema

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"clientReference\": {\n      \"type\": \"string\"\n    },\n    \"warehouseId\": {\n      \"type\": \"integer\"\n    },\n    \"asnType\": {\n      \"type\": \"string\",\n      \"enum\": [\"DEFAULT\", \"QC\", \"TRANSFER\", \"KITTING\", \"B2B\"],\n      \"default\": \"DEFAULT\"\n    },\n    \"delivery\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"estimatedNumberOfLogisticsUnits\": {\n          \"type\": \"integer\"\n        },\n        \"logisticsUnitType\": {\n          \"type\": \"string\",\n          \"enum\": [\"PALLET\", \"CARTON\"]\n        },\n        \"requestedDeliveryDate\": {\n          \"type\": \"string\",\n          \"format\": \"date-time\"\n        },\n        \"deliveryType\": {\n          \"type\": \"string\",\n          \"enum\": [\"FREIGHT\", \"COURIER\"]\n        }\n      },\n      \"required\": [\n        \"estimatedNumberOfLogisticsUnits\",\n        \"logisticsUnitType\",\n        \"requestedDeliveryDate\",\n        \"deliveryType\"\n      ]\n    },\n    \"products\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"clientReference\": {\n            \"type\": \"string\"\n          },\n          \"productId\": {\n            \"type\": \"string\"\n          },\n          \"advisedQuantity\": {\n            \"type\": \"integer\"\n          },\n          \"advisedCondition\": {\n            \"type\": \"string\",\n            \"enum\": [\"GOOD\", \"DAMAGED\", \"EXPIRED\"]\n          }\n        },\n        \"required\": [\n          \"productId\",\n          \"advisedQuantity\"\n        ]\n      }\n    }\n  },\n  \"required\": [\n    \"warehouseId\",\n    \"delivery\",\n    \"products\"\n  ]\n}\n\n

Response

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`timestamp`	string	Date and time when the response was generated, in ISO 8601 Zulu format.
`id`	string	A unique reference for the pre-advice.
`clientReference`	string	Client's reference to the pre-advice.

JSON Schema

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"timestamp\": {\n      \"type\": \"string\",\n      \"format\": \"date-time\"\n    },\n    \"id\": {\n      \"type\": \"string\"\n    },\n    \"clientReference\": {\n      \"type\": \"string\"\n    }\n  },\n  \"required\": [\n    \"timestamp\",\n    \"id\",\n    \"clientReference\"\n  ]\n}\n\n

\n","urlObject":{"path":["goods-in","pre-advice"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"8d453aa0-a53f-4342-8d42-1ea84b43bb4e","name":"Create Pre-Advice (Success)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientReference\": \"REF-98765\",\n \"warehouseId\": 90,\n \"asnType\": \"TRANSFER\",\n \"delivery\": {\n \"estimatedNumberOfLogisticsUnits\": 10,\n \"logisticsUnitType\": \"PALLET\",\n \"requestedDeliveryDate\": \"2025-03-21T10:14:56.123Z\",\n \"deliveryType\": \"COURIER\"\n },\n \"products\": [\n {\n \"clientReference\": \"consumer123\",\n \"productId\": \"12345678\",\n \"advisedQuantity\": 2,\n \"advisedCondition\": \"GOOD\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/goods-in/pre-advice"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-03-24T10:54:20.343+00:00\",\n \"id\": \"f798c408-260d-467c-82f4-5fc6f2944ef4\",\n \"clientReference\": \"REF-98765\"\n}"},{"id":"a9b2db83-f1a3-473b-8140-dfddd2bb7f09","name":"Unsuccessful Request","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n \"clientReference\": \"REF-98765\",\n \"warehouseId\": 90,\n \"asnType\": \"B2B\",\n \"delivery\": {\n \"estimatedNumberOfLogisticsUnits\": 10,\n \"logisticsUnitType\": \"PALLET\",\n \"requestedDeliveryDate\": \"2025-03-21T10:14:56.123Z\",\n \"deliveryType\": \"COURIER\"\n },\n \"products\": [\n {\n \"clientReference\": \"consumer123\",\n \"productId\": \"12345678\",\n \"advisedQuantity\": 2,\n \"advisedCondition\": \"GOOD\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/goods-in/pre-advice"},"status":"Unprocessable Content","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2026-01-07T10:19:48.900727802\",\n \"status\": 422,\n \"error\": \"Unprocessable Entity\",\n \"message\": \"Invalid JSON payload, please refer to the following message: JSON parse error: Cannot construct instance of `com.thg.fulfil.gateway.goodsin.preadvice.data.dto.client.ClientPreAdviceDto`, problem: B2B is not supported by warehouse id: 90\",\n \"path\": \"/goods-in/pre-advice\"\n}"}],"_postman_id":"f7f6f090-9ec2-483f-9471-83d82efde1be"},{"name":"Get Pre-Advice Approval","id":"599f0941-9de3-43af-b00b-87977cb89e5c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/goods-in/pre-advice/{{pre_advice}}/pre-advice-approval","description":"

This endpoint is used to get the approval or rejection status of a pre-advice delivery request.

Request

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`pre_advice`	string	The unique refence for the pre-advice delivery from the create pre-advice response.

Response

Response Body Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`clientReference`	string	Client's reference to the pre-advice.
`deliveryReference`	string	The reference identifier to be used on the ASN.
`expectedDeliveryDate`	string	The expected arrival date of the delivery in ISO 8601 Zulu format.
`preAdviceReasons`	Array of PreAdviceReason	List of reasons explaining why the pre-advice was rejected.
`productReasons`	Array of PreAdviceItemReason	List of reasons explaining why specific pre-advice items were rejected.

PreAdviceReason

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`message`	string	The reason why the entire pre-advice was rejected, (e.g. WAREHOUSE_UNAVAILABLE).

PreAdviceItemReason

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`message`	string	The reason why the pre-advice item was rejected, (e.g. UNKNOWN_PRODUCT, UNAPPROVED_PRODUCT, MULTIPLE_PRODUCT_MAPPING, MISMATCHED_PRODUCT_MAPPING).
`clientReference`	string	Client's reference of the pre-advice item.
`productId`	string	Reference for the product.

JSON Schema

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"clientReference\": {\n      \"type\": \"string\"\n    },\n    \"deliveryReference\": {\n      \"type\": \"string\"\n    },\n    \"expectedDeliveryDate\": {\n      \"type\": \"string\",\n      \"format\": \"date-time\"\n    },\n    \"preAdviceReasons\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"message\": {\n            \"type\": \"string\",\n            \"enum\": [\n              \"WAREHOUSE_UNAVAILABLE\"\n            ]\n          }\n        }\n      }\n    },\n    \"productReasons\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"message\": {\n            \"type\": \"string\",\n            \"enum\": [\n              \"UNKNOWN_PRODUCT\",\n              \"UNAPPROVED_PRODUCT\"\n            ]\n          },\n          \"clientReference\": {\n            \"type\": \"string\"\n          },\n          \"productId\": {\n            \"type\": \"string\"\n          }\n        }\n      }\n    }\n  }\n}\n\n

\n","urlObject":{"path":["goods-in","pre-advice","{{pre_advice}}","pre-advice-approval"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"21085bc9-5194-4806-8dfc-9b46d0ac5207","name":"Approved","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/goods-in/pre-advice/f798c408-260d-467c-82f4-5fc6f2944ef4/pre-advice-approval"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"clientReference\": \"REF-98765\",\n \"deliveryReference\": \"DEL-45678\",\n \"expectedDeliveryDate\": \"2025-03-21T10:14:56Z\"\n}"},{"id":"f134c1b6-91f3-4fcc-bbaa-613acdfd616d","name":"Rejected - PreAdvice Reason","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/goods-in/pre-advice/f798c408-260d-467c-82f4-5fc6f2944ef4/pre-advice-approval"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"clientReference\": \"REF-98765\",\n \"preAdviceReasons\": [\n {\n \"message\": \"WAREHOUSE_BUSY\"\n }\n ],\n \"productReasons\": []\n}"},{"id":"28962cfe-0a29-47c3-ac15-f0a29d8c08d2","name":"Rejected - Product Reason","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/goods-in/pre-advice/f798c408-260d-467c-82f4-5fc6f2944ef4/pre-advice-approval"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"clientReference\": \"REF-98765\",\n \"preAdviceReasons\": [],\n \"productReasons\": [\n {\n \"message\": \"UNKNOWN_PRODUCT\",\n \"clientReference\": \"consumer123\",\n \"productId\": \"12345678\"\n }\n ]\n}"}],"_postman_id":"599f0941-9de3-43af-b00b-87977cb89e5c"},{"name":"Get Pre-Advice","id":"083321c6-3198-4ff0-b656-ecf1d2a08056","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/goods-in/pre-advice/{{pre_advice}}","description":"

This endpoint is used to get the pre-advice delivery

Request

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`pre_advice`	string	The unique identifier for the pre-advice delivery, which was received as a response after creating the pre-advice.

Response

Response Body Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`clientReference`	string	Client's reference to the pre-advice.
`warehouseId`	integer	The reference of the warehouse where the goods will be arriving.
`delivery`	Delivery	Details of the this pre-advice delivery.
`products`	Array of PreAdviceItem	List of items included in the pre-advice, must contain at least one item.

Delivery

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`estimatedNumberOfLogisticsUnits`	integer	Estimated number of logistics units in the delivery, must be a positive non-zero.
`logisticsUnitType`	string	Type of logistics unit being delivered, (e.g. `PALLET`).
`requestedDeliveryDate`	string (DateTime)	Date and time when the delivery is requested, in ISO 8601 Zulu format.
`deliveryType`	string	Mode of delivery, (e.g. `FREIGHT)`.

PreAdviceItem

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`clientReference`	string	Client's reference to this pre-advice item.
`productId`	string	Reference to the product.
`advisedQuantity`	integer	The quantity of this item.
`advisedCondition`	string	The condition of the inventory item, Defaults to `GOOD`.

JSON Schema

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"consumerReference\": {\n      \"type\": \"string\"\n    },\n    \"warehouseId\": {\n      \"type\": \"integer\"\n    },\n    \"delivery\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"estimatedNumberOfLogisticsUnits\": {\n          \"type\": \"integer\"\n        },\n        \"logisticsUnitType\": {\n          \"type\": \"string\",\n          \"enum\": [\"PALLET\", \"CARTON\"]\n        },\n        \"requestedDeliveryDate\": {\n          \"type\": \"string\",\n          \"format\": \"date-time\"\n        },\n        \"deliveryType\": {\n          \"type\": \"string\",\n          \"enum\": [\"FREIGHT\", \"COURIER\"]\n        }\n      },\n      \"required\": [\n        \"estimatedNumberOfLogisticsUnits\",\n        \"logisticsUnitType\",\n        \"requestedDeliveryDate\",\n        \"deliveryType\"\n      ]\n    },\n    \"products\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"consumerReference\": {\n            \"type\": \"string\"\n          },\n          \"productId\": {\n            \"type\": \"string\"\n          },\n          \"advisedQuantity\": {\n            \"type\": \"integer\"\n          },\n          \"advisedCondition\": {\n            \"type\": \"string\",\n            \"enum\": [\"GOOD\", \"DAMAGED\", \"EXPIRED\"]\n          }\n        },\n        \"required\": [\n          \"product\",\n          \"advisedQuantity\",\n          \"advisedCondition\"\n        ]\n      }\n    }\n  },\n  \"required\": [\n    \"warehouseId\",\n    \"delivery\",\n    \"products\"\n  ]\n}\n\n

\n","urlObject":{"path":["goods-in","pre-advice","{{pre_advice}}"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"2bd22b85-46be-4bb7-b46e-74af69793b99","name":"Get Pre-Advice (Success)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/goods-in/pre-advice/f798c408-260d-467c-82f4-5fc6f2944ef4"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"clientReference\": \"REF-98765\",\n \"warehouseId\": 90,\n \"delivery\": {\n \"estimatedNumberOfLogisticsUnits\": 10,\n \"logisticsUnitType\": \"PALLET\",\n \"requestedDeliveryDate\": \"2025-03-21T10:14:56.123Z\",\n \"deliveryType\": \"COURIER\"\n },\n \"products\": [\n {\n \"clientReference\": \"consumer123\",\n \"productId\": \"12345678\",\n \"advisedQuantity\": 2,\n \"advisedCondition\": \"GOOD\"\n }\n ]\n}"}],"_postman_id":"083321c6-3198-4ff0-b656-ecf1d2a08056"}],"id":"a2695077-9a62-432b-96a0-7164cdfeaf3c","description":"

Inbound deliveries start with a pre-advice, which lets the facility know what inventory is being delivered and schedules the delivery.

Creating a Pre-Advice

To create a pre-advice:

Ensure products have been created.
\n
Prepare a pre-advice with the desired delivery date.
\n

Once submitted, the products will be validated and an attempt to schedule a delivery will occur. Upon submission, a unique Pre-Advice ID will be generated, which can be used to query the status of the pre-advice at any time.

Pre-Advice Outcomes

APPROVED: Delivery is successfully booked. A delivery reference is returned, which must be encoded as a 2D code and clearly labelled on all pallets or cases included in this delivery.
\n
REJECTED: The pre-advice is rejected if:
\n
- Products are unapproved.
  \n
- The facility cannot accept delivery on the requested date.
  \n
\n

If rejected, a reason will always be provided. You will need to submit the pre-advice with approved products or select a new delivery date before re-submitting.

You can query the status of a pre-advice at any time.

\n","_postman_id":"a2695077-9a62-432b-96a0-7164cdfeaf3c"},{"name":"ASN","item":[{"name":"Outbound","item":[{"name":"Send GRN","id":"e47b1093-2b7f-46b1-9fdb-088f4ca0ddd7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-THG-Channel","value":"Channel","description":"

The client channel name.

\n","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"clientReference\": \"REF-98765\",\r\n \"asn\": \"90-210001-010\",\r\n \"finalReceipt\" : false,\r\n \"stockReceipts\": [\r\n {\r\n \"clientReference\": \"IT1\",\r\n \"product\": \"12345678\",\r\n \"expectedQuantity\": 10,\r\n \"receivedQuantity\": 10,\r\n \"receivedBatch\": \"A\",\r\n \"receivedBatchExpiry\": \"2024-03-14\",\r\n \"condition\": \"GOOD\"\r\n }\r\n ],\r\n \"deliveryIssues\": [],\r\n \"logisticsUnitIssues\": [],\r\n \"stockIssues\": [],\r\n \"unidentifiedStockIssues\": [],\r\n \"createdAt\": \"2025-03-25T10:00:00Z\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/goods-in/asn/{{asn}}/grn","description":"

This result of this request is a call out to the client-provided URL when there is a final Goods Received Note (GRN) for the associated ASN. The body of the subsequent request is the same as the body on the original request.

Request

Request Headers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`X-THG-Channel`	string	The client channel name.

Request

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`asn`	string	The unique identifier for the ASN from the create ASN.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`clientReference`	string	Client's reference for ASN.
`asn`	string	A unique reference to the ASN that this GRN is associated with
`finalReceipt`	boolean	Boolean flag that tells whether current grn is partial or final
`stockReceipts`	Array of StockReceipt	Details of the stock that has been received
`deliveryIssues`	Array of DeliveryIssue	A list of issues encountered during the delivery process
`logisticsUnitIssues`	Array of LogisticsUnitIssue	A list of issues related to logistics units
`stockIssues`	Array of StockIssue	A list of issues encountered with specific stock items
`unidentifiedStockIssues`	Array of UnidentifiedStockIssue	A list of inventory items that were unidentified at the time of processing
`receivedLogisticsUnits`	Array of ReceivedLogisticsUnit	A list of logistics units that have been received, with their contents and nested units
`createdAt`	string	The timestamp indicating when this GRN was created, in ISO 8601 zulu format.

StockReceipt

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`clientReference`	string	Reference ID for the client’s product.
`productId`	string	Reference for the product.
`expectedQuantity`	integer	The quantity expected in the delivery.
`receivedQuantity`	integer	The quantity received in the delivery.
`receivedBatch`	string	Batch number of the received goods, if applicable.
`receivedBatchExpiry`	string	Expiry date of the received batch, if applicable.
`condition`	string	The condition of the product received. expected values : GOOD, DAMAGED, KITTING, TRANSFER, QA, QC, HELD

DeliveryIssue

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`issueReference`	string	Warehouse Identifier for this incident.
`issueType`	string	Type of issue reported for delivery, (e.g. `UNEXPECTED_DELIVERY`).
`issueDescription`	string	A short description of the issue reported for the delivery.

LogisticsUnitIssue

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`issueReference`	string	Warehouse Identifier for this incident.
`reference`	string	SSCC or some other box, pallet reference agreed with the warehouse.
`referenceType`	string	The type of reference used for identifying the logistics unit, (e.g. `SSCC`).
`issueType`	string	The type of issue reported on the logistics unit, (e.g.`HEALTH_AND_SAFETY`).
`issueDescription`	string	A short description of the issue reported for the logistics unit for the delivery.

StockIssue

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`issueReference`	string	Warehouse Identifier for this incident.
`clientReference`	string	Client's reference to this product on ASN.
`productId`	string	Reference of the product.
`receivedBatchNumber`	string	The batch number associated with received product, if applicable.
`receivedBatchExpiry`	string	The expiry date of the batch, if applicable.
`issueQuantity`	integer	The quantity of the product received with this issue.
`issueType`	string	The type of issue reported this product, (e.g.`MISSING_OR_INCORRECT_PAPERWORK`).
`issueDescription`	string	A short description of the issue reported for the product for the delivery.

UnidentifiedStockIssue

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`issueReference`	string	Warehouse Identifier for this incident.
`barcode`	string	The barcode on the product that cannot be identified.
`issueQuantity`	integer	The quantity of this unidentified inventory item for the delivery.
`issueType`	string	The type of issue reported for unidentified product for the delivery, (e.g. `UNIDENTIFIED_PRODUCT`).
`issueDescription`	string	A short description of the issue reported for unidentified inventory item for the delivery.

ReceivedLogisticsUnit

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
reference	string	The reference identifier for this logistics unit
products	Array of ReceivedLogisticsUnitContent	The products contained within this logistics unit
logisticsUnits	Array of ReceivedLogisticsUnit	Nested logistics units contained within this unit (e.g., cartons within a pallet)
logisticUnitType	string	The type of logistics unit. Possible values: PALLET, CARTON

ReceivedLogisticsUnitContent

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
clientReference	string	Client's reference for the product
product	string	The product identifier
quantity	integer	The quantity of this product in the logistics unit

Response Body JSON Schema

  {\n    \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n    \"type\": \"object\",\n    \"properties\": {\n      \"clientReference\": { \"type\": \"string\" },\n      \"warehouseId\": { \"type\": \"integer\" },\n      \"asn\": { \"type\": \"string\" },\n      \"finalReceipt\": { \"type\": \"boolean\" },\n      \"stockReceipts\": {\n        \"type\": \"array\",\n        \"items\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"clientReference\": { \"type\": \"string\" },\n            \"product\": { \"type\": \"string\" },\n            \"expectedQuantity\": { \"type\": \"integer\" },\n            \"receivedQuantity\": { \"type\": \"integer\" },\n            \"receivedBatch\": { \"type\": \"string\" },\n            \"receivedBatchExpiry\": { \"type\": \"string\", \"format\": \"date\" },\n            \"condition\": {\n              \"type\": \"string\",\n              \"enum\": [\"GOOD\", \"DAMAGED\", \"HELD\", \"TRANSFER\"]\n            }\n          },\n          \"required\": [\"clientReference\", \"product\", \"expectedQuantity\", \"receivedQuantity\", \"condition\"]\n        }\n      },\n      \"deliveryIssues\": {\n        \"type\": \"array\",\n        \"items\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"reportReference\": { \"type\": \"string\" },\n            \"type\": {\n              \"type\": \"string\",\n              \"enum\": [\"UNEXPECTED_DELIVERY\", \"MISSING_OR_INCORRECT_PAPERWORK\", \"INCORRECT_LABELING\", \"VEHICLE_UNSAFE\", \"DRIVER_ISSUE\", \"HEALTH_AND_SAFETY\"]\n            },\n            \"description\": { \"type\": \"string\" }\n          },\n          \"required\": [\"reportReference\", \"type\", \"description\"]\n        }\n      },\n      \"logisticsUnitIssues\": {\n        \"type\": \"array\",\n        \"items\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"reportReference\": { \"type\": \"string\" },\n            \"type\": {\n              \"type\": \"string\",\n              \"enum\": [\"MISSING_OR_INCORRECT_PAPERWORK\", \"INCORRECT_LABELING\", \"HEALTH_AND_SAFETY\", \"VEHICLE_UNSAFE\", \"OTHER\"]\n            },\n            \"description\": { \"type\": \"string\" }\n          },\n          \"required\": [\"reportReference\", \"type\", \"description\"]\n        }\n      },\n      \"stockIssues\": {\n        \"type\": \"array\",\n        \"items\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"reportReference\": { \"type\": \"string\" },\n            \"type\": {\n              \"type\": \"string\",\n              \"enum\": [\"HEALTH_AND_SAFETY\", \"INCORRECT_LABELING\", \"MISSING_OR_INVALID_BATCH_EXPIRY_INFORMATION\", \"DAMAGED_GOODS\", \"PRODUCT_NOT_AS_DESCRIBED\",\n  \"MISSING_OR_INCORRECT_PAPERWORK\", \"UNSUITABLE_PACKAGING\", \"OTHER\"]\n            },\n            \"description\": { \"type\": \"string\" },\n            \"productId\": { \"type\": \"string\" },\n            \"clientReference\": { \"type\": \"string\" },\n            \"quantity\": { \"type\": \"integer\" },\n            \"batchNumber\": { \"type\": \"string\" },\n            \"batchExpiry\": { \"type\": \"string\", \"format\": \"date\" }\n          },\n          \"required\": [\"reportReference\", \"type\", \"description\", \"productId\", \"clientReference\", \"quantity\"]\n        }\n      },\n      \"unidentifiedStockIssues\": {\n        \"type\": \"array\",\n        \"items\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"reportReference\": { \"type\": \"string\" },\n            \"type\": {\n              \"type\": \"string\",\n              \"enum\": [\"HEALTH_AND_SAFETY\", \"INCORRECT_LABELING\", \"UNIDENTIFIED_PRODUCT\", \"MISSING_OR_INCORRECT_PAPERWORK\", \"UNSUITABLE_PACKAGING\", \"OTHER\"]\n            },\n            \"description\": { \"type\": \"string\" },\n            \"barcode\": { \"type\": \"string\" },\n            \"quantity\": { \"type\": \"integer\" }\n          },\n          \"required\": [\"reportReference\", \"type\", \"description\", \"barcode\", \"quantity\"]\n        }\n      },\n      \"receiptReferences\": {\n        \"type\": \"array\",\n        \"items\": {\n          \"type\": \"string\"\n        }\n      },\n      \"receivedLogisticsUnit\": {\n        \"type\": \"array\",\n        \"items\": {\n          \"$ref\": \"#/$defs/ReceivedLogisticsUnit\"\n        }\n      },\n      \"createdAt\": {\n        \"type\": \"string\",\n        \"format\": \"date-time\"\n      }\n    },\n    \"$defs\": {\n      \"ReceivedLogisticsUnit\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"reference\": { \"type\": \"string\" },\n          \"products\": {\n            \"type\": \"array\",\n            \"items\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"clientReference\": { \"type\": \"string\" },\n                \"product\": { \"type\": \"string\" },\n                \"quantity\": { \"type\": \"integer\" }\n              }\n            }\n          },\n          \"logisticsUnits\": {\n            \"type\": \"array\",\n            \"items\": {\n              \"$ref\": \"#/$defs/ReceivedLogisticsUnit\"\n            }\n          },\n          \"logisticUnitType\": {\n            \"type\": \"string\",\n            \"enum\": [\"PALLET\", \"CARTON\"]\n          }\n        }\n      }\n    },\n    \"required\": [\"clientReference\", \"warehouseId\", \"asn\", \"finalReceipt\", \"stockReceipts\", \"deliveryIssues\", \"logisticsUnitIssues\", \"stockIssues\", \"unidentifiedStockIssues\",\n  \"receiptReferences\", \"createdAt\"],\n    \"if\": {\n      \"properties\": {\n        \"finalReceipt\": { \"const\": false }\n      }\n    },\n    \"then\": {\n      \"properties\": {\n        \"stockReceipts\": {\n          \"maxItems\": 1,\n          \"minItems\": 1\n        },\n        \"deliveryIssues\": {\n          \"maxItems\": 0\n        },\n        \"logisticsUnitIssues\": {\n          \"maxItems\": 0\n        },\n        \"stockIssues\": {\n          \"maxItems\": 0\n        },\n        \"unidentifiedStockIssues\": {\n          \"maxItems\": 0\n        },\n        \"receiptReferences\": {\n          \"maxItems\": 1,\n          \"minItems\": 1\n        }\n      }\n    },\n    \"else\": {\n      \"properties\": {\n        \"stockReceipts\": {\n          \"minItems\": 1\n        },\n        \"receiptReferences\": {\n          \"minItems\": 1\n        }\n      }\n    }\n  }\n\n

\n","urlObject":{"path":["goods-in","asn","{{asn}}","grn"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"6e0baf9e-4d92-41bb-8eee-f34020f0860c","name":"Send partial GRN (Success)","originalRequest":{"method":"POST","header":[{"key":"client-order-reference","value":"ClientOrder00001","description":"The client order reference that the update is for","type":"text"},{"key":"X-THG-Channel","value":"Channel","description":"The client channel name.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"clientReference\": \"REF-98765\",\r\n \"asn\": \"90-210001-010\",\r\n \"finalReceipt\" : false,\r\n \"stockReceipts\": [\r\n {\r\n \"clientReference\": \"IT1\",\r\n \"product\": \"12345678\",\r\n \"expectedQuantity\": 10,\r\n \"receivedQuantity\": 10,\r\n \"receivedBatch\": \"A\",\r\n \"receivedBatchExpiry\": \"2024-03-14\",\r\n \"condition\": \"GOOD\"\r\n }\r\n ],\r\n \"deliveryIssues\": [],\r\n \"logisticsUnitIssues\": [],\r\n \"stockIssues\": [],\r\n \"unidentifiedStockIssues\": [],\r\n \"createdAt\": \"2025-03-25T10:00:00Z\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/goods-in/asn/{{asn}}/grn"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":null},{"id":"eed63230-7bc5-42d2-8691-7f9e2a79bedd","name":"Send Final GRN(Success)","originalRequest":{"method":"POST","header":[{"key":"X-THG-Channel","value":"Channel","description":"The client channel name.","type":"text"}],"body":{"mode":"raw","raw":"{\r\n \"clientReference\": \"REF-98765\",\r\n \"warehouseId\": 1,\r\n \"asn\": \"90-210001-010\",\r\n \"finalReceipt\": true,\r\n \"stockReceipts\": [\r\n {\r\n \"clientReference\": \"IT1\",\r\n \"product\": \"12345678\",\r\n \"expectedQuantity\": 10,\r\n \"receivedQuantity\": 10,\r\n \"receivedBatch\": \"A\",\r\n \"receivedBatchExpiry\": \"2024-03-14\",\r\n \"condition\": \"GOOD\",\r\n \"identifiers\": {\r\n \"IMEI\": [\r\n \"9876543217\",\r\n \"9876543218\",\r\n \"9876543219\",\r\n \"9876543220\",\r\n \"9876543221\",\r\n \"9876543222\",\r\n \"9876543223\",\r\n \"9876543224\",\r\n \"9876543225\",\r\n \"9876543226\"\r\n ],\r\n \"SERIAL_NUMBERS\":[\r\n \"SN351234567896\",\r\n \"SN351234567897\",\r\n \"SN351234567898\",\r\n \"SN351234567899\",\r\n \"SN351234567900\",\r\n \"SN351234567901\",\r\n \"SN351234567902\",\r\n \"SN351234567903\",\r\n \"SN351234567904\",\r\n \"SN351234567905\"\r\n ]\r\n }\r\n },\r\n {\r\n \"clientReference\": \"IT2\",\r\n \"product\": \"12312312\",\r\n \"expectedQuantity\": 10,\r\n \"receivedQuantity\": 5,\r\n \"receivedBatch\": \"B\",\r\n \"receivedBatchExpiry\": \"2024-02-14\",\r\n \"condition\": \"GOOD\",\r\n \"identifiers\": {\r\n \"IMEI\": [\r\n \"9876543217\",\r\n \"9876543218\",\r\n \"9876543219\",\r\n \"9876543220\",\r\n \"9876543221\"\r\n ],\r\n \"SERIAL_NUMBERS\":[\r\n \"SN451234567896\",\r\n \"SN451234567897\",\r\n \"SN41234567898\",\r\n \"SN351234567899\",\r\n \"SN351234567900\"\r\n ]\r\n }\r\n }\r\n ],\r\n \"deliveryIssues\": [\r\n {\r\n \"reportReference\": \"DEL-001\",\r\n \"type\": \"MISSING_OR_INCORRECT_PAPERWORK\",\r\n \"description\": \"Delivery note missing for second pallet\"\r\n }\r\n ],\r\n \"logisticsUnitIssues\": [],\r\n \"stockIssues\": [\r\n {\r\n \"reportReference\": \"STK-001\",\r\n \"type\": \"DAMAGED_GOODS\",\r\n \"description\": \"One unit damaged during transport\",\r\n \"productId\": \"87654321\",\r\n \"clientReference\": \"IT2\",\r\n \"quantity\": 1,\r\n \"batchNumber\": \"B\",\r\n \"batchExpiry\": \"2024-04-10\"\r\n }\r\n ],\r\n \"receivedLogisticsUnits\": [\r\n {\r\n \"reference\": \"SSCC1234502\",\r\n \"products\": [],\r\n \"logisticsUnits\": [\r\n {\r\n \"reference\": \"SSCC2345602\",\r\n \"products\": [\r\n {\r\n \"clientReference\": \"IT1\",\r\n \"product\": \"12345678\",\r\n \"quantity\": 10\r\n }\r\n ],\r\n \"logisticsUnits\": [],\r\n \"logisticUnitType\": \"CARTON\"\r\n }\r\n ],\r\n \"logisticUnitType\": \"PALLET\"\r\n },\r\n {\r\n \"reference\": \"SSCC1234501\",\r\n \"products\": [],\r\n \"logisticsUnits\": [\r\n {\r\n \"reference\": \"SSCC2345601\",\r\n \"products\": [\r\n {\r\n \"clientReference\": \"IT2\",\r\n \"product\": \"12312312\",\r\n \"quantity\": 10\r\n }\r\n ],\r\n \"logisticsUnits\": [],\r\n \"logisticUnitType\": \"CARTON\"\r\n }\r\n ],\r\n \"logisticUnitType\": \"PALLET\"\r\n }\r\n ],\r\n \"unidentifiedStockIssues\": [],\r\n \"receiptReferences\": [\"G1747406648723683-12345678-1740463200000\", \"G1747406648723683-87654321-1740468600000\"],\r\n \"createdAt\": \"2025-03-25T10:00:00Z\"\r\n}","options":{"raw":{"language":"json"}}},"url":"/goods-in/asn/{{asn}}/grn"},"_postman_previewlanguage":"","header":[],"cookie":[{"expires":"Invalid Date","domain":"","path":""}],"responseTime":null,"body":""}],"_postman_id":"e47b1093-2b7f-46b1-9fdb-088f4ca0ddd7"}],"id":"474cde62-7efb-4615-8150-e531eb6ca0ee","description":"

Endpoints in the 'Outbound' folder are requests which can be sent from THG Ingenuity API to a client URL.

The client must provide the URL to hit with each request and any authentication method which is required.

\n","_postman_id":"474cde62-7efb-4615-8150-e531eb6ca0ee"},{"name":"Create ASN","id":"8cd59ffe-9981-4f56-b920-254a851d0f5a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n \"warehouseId\": \"string\",\n \"clientReference\": \"string\",\n \"deliveryReference\": \"string\",\n \"deliveryPartnersReference\": \"string\",\n \"contents\": [\n {\n \"reference\": \"string\",\n \"logisticsUnits\": [],\n \"products\": [\n {\n \"clientReference\": \"string\",\n \"productId\": \"string\",\n \"quantity\": 0,\n \"condition\": \"string\",\n \"batchNumber\": \"string\",\n \"batchExpiry\": \"string\",\n \"stockStatus\": \"string\",\n \"identifiers\": {\n \"string\": [\n \"string\"\n ]\n }\n }\n ],\n \"referenceType\": \"string\",\n \"type\": \"string\"\n }\n ],\n \"deliveryVehicle\": {\n \"type\": \"string\",\n \"registrationNumber\": \"string\",\n \"driverName\": \"string\",\n \"haulierName\": \"string\"\n }\n }","options":{"raw":{"language":"json"}}},"url":"/goods-in/asn","description":"

This endpoint is used to create a ASN for deliveries, allowing clients to notify the system about incoming deliveries and their expected details.

Request

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`warehouseId`	string	Y	The ID of the warehouse where the goods will be arriving.
`clientReference`	string	N	Client's reference for the ASN.
`deliveryReference`	string	Y	Delivery reference from the pre-advice approval.
`deliveryPartnersReference`	string	N	The courier or transporters reference.
`contents`	Array of LogisticsUnit	Y	A list of logistics units included in this ASN.
`deliveryVehicle`	DeliveryVehicle	Y	Details about the delivery vehicle transporting the ASN.

LogisticsUnit

There are 2 types of ASNs which can be created:

ASN Type 1 - ASNs with Logistics Unit information
\n
ASN Type 2 - ASNs without Logistics Unit information
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`reference`	string	Y (ASN Type 1) N (ASN Type 2)	SSCC or some other box, pallet reference agreed with the warehouse.
`logisticsUnits`	Array of LogisticsUnit	N	A list of LogisticsUnit placed on in this logistic unit, both `logisticsUnits` and `products` can not be empty.
`products`	Array of LogisticsUnitContent	N	A list of LogisticsUnitContent placed on in this logistic unit, both `logisticsUnits` and `products` can not be empty.
`referenceType`	string	Y (ASN Type 1) N (ASN Type 2)	The type of reference used for identifying the logistics unit (e.g., `SSCC`).
`type`	string	Y (ASN Type 1) N (ASN Type 2)	The type of logistics unit, such as a PALLET or CARTON (e.g., `PALLET`).

DeliveryVehicle

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`type`	string	Y	The type of delivery vehicle, (e.g., CURTAIN, REAR, VAN).
`registrationNumber`	string	Y	The vehicle's registration number.
`driverName`	string	N	The driver's name, if available.
`haulierName`	string	N	The name of the haulier company, if available

LogisticsUnitContent

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
clientReference	string	N	Client's reference to this product.
productId	string	Y	The reference for the product.
quantity	integer	Y	The quantity of the product in the logistics unit.
condition	ClientStockCondition	N	The condition of the product from Enum set ClientStockCondition.
batchNumber	string	N	The batch number associated with this product, if applicable.
batchExpiry	string	N	The expiry date of the batch in the format `YYYY-MM-DD`, if applicable.
identifiers	object	N	A map of identifier types to arrays of identifier values. Each key represents an identifier type (`SERIAL_NUMBER`, `IMEI`, `MAC_ADDRESS`) and each value is an array of strings, where each value uniquely identifies one physical unit of the product.

ClientStockCondition

Possible values:

GOOD
\n
DAMAGED
\n
EXPIRED
\n
TRANSFER
\n
QC
\n
QA
\n
KITTING
\n

\n
Condition validation:
\n

In logisticsUnitContent, the condition field can be provided only when the ASN type selected during pre-advice is DEFAULT.
\n
If no ASN type is selected during pre-advice, it is automatically treated as DEFAULT, and condition can be provided.
For DEFAULT ASN type, each productId must have one consistent condition. If not provided, it defaults to GOOD.
\n
For any non-default ASN type, the client must not provide product-level condition. If it is provided, the ASN will be rejected. In such cases, condition is derived/backfilled from the ASN type for all products.
For example, if the ASN type is QC, or KITTING all products are treated as condition = QC or condition = KITTING resp, for other asn types, condition is set to GOOD, so the inbound value remains aligned with the value returned later during receipt processing.
\n

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"warehouseId\": {\n      \"type\": \"string\"\n    },\n    \"clientReference\": {\n      \"type\": \"string\"\n    },\n    \"deliveryReference\": {\n      \"type\": \"string\"\n    },\n    \"deliveryPartnersReference\": {\n      \"type\": \"string\"\n    },\n    \"contents\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"reference\": {\n            \"type\": \"string\"\n          },\n          \"logisticsUnits\": {\n            \"type\": \"array\",\n            \"items\": {\n              \"$ref\": \"#\"\n            }\n          },\n          \"products\": {\n            \"type\": \"array\",\n            \"items\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"clientReference\": {\n                  \"type\": \"string\"\n                },\n                \"productId\": {\n                  \"type\": \"string\"\n                },\n                \"quantity\": {\n                  \"type\": \"integer\"\n                },\n                \"condition\": {\n                  \"type\": \"string\",\n                  \"enum\": [\"GOOD\", \"DAMAGED\", \"EXPIRED\", \"QC\", \"QA\", \"KITTING\", \"TRANSFER\"]\n                },\n                \"batchNumber\": {\n                  \"type\": \"string\"\n                },\n                \"batchExpiry\": {\n                  \"type\": \"string\",\n                  \"format\": \"date\"\n                },\n                \"identifiers\": {\n                  \"type\": \"object\",\n                  \"additionalProperties\": {\n                    \"type\": \"array\",\n                    \"items\": {\n                      \"type\": \"string\"\n                    }\n                  }\n                }\n              },\n              \"required\": [\"productId\", \"quantity\"]\n            }\n          },\n          \"referenceType\": {\n            \"type\": \"string\"\n          },\n          \"type\": {\n            \"type\": \"string\"\n          }\n        },\n        \"required\": [\"reference\", \"referenceType\", \"type\"]\n      }\n    },\n    \"deliveryVehicle\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"type\": {\n          \"type\": \"string\"\n        },\n        \"registrationNumber\": {\n          \"type\": \"string\"\n        },\n        \"driverName\": {\n          \"type\": \"string\"\n        },\n        \"haulierName\": {\n          \"type\": \"string\"\n        }\n      },\n      \"required\": [\"type\", \"registrationNumber\"]\n    }\n  },\n  \"required\": [\"warehouseId\", \"deliveryReference\", \"contents\",\"deliveryVehicle\"]\n}\n\n

Response

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`timestamp`	string	The timestamp when the response was generated.
`id`	string	A unique identifier for the ASN.
`clientReference`	string	Client's reference for the ASN, if available.

JSON Schema

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"timestamp\": {\n      \"type\": \"string\",\n      \"format\": \"date-time\"\n    },\n    \"id\": {\n      \"type\": \"string\"\n    },\n    \"consumerReference\": {\n      \"type\": \"string\"\n    }\n  },\n  \"required\": [\n    \"timestamp\",\n    \"id\",\n    \"consumerReference\"\n  ]\n}\n\n

\n","urlObject":{"path":["goods-in","asn"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"0995ddfd-91fe-4c1b-a433-c104d481d06a","name":"Create ASN (Success)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientReference\": \"REF-98765\",\n \"warehouseId\": \"90\",\n \"deliveryReference\": \"90-210001-010\",\n \"deliveryPartnersReference\": \"random courier\",\n \"contents\": [\n {\n \"products\": [\n {\n \"clientReference\": \"IT1\",\n \"productId\": \"12345678\",\n \"quantity\": 10,\n \"condition\": \"GOOD\",\n \"batchNumber\": \"A\",\n \"batchExpiry\": \"2024-03-14\",\n \"identifiers\": {\n \"IMEI\": [\n \"1000000001\",\n \"1000000002\",\n \"1000000003\",\n \"1000000004\",\n \"1000000005\",\n \"1000000006\",\n \"1000000007\",\n \"1000000008\",\n \"1000000009\",\n \"1000000010\"\n ],\n \"SERIAL_NUMBER\": [\n \"SN000001\",\n \"SN000002\",\n \"SN000003\",\n \"SN000004\",\n \"SN000005\",\n \"SN000006\",\n \"SN000007\",\n \"SN000008\",\n \"SN000009\",\n \"SN000010\"\n ]\n }\n }\n ],\n \"logisticsUnits\": [],\n \"reference\": \"LU1\",\n \"referenceType\": \"DELIVERY_REFERENCE\",\n \"type\": \"PALLET\"\n }\n ],\n \"deliveryVehicle\": {\n \"type\": \"VAN\",\n \"registrationNumber\": \"DB012VGR\",\n \"driverName\": \"Jack\",\n \"haulierName\": \"John\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"/goods-in/asn"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2025-03-24T10:54:20.343+00:00\",\n \"id\": \"1de341ae-850f-4f74-addb-57a3d26c8024\",\n \"consumerReference\": \"REF-98765\" \n}"}],"_postman_id":"8cd59ffe-9981-4f56-b920-254a851d0f5a"},{"name":"Get Approval","id":"b5987e0d-9d72-4e7a-8cdf-f437ceae8c18","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/goods-in/asn/{{asn}}/approval","description":"

This endpoint is used to get the approval or rejection status of a ASN delivery request

Request

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`asn`	string	The unique identifier for the ASN, from the create the ASN response.

Response

Response Body Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`message`	string	The approval (or) rejection message

JSON Schema

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"message\": {\n      \"type\": \"string\"\n    }\n  },\n  \"required\": [\n    \"message\"\n  ]\n}\n\n

\n","urlObject":{"path":["goods-in","asn","{{asn}}","approval"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"cad63980-340b-4772-b2ba-6cc47a6d5fdc","name":"Approved","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/goods-in/asn/1de341ae-850f-4f74-addb-57a3d26c8024/approval"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"ASN APPROVED\"\n}"},{"id":"c2ba6323-1d3c-41b2-85f5-68e28819f04c","name":"Rejected","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/goods-in/asn/1de341ae-850f-4f74-addb-57a3d26c000/approval"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"message\": \"ASN REJECTED\"\n}"}],"_postman_id":"b5987e0d-9d72-4e7a-8cdf-f437ceae8c18"},{"name":"Get Progress","id":"bf7b3523-b9fa-4bc7-855c-724c0da77a0f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/goods-in/asn/{{asn}}/progress","description":"

This endpoint is used to get the progress of a asn

Request

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`asn`	string	The unique identifier for the ASN from the create ASN response.

Response

Response Body Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`progressMessage`	string	The current status of the ASN. Possible values are `PENDING`, `ARRIVED`, `STARTED`, or `FINISHED`.

JSON Schema

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"progressMessage\": {\n      \"type\": \"string\",\n      \"enum\": [\"PENDING\", \"ARRIVED\", \"STARTED\", \"FINISHED\"]\n    }\n  },\n  \"required\": [\n    \"progressMessage\"\n  ]\n}\n\n

\n","urlObject":{"path":["goods-in","asn","{{asn}}","progress"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"0cf237cc-dad4-4d69-afa7-6cd579713fa2","name":"Get Progress (Success)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/goods-in/asn/1de341ae-850f-4f74-addb-57a3d26c8024/progress"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"progressMessage\": \"PENDING\"\n}"}],"_postman_id":"bf7b3523-b9fa-4bc7-855c-724c0da77a0f"},{"name":"Get ASN","id":"894b354c-19f4-4d85-b6bd-550c0fe36c9c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/goods-in/asn/{{asn}}","description":"

This endpoint is used to get the asn

Request

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`asn`	string	The unique identifier for the ASN, which was received as a response after creating the ASN.

Response

Response Body Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`warehouseId`	string	The ID of the warehouse where the goods will be arriving.
`clientReference`	string	Client's reference for the ASN.
`deliveryReference`	string	Delivery reference from the pre-advice approval.
`deliveryPartnersReference`	string	The courier or transporters reference.
`contents`	Array of LogisticsUnit	A list of logistics units included in this ASN.
`deliveryVehicle`	DeliveryVehicle	Details about the delivery vehicle transporting the ASN.

LogisticsUnit

There are 2 types of ASNs:

ASNs that were created with Logistics Unit information
\n
ASNs that were created without Logistics Unit information
\n

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`reference`	string	SSCC or some other box, pallet reference agreed with the warehouse. This will be empty for ASN type 2.
`logisticsUnits`	Array of LogisticsUnit	A list of LogisticsUnit placed on in this logistic unit, both `logisticsUnits` and `product` can not be empty. This will be empty for ASN type 2.
`products`	Array of Product	A list of Product placed on in this logistic unit, both `logisticsUnits` and `product` can not be empty.
`referenceType`	string	The type of reference used for identifying the logistics unit (e.g., `SSCC`). This will be empty for ASN type 2.
`type`	string	The type of logistics unit, such as a PALLET or CARTON (e.g., `PALLET`). This will be empty for ASN type 2.

DeliveryVehicle

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`type`	string	The type of delivery vehicle, (e.g., `CURTAIN`).
`registrationNumber`	string	The vehicle's registration number.
`driverName`	string	The driver's name, if available.
`haulierName`	string	The name of the haulier company, if available

Product

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`clientReference`	string	Client's reference to this product.
`productId`	string	The reference for the product.
`quantity`	integer	The quantity of the product in the logistics unit.
`condition`	ClientStockCondition	The condition of the product. Enum value from ClientStockCondition.
`batchNumber`	string	The batch number associated with this product, if applicable.
`batchExpiry`	string	The expiry date of the batch in the format `YYYY-MM-DD`, if applicable.
`identifiers`	object	A map of identifier types to their values. Each key is an identifier type (e.g. `IMEI`, `SERIAL_NUMBERS`) and the value is an array of strings representing the identifier values.

ClientStockCondition

Possible values:

GOOD
\n
DAMAGED
\n
EXPIRED
\n
TRANSFER
\n
QC
\n
QA
\n
KITTING
\n

JSON Schema

{\n  \"type\": \"object\",\n  \"properties\": {\n    \"clientReference\": {\n      \"type\": \"string\"\n    },\n    \"warehouseId\": {\n      \"type\": \"string\"\n    },\n    \"deliveryReference\": {\n      \"type\": \"string\"\n    },\n    \"deliveryPartnersReference\": {\n      \"type\": \"string\"\n    },\n    \"contents\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"products\": {\n            \"type\": \"array\",\n            \"items\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"clientReference\": {\n                  \"type\": \"string\"\n                },\n                \"product\": {\n                  \"type\": \"string\"\n                },\n                \"quantity\": {\n                  \"type\": \"integer\"\n                },\n                \"condition\": {\n                  \"type\": \"string\",\n                  \"enum\": [\"GOOD\", \"DAMAGED\", \"EXPIRED\"]\n                },\n                \"batchNumber\": {\n                  \"type\": \"string\"\n                },\n                \"batchExpiry\": {\n                  \"type\": \"string\",\n                  \"format\": \"date-time\"\n                },\n                \"identifiers\": {\n                  \"type\": \"object\",\n                  \"additionalProperties\": {\n                    \"type\": \"array\",\n                    \"items\": {\n                      \"type\": \"string\"\n                    }\n                  }\n                }\n              },\n              \"required\": [\"product\", \"quantity\"]\n            }\n          },\n          \"logisticsUnits\": {\n            \"type\": \"array\",\n            \"items\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"reference\": {\n                  \"type\": \"string\"\n                },\n                \"referenceType\": {\n                  \"type\": \"string\",\n                  \"enum\": [\"DELIVERY_REFERENCE\"]\n                },\n                \"type\": {\n                  \"type\": \"string\",\n                  \"enum\": [\"PALLET\"]\n                }\n              }\n            }\n          },\n          \"reference\": {\n            \"type\": \"string\"\n          },\n          \"referenceType\": {\n            \"type\": \"string\",\n            \"enum\": [\"DELIVERY_REFERENCE\"]\n          },\n          \"type\": {\n            \"type\": \"string\",\n            \"enum\": [\"PALLET\"]\n          }\n        },\n        \"required\": [\"products\", \"reference\", \"type\"]\n      }\n    },\n    \"deliveryVehicle\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"type\": {\n          \"type\": \"string\",\n          \"enum\": [\"VAN\"]\n        },\n        \"registrationNumber\": {\n          \"type\": \"string\"\n        },\n        \"driverName\": {\n          \"type\": \"string\"\n        },\n        \"haulierName\": {\n          \"type\": \"string\"\n        }\n      }\n    }\n  },\n  \"required\": [\n    \"clientReference\",\n    \"warehouseId\",\n    \"deliveryReference\",\n    \"deliveryPartnersReference\",\n    \"contents\",\n    \"deliveryVehicle\"\n  ]\n}\n\n

\n","urlObject":{"path":["goods-in","asn","{{asn}}"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"8538e7e0-b0ca-4684-b830-3f6bd1820521","name":"Get Asn (Success)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/goods-in/asn/1de341ae-850f-4f74-addb-57a3d26c8024"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"clientReference\": \"REF-98765\",\n \"warehouseId\": 90,\n \"deliveryReference\": \"90-210001-010\",\n \"deliveryPartnersReference\": \"random courier\",\n \"contents\": [\n {\n \"reference\": \"LU1\",\n \"referenceType\": \"DELIVERY_REFERENCE\",\n \"type\": \"PALLET\",\n \"products\": [\n {\n \"clientReference\": \"IT1\",\n \"productId\": \"12345678\",\n \"quantity\": 5,\n \"condition\": \"GOOD\",\n \"batchNumber\": \"A\",\n \"batchExpiry\": \"2024-03-14\",\n \"identifiers\": {\n \"IMEI\": [\n \"9876543217\",\n \"9876543218\",\n \"9876543219\",\n \"9876543220\",\n \"9876543221\"\n ],\n \"SERIAL_NUMBERS\": [\n \"SN451234567896\",\n \"SN451234567897\",\n \"SN41234567898\",\n \"SN351234567899\",\n \"SN351234567900\"\n ]\n }\n }\n ],\n \"logisticsUnits\": []\n }\n ],\n \"deliveryVehicle\": {\n \"type\": \"VAN\",\n \"registrationNumber\": \"DB012VGR\",\n \"driverName\": \"Jack\",\n \"haulierName\": \"John\"\n },\n \"createdAt\": null\n }"}],"_postman_id":"894b354c-19f4-4d85-b6bd-550c0fe36c9c"},{"name":"Get GRN","id":"828931b7-1c15-458d-9cb3-a7a007f5a07f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/goods-in/asn/{{asn}}/grn","description":"

This endpoint is used to retrieve the Goods Receipt Note for an ASN

Request

Path Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`asn`	string	The unique identifier for the ASN from the create ASN.

Response

Response Body Fields

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
clientReference	string	Client's reference for ASN.
asn	string	A unique reference to the ASN that this GRN is associated with
warehouseId	integer	THG's identifier for the warehouse the ASN has been receipted into.
finalReceipt	Boolean	Flag indicating whether this receipt is complete/final.
stockReceipts	Array of StockReceipt	Details of the stock that has been received
deliveryIssues	Array of DeliveryIssue	A list of issues encountered during the delivery process
logisticsUnitIssues	Array of LogisticsUnitIssue	A list of issues related to logistics units
stockIssues	Array of StockIssue	A list of issues encountered with specific stock items
unidentifiedStockIssues	Array of UnidentifiedStockIssue	A list of inventory items that were unidentified at the time of processing
receiptReferences	Array of string	A list of all receipt references which have been issued for this ASN and which make up this receipt.
receivedLogisticsUnits	Array of ReceivedLogisticsUnit	A list of logistics units that have been received, with their contents and nested units
createdAt	string	The timestamp indicating when this GRN was created, in ISO 8601 zulu format.

Note : receivedLogisticsUnits data will be present only if final Receipt is receipted. i.e. if finalReceipt is true.

StockReceipt

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`clientReference`	string	Reference ID for the client's product.
`product`	string	Reference for the product.
`expectedQuantity`	integer	The quantity expected in the delivery.
`receivedQuantity`	integer	The quantity received in the delivery.
`receivedBatch`	string	Batch number of the received goods, if applicable.
`receivedBatchExpiry`	string	Expiry date of the received batch, if applicable.
`condition`	string	The condition of the product received. Expected value : GOOD, DAMAGED, EXPIRED, HELD, TRANSFER, QA, QC, KITTING.
`identifiers`	object	Unit identifiers captured during receiving units, grouped by type. Each identifier type maps to a list of values (e.g. `{\"IMEI\": [\"1234567\",\"123568\"], \"SERIAL\": [\"SN001\", \"SN002\"]}`).

DeliveryIssue

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`reportReference`	string	Warehouse Identifier for this incident.
`type`	string	Type of issue reported for delivery, (e.g. `UNEXPECTED_DELIVERY`).
`description`	string	A short description of the issue reported for the delivery.

LogisticsUnitIssue

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`reportReference`	string	Warehouse Identifier for this incident.
`type`	string	The type of reference used for identifying the logistics unit, (e.g. `SSCC`).
`description`	string	A short description of the issue reported for the logistics unit for the delivery.

StockIssue

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`reportReference`	string	Warehouse Identifier for this incident.
`clientReference`	string	Client's reference to this product on ASN.
`productId`	string	Reference of the product.
`batchNumber`	string	The batch number associated with received product, if applicable.
`batchExpiry`	string	The expiry date of the batch, if applicable.
`quantity`	integer	The quantity of the product received with this issue.
`type`	string	The type of issue reported this product, (e.g.`MISSING_OR_INCORRECT_PAPERWORK`).
`description`	string	A short description of the issue reported for the product for the delivery.

UnidentifiedStockIssue

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
`reportReference`	string	Warehouse Identifier for this incident.
`barcode`	string	The barcode on the product that cannot be identified.
`quantity`	integer	The quantity of this unidentified inventory item for the delivery.
`type`	string	The type of issue reported for unidentified product for the delivery, (e.g. `UNIDENTIFIED_PRODUCT`).
`description`	string	A short description of the issue reported for unidentified inventory item for the delivery.

ReceivedLogisticsUnit

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
reference	string	The reference identifier for this logistics unit
products	Array of ReceivedLogisticsUnitContent	The products contained within this logistics unit
logisticsUnits	Array of ReceivedLogisticsUnit	Nested logistics units contained within this unit (e.g., cartons within a pallet)
logisticUnitType	string	The type of logistics unit. Possible values: PALLET, CARTON

ReceivedLogisticsUnitContent

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Description
clientReference	string	Client's reference for the product
product	string	The product identifier
quantity	integer	The quantity of this product in the logistics unit

JSON Schema

  {\n    \"$schema\": \"http://json-schema.org/draft-07/schema#\",\n    \"type\": \"object\",\n    \"properties\": {\n      \"clientReference\": { \"type\": \"string\" },\n      \"warehouseId\": { \"type\": \"integer\" },\n      \"asn\": { \"type\": \"string\" },\n      \"finalReceipt\": { \"type\": \"boolean\" },\n      \"stockReceipts\": {\n        \"type\": \"array\",\n        \"items\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"clientReference\": { \"type\": \"string\" },\n            \"product\": { \"type\": \"string\" },\n            \"expectedQuantity\": { \"type\": \"integer\" },\n            \"receivedQuantity\": { \"type\": \"integer\" },\n            \"receivedBatch\": { \"type\": \"string\" },\n            \"receivedBatchExpiry\": { \"type\": \"string\", \"format\": \"date\" },\n            \"condition\": {\n              \"type\": \"string\",\n              \"enum\": [\"GOOD\", \"DAMAGED\", \"HELD\", \"TRANSFER\"]\n            }\n          },\n          \"required\": [\"clientReference\", \"product\", \"expectedQuantity\", \"receivedQuantity\", \"condition\"]\n        }\n      },\n      \"deliveryIssues\": {\n        \"type\": \"array\",\n        \"items\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"reportReference\": { \"type\": \"string\" },\n            \"type\": {\n              \"type\": \"string\",\n              \"enum\": [\"UNEXPECTED_DELIVERY\", \"MISSING_OR_INCORRECT_PAPERWORK\", \"INCORRECT_LABELING\", \"VEHICLE_UNSAFE\", \"DRIVER_ISSUE\", \"HEALTH_AND_SAFETY\"]\n            },\n            \"description\": { \"type\": \"string\" }\n          },\n          \"required\": [\"reportReference\", \"type\", \"description\"]\n        }\n      },\n      \"logisticsUnitIssues\": {\n        \"type\": \"array\",\n        \"items\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"reportReference\": { \"type\": \"string\" },\n            \"type\": {\n              \"type\": \"string\",\n              \"enum\": [\"MISSING_OR_INCORRECT_PAPERWORK\", \"INCORRECT_LABELING\", \"HEALTH_AND_SAFETY\", \"VEHICLE_UNSAFE\", \"OTHER\"]\n            },\n            \"description\": { \"type\": \"string\" }\n          },\n          \"required\": [\"reportReference\", \"type\", \"description\"]\n        }\n      },\n      \"stockIssues\": {\n        \"type\": \"array\",\n        \"items\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"reportReference\": { \"type\": \"string\" },\n            \"type\": {\n              \"type\": \"string\",\n              \"enum\": [\"HEALTH_AND_SAFETY\", \"INCORRECT_LABELING\", \"MISSING_OR_INVALID_BATCH_EXPIRY_INFORMATION\", \"DAMAGED_GOODS\", \"PRODUCT_NOT_AS_DESCRIBED\",\n  \"MISSING_OR_INCORRECT_PAPERWORK\", \"UNSUITABLE_PACKAGING\", \"OTHER\"]\n            },\n            \"description\": { \"type\": \"string\" },\n            \"productId\": { \"type\": \"string\" },\n            \"clientReference\": { \"type\": \"string\" },\n            \"quantity\": { \"type\": \"integer\" },\n            \"batchNumber\": { \"type\": \"string\" },\n            \"batchExpiry\": { \"type\": \"string\", \"format\": \"date\" }\n          },\n          \"required\": [\"reportReference\", \"type\", \"description\", \"productId\", \"clientReference\", \"quantity\"]\n        }\n      },\n      \"unidentifiedStockIssues\": {\n        \"type\": \"array\",\n        \"items\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"reportReference\": { \"type\": \"string\" },\n            \"type\": {\n              \"type\": \"string\",\n              \"enum\": [\"HEALTH_AND_SAFETY\", \"INCORRECT_LABELING\", \"UNIDENTIFIED_PRODUCT\", \"MISSING_OR_INCORRECT_PAPERWORK\", \"UNSUITABLE_PACKAGING\", \"OTHER\"]\n            },\n            \"description\": { \"type\": \"string\" },\n            \"barcode\": { \"type\": \"string\" },\n            \"quantity\": { \"type\": \"integer\" }\n          },\n          \"required\": [\"reportReference\", \"type\", \"description\", \"barcode\", \"quantity\"]\n        }\n      },\n      \"receiptReferences\": {\n        \"type\": \"array\",\n        \"items\": {\n          \"type\": \"string\"\n        }\n      },\n      \"receivedLogisticsUnit\": {\n        \"type\": \"array\",\n        \"items\": {\n          \"$ref\": \"#/$defs/ReceivedLogisticsUnit\"\n        }\n      },\n      \"createdAt\": {\n        \"type\": \"string\",\n        \"format\": \"date-time\"\n      }\n    },\n    \"$defs\": {\n      \"ReceivedLogisticsUnit\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"reference\": { \"type\": \"string\" },\n          \"products\": {\n            \"type\": \"array\",\n            \"items\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"clientReference\": { \"type\": \"string\" },\n                \"product\": { \"type\": \"string\" },\n                \"quantity\": { \"type\": \"integer\" }\n              }\n            }\n          },\n          \"logisticsUnits\": {\n            \"type\": \"array\",\n            \"items\": {\n              \"$ref\": \"#/$defs/ReceivedLogisticsUnit\"\n            }\n          },\n          \"logisticUnitType\": {\n            \"type\": \"string\",\n            \"enum\": [\"PALLET\", \"CARTON\"]\n          }\n        }\n      }\n    },\n    \"required\": [\"clientReference\", \"warehouseId\", \"asn\", \"finalReceipt\", \"stockReceipts\", \"deliveryIssues\", \"logisticsUnitIssues\", \"stockIssues\", \"unidentifiedStockIssues\",\n  \"receiptReferences\", \"createdAt\"],\n    \"if\": {\n      \"properties\": {\n        \"finalReceipt\": { \"const\": false }\n      }\n    },\n    \"then\": {\n      \"properties\": {\n        \"stockReceipts\": {\n          \"maxItems\": 1,\n          \"minItems\": 1\n        },\n        \"deliveryIssues\": {\n          \"maxItems\": 0\n        },\n        \"logisticsUnitIssues\": {\n          \"maxItems\": 0\n        },\n        \"stockIssues\": {\n          \"maxItems\": 0\n        },\n        \"unidentifiedStockIssues\": {\n          \"maxItems\": 0\n        },\n        \"receiptReferences\": {\n          \"maxItems\": 1,\n          \"minItems\": 1\n        }\n      }\n    },\n    \"else\": {\n      \"properties\": {\n        \"stockReceipts\": {\n          \"minItems\": 1\n        },\n        \"receiptReferences\": {\n          \"minItems\": 1\n        }\n      }\n    }\n  }\n\n

\n","urlObject":{"path":["goods-in","asn","{{asn}}","grn"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"61765dff-274e-4798-bfad-561f7177acf7","name":"200 (Success) Final Receipt","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/goods-in/asn/1de341ae-850f-4f74-addb-57a3d26c8024/grn"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"clientReference\": \"REF-98765\",\n \"warehouseId\": 1,\n \"asn\": \"90-210001-010\",\n \"finalReceipt\": true,\n \"stockReceipts\": [\n {\n \"clientReference\": \"IT1\",\n \"product\": \"12345678\",\n \"expectedQuantity\": 10,\n \"receivedQuantity\": 10,\n \"receivedBatch\": \"A\",\n \"receivedBatchExpiry\": \"2024-03-14\",\n \"condition\": \"GOOD\",\n \"identifiers\": {\n \"IMEI\": [\n \"9876543217\",\n \"9876543218\",\n \"9876543219\",\n \"9876543220\",\n \"9876543221\",\n \"9876543222\",\n \"9876543223\",\n \"9876543224\",\n \"9876543225\",\n \"9876543226\"\n ],\n \"SERIAL_NUMBERS\":[\n \"SN351234567896\",\n \"SN351234567897\",\n \"SN351234567898\",\n \"SN351234567899\",\n \"SN351234567900\",\n \"SN351234567901\",\n \"SN351234567902\",\n \"SN351234567903\",\n \"SN351234567904\",\n \"SN351234567905\"\n ]\n }\n },\n {\n \"clientReference\": \"IT2\",\n \"product\": \"12312312\",\n \"expectedQuantity\": 10,\n \"receivedQuantity\": 5,\n \"receivedBatch\": \"B\",\n \"receivedBatchExpiry\": \"2024-02-14\",\n \"condition\": \"GOOD\",\n \"identifiers\": {\n \"IMEI\": [\n \"9876543217\",\n \"9876543218\",\n \"9876543219\",\n \"9876543220\",\n \"9876543221\"\n ],\n \"SERIAL_NUMBERS\":[\n \"SN451234567896\",\n \"SN451234567897\",\n \"SN41234567898\",\n \"SN351234567899\",\n \"SN351234567900\"\n ]\n }\n }\n ],\n \"deliveryIssues\": [\n {\n \"reportReference\": \"DEL-001\",\n \"type\": \"MISSING_OR_INCORRECT_PAPERWORK\",\n \"description\": \"Delivery note missing for second pallet\"\n }\n ],\n \"logisticsUnitIssues\": [],\n \"stockIssues\": [\n {\n \"reportReference\": \"STK-001\",\n \"type\": \"DAMAGED_GOODS\",\n \"description\": \"One unit damaged during transport\",\n \"productId\": \"87654321\",\n \"clientReference\": \"IT2\",\n \"quantity\": 1,\n \"batchNumber\": \"B\",\n \"batchExpiry\": \"2024-04-10\"\n }\n ],\n \"receivedLogisticsUnits\": [\n {\n \"reference\": \"SSCC1234502\",\n \"products\": [],\n \"logisticsUnits\": [\n {\n \"reference\": \"SSCC2345602\",\n \"products\": [\n {\n \"clientReference\": \"IT1\",\n \"product\": \"12345678\",\n \"quantity\": 10\n }\n ],\n \"logisticsUnits\": [],\n \"logisticUnitType\": \"CARTON\"\n }\n ],\n \"logisticUnitType\": \"PALLET\"\n },\n {\n \"reference\": \"SSCC1234501\",\n \"products\": [],\n \"logisticsUnits\": [\n {\n \"reference\": \"SSCC2345601\",\n \"products\": [\n {\n \"clientReference\": \"IT2\",\n \"product\": \"12312312\",\n \"quantity\": 10\n }\n ],\n \"logisticsUnits\": [],\n \"logisticUnitType\": \"CARTON\"\n }\n ],\n \"logisticUnitType\": \"PALLET\"\n }\n ],\n \"unidentifiedStockIssues\": [],\n \"receiptReferences\": [\"G1747406648723683-12345678-1740463200000\", \"G1747406648723683-87654321-1740468600000\"],\n \"createdAt\": \"2025-03-25T10:00:00Z\"\n}"}],"_postman_id":"828931b7-1c15-458d-9cb3-a7a007f5a07f"}],"id":"6f83dc4e-f8ab-4b0a-8901-55d6c9e1356c","description":"

Creating an ASN (Advanced Shipment Notification)

The ASN informs the facility of the exact inventory being inbounded and works with the Pre-Advice to ensure a smooth inbounding process. When you are ready to ship inventory, create an ASN including:

The product reference (from product creation).
\n
The delivery booking reference (from the approved Pre-Advice).
\n

Arrival at the Facility

The delivery booking reference is used for vehicle site access and must also be clearly labelled on pallets or cartons to link the delivery to the ASN. Upon receipt, stock is checked, counted, and stowed, with any discrepancies recorded.

\n","_postman_id":"6f83dc4e-f8ab-4b0a-8901-55d6c9e1356c"}],"id":"8f892729-6ddc-46b0-a19d-eeebea3bcb04","_postman_id":"8f892729-6ddc-46b0-a19d-eeebea3bcb04","description":""},{"name":"Product","item":[{"name":"create Product","id":"ca8fea5f-5984-43d3-9187-8b16c4e5ba53","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"organisation","value":"","description":"

(Required)

\n"},{"key":"X-THG-Client","value":"","description":"

(Required)

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"id\": \"MY1234567\",\n \"core\": {\n \"title\": \"My Product\",\n \"type\": {\n \"name\": \"Shorts\"\n },\n \"barcodes\": {\n \"ean\": [\n \"5001234567890\"\n ]\n },\n \"releaseDate\": \"2027-01-01\",\n \"pricing\": {\n \"gbpRRP\": 19.99\n },\n \"stockManagementCategory\": {\n \"name\": \"ACME Co.\"\n },\n \"merchandisingStatus\": {\n \"name\": \"ACME Co. - Active\"\n }\n },\n \"warehouseInfo\": {\n \"dimensions\": {\n \"length\": 99,\n \"width\": 40,\n \"height\": 10,\n \"weight\": 200\n },\n \"riskLevel\": 0,\n \"liquid\": false,\n \"expiryRequired\": false,\n \"batchRequired\": false,\n \"fifoRotation\": false,\n \"qualityAssuranceRequired\": false,\n \"scanSerialNumberRequired\": true,\n \"identifiers\": [\n {\n \"identifierType\": \"IMEI\",\n \"identifierRegEx\": \"^IMEI[A-Z0-9]{15}$\"\n }\n ]\n },\n \"compliance\": {\n \"hazmat\": {\n \"free\": true\n },\n \"hscodes\": {\n \"heading\": \"810034\",\n \"suffixes\": {\n \"US\": \"3000\"\n }\n },\n \"countryOfOrigin\": \"CN\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"/v1/products","description":"

This endpoint creates a product with the provided details. If the product is successfully created, a HTTP 200 is returned along with the created THG Product ID.

For productType, stockManagementCategory, and merchandisingStatus within CoreProduct at least one of id or name must be provided, but both are not required.

Request

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`id`	string maxlength: 20	Y	The client's unique identifier for the product.
`core`	CoreProduct	Y	Core product details.
`warehouseInfo`	WarehouseInfo	Y	Product information pertinent to the warehouse.
`compliance`	ComplianceData	Y	Product compliance details.

CoreProduct

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`title`	string	Y	Product title.
`type`	ProductType	Y	Product type.
`barcodes`	Barcodes	Y	List of barcodes for this product.
`releaseDate`	string	Y	Product release date. If Product is available immediately, any date in the past should be provided. (format: YYYY-MM-DD)
`pricing`	Pricing	Y	Product pricing information
`stockManagementCategory`	StockManagementCategory	Y	Value to be used will be given to you during onboarding.
`merchandisingStatus`	MerchandisingStatus	Y	Value to be used will be given to you during onboarding.

ProductType

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`id`	integer	Y	Product Type ID - either this or `name` must be provided.
`name`	string	Y	Product Type Name - either this or `id` must be provided.

Barcodes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`ean`	Array of string minLength: 8 maxlength: 13	N	EAN-type barcodes.
`upc`	Array of string minLength: 6 maxlength: 12	N	UPC-type barcodes.
`other`	Array of string	N	Alpha-numeric barcode of legnth 8 characters.
`unclassified`	Array of string	N	Any type or length of barcode. This is not validated.

Pricing

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`gbpRRP`	number	Y	Recommended Retail Price of the product in GBP.

StockManagementCategory

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`id`	integer	Y	Stock Management Category ID - either this or `name` must be provided.
`name`	string	Y	Stock Management Category Name - either this or `id` must be provided.

MerchandisingStatus

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`id`	integer	Y	Merchandising Status ID - either this or `name` must be provided.
`name`	string	Y	Merchandising Status Name - either this or `id` must be provided.

WarehouseInfo

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`dimensions`	Dimensions	Y	Physical dimensions of the product.
`riskLevel`	integer	Y	The risk of product theft due to value or convenience. Specify 0 (zero) unless otherwise agreed with the THG Ingenuity team.
`liquid`	boolean	Y	Is the product a liquid?
`expiryRequired`	boolean	Y	Does the product require expiry data capture?
`batchRequired`	boolean	Y	Does the product require batch/lot information to be captured?
`fifoRotation`	boolean	Y
`qualityAssuranceRequired`	boolean	Y	Does the product have additional requirements when being inbounded to a facility?
`scanSerialNumberRequired`	boolean	Y	Does the product require a serial number to be scanned at Pack?
`identifiers`	Array of Identifiers	N	An array of Identifiers and regular expressions used for unit-level tracking in the warehouse. `scanSerialNumberRequired` must be set to `false` for this field to be used. Use of this field must be agreed with the THGi team - omit or set to `null` if not approved to use this.

Identifiers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`identifierType`	string	Y	Type of identifier e.g. `IMEI`, `SERIAL_NUMBER`.
`identifierRegEx`	integer	Y	The regular expression pattern for validating the identifier e.g. `^IMEI[A-Z0-9]{15}$`.

Dimensions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`length`	integer	Y	Product length in mm.
`width`	integer	Y	Product width in mm.
`height`	integer	Y	Product height in mm.
`weight`	integer	Y	Product weight in grams.

ComplianceData

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`hazmat`	Hazmat or HazmatFree	Y	If the product is contains hazardous material, use the Hazmat object, if it doesn't use the HazmatFree object.
`hscodes`	HSCodes	Y
`countryOfOrigin`	string minLength: 2 maxLength: 2	Y	Country of Origin of the product in ISO 3166-1 alpha-2 code.

Hazmat

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`unClass`	string	N	UN Class of Hazmat.

HazmatFree

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`free`	boolean	Y	When HazmatFree is used, set the value to `true`, e.g. `\"free\": true`

HSCodes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`heading`	string	Y	This must be 6 digits long at the most. Where the first two digits represent the chapter, second two digits are for the heading, and final two digits are the subheading.
`suffixes`	Map of Suffixes (string:string)	Y	An array of country-specific suffixes e.g. `{ \"US\": \"3000\", \"GB\": \"3001\" }`

Response

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`id`	string	The client's unique identifier for the product.
`thgId`	integer	THG's Product ID
`core`	CoreProduct	Core product details.
`warehouseInfo`	WarehouseInfo	Product information pertinent to the warehouse.
`compliance`	ComplianceData	Product compliance details.

","urlObject":{"path":["v1","products"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"9b2a3609-ce40-4d14-a43d-ba107abff003","name":"201 Created","originalRequest":{"method":"POST","header":[{"key":"organisation","value":"","description":"(Required) "},{"key":"X-THG-Client","value":"","description":"(Required) "}],"body":{"mode":"raw","raw":"{\n \"id\": \"MY1234567\",\n \"core\": {\n \"title\": \"My Product\",\n \"type\": {\n \"name\": \"Shorts\"\n },\n \"barcodes\": {\n \"ean\": [\n \"5001234567890\"\n ]\n },\n \"releaseDate\": \"2027-01-01\",\n \"pricing\": {\n \"gbpRRP\": 19.99\n },\n \"stockManagementCategory\": {\n \"name\": \"ACME Co.\"\n },\n \"merchandisingStatus\": {\n \"name\": \"ACME Co. - Active\"\n }\n },\n \"warehouseInfo\": {\n \"dimensions\": {\n \"length\": 99,\n \"width\": 40,\n \"height\": 10,\n \"weight\": 200\n },\n \"riskLevel\": 0,\n \"liquid\": false,\n \"expiryRequired\": false,\n \"batchRequired\": false,\n \"fifoRotation\": false,\n \"qualityAssuranceRequired\": false,\n \"scanSerialNumberRequired\": true,\n \"identifiers\": [\n {\n \"identifierType\": \"SERIAL_NUMBER\",\n \"identifierRegEx\": \"^[a-zA-Z0-9]{14}$\"\n }\n ]\n },\n \"compliance\": {\n \"hazmat\": {\n \"free\": true\n },\n \"hscodes\": {\n \"heading\": \"810034\",\n \"suffixes\": {\n \"US\": \"3000\"\n }\n },\n \"countryOfOrigin\": \"CN\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/products"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"MY1234567\",\n \"thgId\": 12345678,\n \"core\": {\n \"title\": \"My Product\",\n \"type\": {\n \"name\": \"Shorts\"\n },\n \"barcodes\": {\n \"ean\": [\n \"5001234567890\"\n ]\n },\n \"releaseDate\": \"2027-01-01\",\n \"pricing\": {\n \"gbpRRP\": 19.99\n },\n \"stockManagementCategory\": {\n \"name\": \"ACME Co.\"\n },\n \"merchandisingStatus\": {\n \"name\": \"ACME Co. - Active\"\n }\n },\n \"warehouseInfo\": {\n \"dimensions\": {\n \"length\": 99,\n \"width\": 40,\n \"height\": 10,\n \"weight\": 200\n },\n \"riskLevel\": 0,\n \"liquid\": false,\n \"expiryRequired\": false,\n \"batchRequired\": false,\n \"fifoRotation\": false,\n \"qualityAssuranceRequired\": false,\n \"scanSerialNumberRequired\": true,\n \"identifiers\": [\n {\n \"identifierType\": \"SERIAL_NUMBER\",\n \"identifierRegEx\": \"^[a-zA-Z0-9]{14}$\"\n }\n ]\n },\n \"compliance\": {\n \"hazmat\": {\n \"free\": true\n },\n \"hscodes\": {\n \"heading\": \"810034\",\n \"suffixes\": {\n \"US\": \"3000\"\n }\n },\n \"countryOfOrigin\": \"CN\"\n }\n}"},{"id":"cdd311f4-ce4c-462c-9cea-f023ceda50a9","name":"400 Duplicate Product","originalRequest":{"method":"POST","header":[{"key":"organisation","value":"","description":"(Required) "},{"key":"X-THG-Client","value":"","description":"(Required) "}],"body":{"mode":"raw","raw":"{\n \"id\": \"MY1234567\",\n \"core\": {\n \"title\": \"My Product\",\n \"type\": {\n \"name\": \"Shorts\"\n },\n \"barcodes\": {\n \"ean\": [\n \"5001234567890\"\n ]\n },\n \"releaseDate\": \"2027-01-01\",\n \"pricing\": {\n \"gbpRRP\": 19.99\n },\n \"stockManagementCategory\": {\n \"name\": \"ACME Co.\"\n },\n \"merchandisingStatus\": {\n \"name\": \"ACME Co. - Active\"\n }\n },\n \"warehouseInfo\": {\n \"dimensions\": {\n \"length\": 99,\n \"width\": 40,\n \"height\": 10,\n \"weight\": 200\n },\n \"riskLevel\": 0,\n \"liquid\": false,\n \"expiryRequired\": false,\n \"batchRequired\": false,\n \"fifoRotation\": false,\n \"qualityAssuranceRequired\": false,\n \"scanSerialNumberRequired\": false\n },\n \"compliance\": {\n \"hazmat\": {\n \"free\": true\n },\n \"hscodes\": {\n \"heading\": \"810034\",\n \"suffixes\": {\n \"US\": \"3000\"\n }\n },\n \"countryOfOrigin\": \"CN\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"{{baseUrl}}/v1/products"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"timeStamp\": \"2025-12-12T13:20:14Z\",\n \"status\": \"BAD_REQUEST\",\n \"message\": \"Validation errors found in creation payload\",\n \"errors\": [\n \"External Product ID 55397578244473 is already in use for organisation thg-ingenuity\"\n ]\n}"}],"_postman_id":"ca8fea5f-5984-43d3-9187-8b16c4e5ba53"},{"name":"update Product","id":"0e458b41-275c-4987-a7e8-e9c3093a6d19","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"organisation","value":"","description":"

(Required)

\n"},{"key":"X-THG-Client","value":"","description":"

(Required)

\n"},{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"core\": {\n \"title\": \"My Product\",\n \"type\": {\n \"name\": \"Shorts\"\n },\n \"barcodes\": {\n \"ean\": [\n \"5001234567890\"\n ]\n },\n \"releaseDate\": \"2027-01-01\",\n \"pricing\": {\n \"gbpRRP\": 19.99\n },\n \"stockManagementCategory\": {\n \"name\": \"ACME Co.\"\n },\n \"merchandisingStatus\": {\n \"name\": \"ACME Co. - Active\"\n }\n },\n \"warehouseInfo\": {\n \"dimensions\": {\n \"length\": 99,\n \"width\": 40,\n \"height\": 10,\n \"weight\": 200\n },\n \"riskLevel\": 0,\n \"liquid\": false,\n \"expiryRequired\": false,\n \"batchRequired\": false,\n \"fifoRotation\": false,\n \"qualityAssuranceRequired\": false,\n \"scanSerialNumberRequired\": true,\n \"identifiers\": [\n {\n \"identifierType\": \"SERIAL_NUMBER\",\n \"identifierRegEx\": \"^[a-zA-Z0-9]{14}$\"\n }\n ]\n },\n \"compliance\": {\n \"hazmat\": {\n \"free\": true\n },\n \"hscodes\": {\n \"heading\": \"810034\",\n \"suffixes\": {\n \"US\": \"3000\"\n }\n },\n \"countryOfOrigin\": \"CN\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"/v1/products/{{id}}","description":"

This endpoint accepts the client's unique identifier for the Product as a request parameter and takes the body of the request as an update to the Product data. If successful, a HTTP 200 is returned.

Request

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`id`	string	The client's unique identifier for the product (as `id` in the Product body)

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`core`	CoreProduct	Y	Core product details.
`warehouseInfo`	WarehouseInfo	Y	Product information pertinent to the warehouse.
`compliance`	ComplianceData	Y	Product compliance details.

CoreProduct

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`title`	string	Y	Product title.
`type`	ProductType	Y	Product type.
`barcodes`	Barcodes	Y	List of barcodes for this product.
`releaseDate`	string	Y	Product release date (format: YYYY-MM-DD)
`pricing`	Pricing	Y	Product pricing information
`stockManagementCategory`	StockManagementCategory	Y
`merchandisingStatus`	MerchandisingStatus	Y

ProductType

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`id`	integer	Y	Product Type ID - either this or `name` must be provided.
`name`	string	Y	Product Type Name - either this or `id` must be provided.

Barcodes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`ean`	Array of string minLength: 8 maxlength: 13	N	EAN-type barcodes.
`upc`	Array of string minLength: 6 maxlength: 12	N	UPC-type barcodes.
`other`	Array of string	N	Alpha-numeric barcode of legnth 8 characters.
`unclassified`	Array of string	N	Any type or length of barcode. This is not validated.

Pricing

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`gbpRRP`	number	Y	Recommended Retail Price of the product in GBP.

StockManagementCategory

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`id`	integer	Y	Stock Management Category ID - either this or `name` must be provided.
`name`	string	Y	Stock Management Category Name - either this or `id` must be provided.

MerchandisingStatus

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`id`	integer	Y	Merchandising Status ID - either this or `name` must be provided.
`name`	string	Y	Merchandising Status Name - either this or `id` must be provided.

WarehouseInfo

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`dimensions`	Dimensions	Y	Physical dimensions of the product.
`riskLevel`	integer	Y
`liquid`	boolean	Y	Is the product a liquid?
`expiryRequired`	boolean	Y	Does the product require expiry data capture?
`batchRequired`	boolean	Y	Does the product require batch/lot information to be captured?
`fifoRotation`	boolean	Y
`qualityAssuranceRequired`	boolean	Y
`scanSerialNumberRequired`	boolean	Y	Does the product require a serial number to be scanned at Pack?
`identifiers`	Array of Identifiers	N	An array of Identifiers and regular expressions used for unit-level tracking in the warehouse. `scanSerialNumberRequired` must be set to `false` for this field to be used. Use of this field must be agreed with the THGi team - omit or set to `null` if not approved to use this. This cannot be modified after product creation. During product update, omit, leave `null` or set to the existing value.

Identifiers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`identifierType`	string	Type of identifier e.g. `IMEI`, `SERIAL_NUMBER`.
`identifierRegEx`	integer	The regular expression pattern for validating the identifier e.g. `^IMEI[A-Z0-9]{15}$`.

Dimensions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`length`	integer	Y	Product length in mm.
`width`	integer	Y	Product width in mm.
`height`	integer	Y	Product height in mm.
`weight`	integer	Y	Product weight in grams.

ComplianceData

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`hazmat`	Hazmat or HazmatFree	Y	If the product is contains hazardous material, use the Hazmat object, if it doesn't use the HazmatFree object.
`hscodes`	HSCodes	Y
`countryOfOrigin`	string minLength: 2 maxLength: 2	Y	Country of Origin of the product in ISO 3166-1 alpha-2 code.

Hazmat

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`unClass`	string	N	UN Class of Hazmat.

HazmatFree

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`free`	boolean	Y	When HazmatFree is used, set the value to `true`, e.g. `\"free\": true`

HSCodes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`heading`	string	Y	This must be 6 digits long at the most. Where the first two digits represent the chapter, second two digits are for the heading, and final two digits are the subheading.
`suffixes`	Map of Sufixes (string:string)	Y	An array of country-specific suffixes e.g. `{ \"US\": \"3000\", \"GB\": \"3001\" }`

","urlObject":{"path":["v1","products","{{id}}"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"1ef333fa-4857-4b65-ba6f-84875817ede2","name":"200 OK","originalRequest":{"method":"PUT","header":[{"key":"organisation","value":"","description":"(Required) "},{"key":"X-THG-Client","value":"","description":"(Required) "}],"body":{"mode":"raw","raw":"{\n \"core\": {\n \"title\": \"My Product\",\n \"type\": {\n \"name\": \"Shorts\"\n },\n \"barcodes\": {\n \"ean\": [\n \"5001234567890\"\n ]\n },\n \"releaseDate\": \"2027-01-01\",\n \"pricing\": {\n \"gbpRRP\": 19.99\n },\n \"stockManagementCategory\": {\n \"name\": \"ACME Co.\"\n },\n \"merchandisingStatus\": {\n \"name\": \"ACME Co. - Active\"\n }\n },\n \"warehouseInfo\": {\n \"dimensions\": {\n \"length\": 99,\n \"width\": 40,\n \"height\": 10,\n \"weight\": 200\n },\n \"riskLevel\": 0,\n \"liquid\": false,\n \"expiryRequired\": false,\n \"batchRequired\": false,\n \"fifoRotation\": false,\n \"qualityAssuranceRequired\": false,\n \"scanSerialNumberRequired\": false\n },\n \"compliance\": {\n \"hazmat\": {\n \"free\": true\n },\n \"hscodes\": {\n \"heading\": \"810034\",\n \"suffixes\": {\n \"US\": \"3000\"\n }\n },\n \"countryOfOrigin\": \"CN\"\n }\n}","options":{"raw":{"language":"json"}}},"url":"/v1/products/{{id}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"MY1234567\",\n \"thgId\": 12345678,\n \"core\": {\n \"title\": \"My Product\",\n \"type\": {\n \"name\": \"Shorts\"\n },\n \"barcodes\": {\n \"ean\": [\n \"5001234567890\"\n ]\n },\n \"releaseDate\": \"2027-01-01\",\n \"pricing\": {\n \"gbpRRP\": 19.99\n },\n \"stockManagementCategory\": {\n \"name\": \"ACME Co.\"\n },\n \"merchandisingStatus\": {\n \"name\": \"ACME Co. - Active\"\n }\n },\n \"warehouseInfo\": {\n \"dimensions\": {\n \"length\": 99,\n \"width\": 40,\n \"height\": 10,\n \"weight\": 200\n },\n \"riskLevel\": 0,\n \"liquid\": false,\n \"expiryRequired\": false,\n \"batchRequired\": false,\n \"fifoRotation\": false,\n \"qualityAssuranceRequired\": false,\n \"scanSerialNumberRequired\": true,\n \"identifiers\": [\n {\n \"identifierType\": \"SERIAL_NUMBER\",\n \"identifierRegEx\": \"^[a-zA-Z0-9]{14}$\"\n }\n ]\n },\n \"compliance\": {\n \"hazmat\": {\n \"free\": true\n },\n \"hscodes\": {\n \"heading\": \"810034\",\n \"suffixes\": {\n \"US\": \"3000\"\n }\n },\n \"countryOfOrigin\": \"CN\"\n }\n}"}],"_postman_id":"0e458b41-275c-4987-a7e8-e9c3093a6d19"},{"name":"get Product","id":"d3e3274a-a86f-4bf2-940d-c5a273b51f1c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-THG-Client","value":"","description":"

(Required)

\n"},{"key":"organisation","value":"","description":"

(Required)

\n"},{"key":"Accept","value":"*/*"}],"url":"/v1/products/{{id}}","description":"

This endpoint accepts the client's unique identifier for the Product as a request parameter and returns the Product details in the response if a Product with the given client identifier is found.

Request

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`id`	string	The client's unique identifier for the product (as `id` in the Product body)

Response

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`id`	string	The client's unique identifier for the product.
`thgId`	integer	THG's Product ID
`core`	CoreProduct	Core product details.
`warehouseInfo`	WarehouseInfo	Product information pertinent to the warehouse.
`compliance`	ComplianceData	Product compliance details.

CoreProduct

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`title`	string	Product title.
`type`	ProductType	Product type.
`barcodes`	Barcodes	List of barcodes for this product.
`releaseDate`	string	Product release date (format: YYYY-MM-DD)
`pricing`	Pricing	Product pricing information
`stockManagementCategory`	StockManagementCategory
`merchandisingStatus`	MerchandisingStatus

ProductType

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`id`	integer	Product Type ID - either this or `name` must be provided.
`name`	string	Product Type Name - either this or `id` must be provided.

Barcodes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`ean`	Array of string minLength: 8 maxlength: 13	EAN-type barcodes.
`upc`	Array of string minLength: 6 maxlength: 12	UPC-type barcodes.
`other`	Array of string	Alpha-numeric barcode of legnth 8 characters.
`unclassified`	Array of string	Any type or length of barcode. This is not validated.

Pricing

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`gbpRRP`	number	Recommended Retail Price of the product in GBP.

StockManagementCategory

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`id`	integer	Stock Management Category ID - either this or `name` must be provided.
`name`	string	Stock Management Category Name - either this or `id` must be provided.

MerchandisingStatus

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`id`	integer	Merchandising Status ID - either this or `name` must be provided.
`name`	string	Merchandising Status Name - either this or `id` must be provided.

WarehouseInfo

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`dimensions`	Dimensions	Physical dimensions of the product.
`riskLevel`	integer
`liquid`	boolean	Is the product a liquid?
`expiryRequired`	boolean	Does the product require expiry data capture?
`batchRequired`	boolean	Does the product require batch/lot information to be captured?
`fifoRotation`	boolean
`qualityAssuranceRequired`	boolean
`scanSerialNumberRequired`	boolean	Does the product require a serial number to be scanned at Pack?
`identifiers`	Array of Identifiers	An array of Identifiers and regular expressions used for unit-level tracking in the warehouse. `scanSerialNumberRequired` must be set to `false` for this field to be used. Use of this field must be agreed with the THGi team.

Identifiers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`identifierType`	string	Type of identifier e.g. `IMEI`, `SERIAL_NUMBER`.
`identifierRegEx`	integer	The regular expression pattern for validating the identifier e.g. `^IMEI[A-Z0-9]{15}$`.

Dimensions

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`length`	integer	Product length in mm.
`width`	integer	Product width in mm.
`height`	integer	Product height in mm.
`weight`	integer	Product weight in grams.

ComplianceData

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`hazmat`	Hazmat or HazmatFree	If the product is contains hazardous material, use the Hazmat object, if it doesn't use the HazmatFree object.
`hscodes`	HSCodes
`countryOfOrigin`	string minLength: 2 maxLength: 2	Country of Origin of the product in ISO 3166-1 alpha-2 code.

Hazmat

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`unClass`	string	UN Class of Hazmat.

HazmatFree

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`free`	boolean	When HazmatFree is used, set the value to `true`, e.g. `\"free\": true`

HSCodes

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`heading`	string	6 digits long at the most. Where the first two digits represent the chapter, second two digits are for the heading, and final two digits are the subheading.
`suffixes`	Map of Sufixes (string:string)	An array of country-specific suffixes e.g. `{ \"US\": \"3000\", \"GB\": \"3001\" }`

","urlObject":{"path":["v1","products","{{id}}"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"33aae096-60c1-406f-95a3-9b56c9d9fb6d","name":"OK","originalRequest":{"method":"GET","header":[{"key":"X-THG-Client","value":"","description":"(Required) "},{"key":"organisation","value":"","description":"(Required) "},{"key":"Accept","value":"*/*"}],"url":"/v1/product/{{productId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"id\": \"MY1234567\",\n \"thgId\": 12345678,\n \"core\": {\n \"title\": \"My Product\",\n \"type\": {\n \"name\": \"Shorts\"\n },\n \"barcodes\": {\n \"ean\": [\n \"5001234567890\"\n ]\n },\n \"releaseDate\": \"2027-01-01\",\n \"pricing\": {\n \"gbpRRP\": 19.99\n },\n \"stockManagementCategory\": {\n \"name\": \"ACME Co.\"\n },\n \"merchandisingStatus\": {\n \"name\": \"ACME Co. - Active\"\n }\n },\n \"warehouseInfo\": {\n \"dimensions\": {\n \"length\": 99,\n \"width\": 40,\n \"height\": 10,\n \"weight\": 200\n },\n \"riskLevel\": 0,\n \"liquid\": false,\n \"expiryRequired\": false,\n \"batchRequired\": false,\n \"fifoRotation\": false,\n \"qualityAssuranceRequired\": false,\n \"scanSerialNumberRequired\": true,\n \"identifiers\": [\n {\n \"identifierType\": \"SERIAL_NUMBER\",\n \"identifierRegEx\": \"^[a-zA-Z0-9]{14}$\"\n }\n ]\n },\n \"compliance\": {\n \"hazmat\": {\n \"free\": true\n },\n \"hscodes\": {\n \"heading\": \"810034\",\n \"suffixes\": {\n \"US\": \"3000\"\n }\n },\n \"countryOfOrigin\": \"CN\"\n }\n}"}],"_postman_id":"d3e3274a-a86f-4bf2-940d-c5a273b51f1c"},{"name":"get All Product IDs","id":"f11a9f49-9fad-4f87-9e42-9d7ac975a8e3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-THG-Client","value":"","description":"

(Required)

\n"},{"key":"organisation","value":"","description":"

(Required)

\n"},{"key":"Accept","value":"*/*"}],"url":"/v1/products","description":"

This endpoint returns the id (client product reference) and thgid (THG product identifier) for all products for the calling organisation in a paginated response.

Request

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Mandatory	Description
`page`	integer	N	The page number to return, zero-based. Default is 0.
`size`	integer	N	The number of products to return per page. Maximum is 4000, default if not specified is 4000.

Response

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`id`	string	The client's unique identifier for the product.
`thgId`	integer	THG's Product ID.

","urlObject":{"path":["v1","products"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"b11a1c6f-2076-4b57-a135-07a4c3321a7f","name":"200 Success Default Pagination","originalRequest":{"method":"GET","header":[{"key":"X-THG-Client","value":"","description":"(Required) "},{"key":"organisation","value":"","description":"(Required) "},{"key":"Accept","value":"*/*"}],"url":"/v1/products"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"MY1234567\",\n \"thgId\": 12345678\n },\n {\n \"id\": \"MY7654321\",\n \"thgId\": 87654321\n }\n]"},{"id":"3111fea3-b5af-49bb-8071-48cff250407c","name":"200 Success Specified Page and Size","originalRequest":{"method":"GET","header":[{"key":"X-THG-Client","value":"","description":"(Required) "},{"key":"organisation","value":"","description":"(Required) "},{"key":"Accept","value":"*/*"}],"url":{"raw":"/v1/products?page=0&size=25","host":[""],"path":["v1","products"],"query":[{"key":"page","value":"0"},{"key":"size","value":"25"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"id\": \"MY1234567\",\n \"thgId\": 12345678\n },\n {\n \"id\": \"MY7654321\",\n \"thgId\": 87654321\n }\n]"}],"_postman_id":"f11a9f49-9fad-4f87-9e42-9d7ac975a8e3"},{"name":"get THG Product ID","id":"b0436863-9dfc-4439-94d0-aeadca22437b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"X-THG-Client","value":"","description":"

(Required)

\n"},{"key":"organisation","value":"","description":"

(Required)

\n"},{"key":"Accept","value":"*/*"}],"url":"/v1/products/{{id}}/mapping","description":"

This endpoint accepts the client's unique identifier for the Product as a request parameter and, if a product is found with that identifier, returns an object containing the THG Product ID.

Request

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`id`	string	The client's unique identifier for the product.

Response

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`thgId`	integer	THG's Product ID.

","urlObject":{"path":["v1","products","{{id}}","mapping"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"d31a82fb-91c4-4736-b8e7-b0ba4b3cdc83","name":"OK","originalRequest":{"method":"GET","header":[{"key":"X-THG-Client","value":"","description":"(Required) "},{"key":"organisation","value":"","description":"(Required) "},{"key":"Accept","value":"*/*"}],"url":"/v1/products/{{id}}/mapping"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"thgId\": 123456789\n}"}],"_postman_id":"b0436863-9dfc-4439-94d0-aeadca22437b"},{"name":"get Multiple THG Product IDs","id":"a705f25a-80ff-40a3-9a53-b43a0ed69be5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-THG-Client","value":"","description":"

(Required)

\n"},{"key":"organisation","value":"","description":"

(Required)

\n"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"[\n \"MY1234567\", \n \"MY1122334\"\n]","options":{"raw":{"language":"json"}}},"url":"/v1/products/mappings","description":"

This endpoint accepts a request body containing an array of client's unique identifiers and responds with an object containing the THG Product ID mappings. Those mappings which are found are contained in a map named matched and those not found have the client's reference contained in an array named missing.

Request

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`items`	Array of strings	Y	An array of client product references.

Response

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`matched`	Map of `clientReference` and `thgId`	The found THG product IDs.
`missing`	Array of strings	The client product references for which products were not found.

","urlObject":{"path":["v1","products","mappings"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"e1462612-30f5-4adb-919f-f0af04735de9","name":"OK","originalRequest":{"method":"POST","header":[{"key":"X-THG-Client","value":"","description":"(Required) "},{"key":"organisation","value":"","description":"(Required) "},{"key":"Accept","value":"*/*"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n \"MY1234567\", \n \"MY1122334\"\n]","options":{"raw":{"language":"json"}}},"url":"/v1/products/mappings"},"status":"OK Matched & Missing","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"matched\": {\n \"MY1234567\": 123456789\n },\n \"missing\": [\n \"MY1122334\"\n ]\n}"}],"_postman_id":"a705f25a-80ff-40a3-9a53-b43a0ed69be5"},{"name":"get Multiple Client or THG ID Mappings","id":"c4f2eb52-1bca-496b-bd36-934b73e57849","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"X-THG-Client","value":"","description":"

(Required)

\n"},{"key":"organisation","value":"","description":"

(Required)

\n"},{"key":"Accept","value":"*/*"}],"body":{"mode":"raw","raw":"{\n \"thgIds\": [\n 12345\n ],\n \"clientIds\": [\n \"MY12345\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v1/products/idmaps","description":"

This endpoint accepts a request body containing an array of client's unique identifiers and THG product IDs, and responds with an object containing the THG product ID and client ID mappings. Those mappings which are found are contained in a map named matched and those not found have the search ID contained in an array named missing.

Request

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`thgIds`	Array of integers	Y	An array of THG product IDs to search for. The array must be included in the request and at least one entry must be included (e.g. provide the array as `[ 0 ]` if no search items are provided.
`clientIds`	Array of strings	Y	An array of client product references to search for. The array must be included in the request and at least one entry must be included (e.g. provide the array as `[ \"\" ]` if no search items are provided.

Response

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`clientIdThgIdMappings`	Object	Results of the search for mappings of `clientIds`.
- `matched`	Map of `clientId` and `thgId`	The matched client IDs and their THG product IDs.
- `missing`	Array of strings	The client IDs for which products were not found.
`thgIdClientIdMappings`	Object	Results from the search for mappings of `thgIds`.
- `matched`	Map of `thgId` and `clientId`	The matched THG product IDs and their client IDs.
- `missing`	Array of integers	The THG product IDs for which products were not found.

","urlObject":{"path":["v1","products","idmaps"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"06677a76-3852-44cf-b8e5-97a70bb5b351","name":"200 OK","originalRequest":{"method":"POST","header":[{"key":"X-THG-Client","value":"","description":"(Required) "},{"key":"organisation","value":"","description":"(Required) "},{"key":"Accept","value":"*/*"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"thgIds\": [\n 12345,\n 54321\n ],\n \"clientIds\": [\n \"MY12345\",\n \"MY54321\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v1/products/mappings"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"clientIdThgIdMappings\": {\n \"matched\": {\n \"MY12345\": 12345\n },\n \"missing\": [\n \"MY54321\"\n ]\n },\n \"thgIdClientIdMappings\": {\n \"matched\": {\n \"12345\": \"MY12345\"\n },\n \"missing\": [\n 54321\n ]\n }\n}"},{"id":"87647786-73df-4d4e-ad35-a8e87b887010","name":"400 Incomplete Request","originalRequest":{"method":"POST","header":[{"key":"X-THG-Client","value":"","description":"(Required) "},{"key":"organisation","value":"","description":"(Required) "},{"key":"Accept","value":"*/*"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"thgIds\": [ ],\n \"clientIds\": []\n}","options":{"raw":{"language":"json"}}},"url":"/v1/products/mappings"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"timeStamp\": \"01-01-2025 06:49:42\",\n \"status\": \"BAD_REQUEST\",\n \"message\": \"At least one of thgIds or clientIds lists is required\",\n \"errors\": [\n \"thgIds is null or empty\",\n \"clientIds is null or empty\"\n ]\n}"},{"id":"12d9d700-7b12-4ff0-a7c8-12e1951830d2","name":"404 Product Not Found","originalRequest":{"method":"POST","header":[{"key":"X-THG-Client","value":"","description":"(Required) "},{"key":"organisation","value":"","description":"(Required) "},{"key":"Accept","value":"*/*"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"thgIds\": [\n 54321\n ],\n \"clientIds\": [\n \"MY54321\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v1/products/mappings"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"timeStamp\": \"01-01-2025 06:49:42\",\n \"status\": \"NOT_FOUND\",\n \"message\": \"Product not found\"\n}"},{"id":"acc1054b-8d8c-4e0a-a029-bca1a4bf2a53","name":"500 Internal Server Error","originalRequest":{"method":"POST","header":[{"key":"X-THG-Client","value":"","description":"(Required) "},{"key":"organisation","value":"","description":"(Required) "},{"key":"Accept","value":"*/*"},{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"{\n \"thgIds\": [\n 12345\n ],\n \"clientIds\": [\n \"MY99999\"\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v1/products/mappings"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"*/*"}],"cookie":[],"responseTime":null,"body":"{\n \"timeStamp\": \"01-01-2025 06:49:42\",\n \"status\": \"INTERNAL_SERVER_ERROR\",\n \"message\": \"Internal server error\"\n}"}],"_postman_id":"c4f2eb52-1bca-496b-bd36-934b73e57849"}],"id":"c2eed939-5aba-401b-affc-27f943864027","description":"

The Product API is a service to create, edit, and retrieve product data.

\n","_postman_id":"c2eed939-5aba-401b-affc-27f943864027"},{"name":"Returns","item":[{"name":"Outbound","item":[{"name":"Returns Status Notification ref: RET.I.07","id":"60824250-8831-45e9-96a5-39dc9775bf59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n \"returnShipmentNumber\": 0,\n \"notes\": \"string\",\n \"orderId\": \"string\",\n \"clientOrderReference\": \"string\",\n \"shippingPrice\": 0.0,\n \"returnSender\": {\n \"senderReferenceNumber\": 0,\n \"returnSenderType\": \"CUSTOMER || COURIER\",\n \"locale\": \"string\",\n \"channel\": \"string\",\n \"countryCode\": \"string\",\n \"labelBarcode\": \"string\",\n \"siteCode\": \"string\"\n },\n \"returnStatus\": \"RECEIVED || CANCELLED || COMPLETED || CONTACTED || CREATED || HELD || IDENTIFIED || MANUAL_RESOLVED || PROCESSED || UNEXPECTED\",\n \"returnWarehouse\": {\n \"returnWarehouseId\": 0,\n \"returnWarehouseName\": \"string\"\n },\n \"processedBy\": 0,\n \"returnLines\": [\n {\n \"skuId\": \"string\",\n \"thgSkuId\": 0,\n \"barcode\": \"string\",\n \"barcodes\": {\n \"EAN\": [\n \"string\"\n ],\n \"UPC\": [\n \"string\"\n ]\n },\n \"productType\": \"REG || DROP || ECOM\",\n \"sellerId\": \"string\",\n \"quantity\": 0,\n \"returnReason\": {\n \"reasonId\": 0,\n \"reasonName\": \"string\",\n \"returnLineState\": \"PRISTINE || DAMAGED || FAULTY || NOT_FOUND || NO_STATE\"\n },\n \"expectedLineNotReceived\": \"boolean\",\n \"processedState\": \"PRISTINE || DAMAGED || FAULTY || NOT_FOUND || NO_STATE\",\n \"identifiers\": [\n {\n \"type\": \"string\",\n \"values\": [\n \"string\"\n ]\n }\n ]\n }\n ],\n \"returnDate\": \"string\",\n \"externalReturnReference\": \"string\",\n \"trackingDetails\": {\n \"trackingNumber\": \"string\",\n \"trackingUrl\": \"string\"\n },\n \"label\": {\n \"mediaType\": \"string\",\n \"base64Label\": \"string\",\n \"base64AdditionalLabel\": \"string\"\n },\n \"courierService\": {\n \"courierName\": \"string\",\n \"courierId\": 0,\n \"serviceName\": \"string\",\n \"serviceId\": 0\n },\n \"createdDate\": \"string\",\n \"expiryDate\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/return-update","description":"

Customer returns that are approved by THG will trigger a call to the warehouse or store to expect the returned shipment. Once triggered, THG will submit a return shipment notification to the 3PL for a specific order number with the specification of the products expected to be returned.

This notification message is submitted by THG on return creation and later again on return completion. However, direct calls to the ‘Create Return Shipment’ endpoint to create a return will not trigger this callback. The endpoint will instead respond with this message synchronously upon call.

The notification message is the full view of the return shipment. This is in the same form as the response from fetching the return shipment via the API.

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
returnShipmentNumber	Integer	Yes	Unique Identifier for a returns shipment
orderId	String	Yes	Unique Identifier for an order
clientOrderReference	String	No	The client order reference
createdDate	String	Yes	Date the return is created, Ex: \"2022-01-20T10:00:00\", UTC Format
expiryDate	String	Yes	Date the return is set to expire, Ex: \"2022-01-20T10:00:00\", UTC Format
notes	String	No	Additional notes on the return
externalReturnReference	String	Yes - if using THG warehouse for returns	External reference to the return - to scan at a THG warehouse to link parcel to a return shipment
returnStatus	String	Yes	The state the return is currently in. See 'Return States' here.

Return Sender

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
senderReferenceNumber	Integer	Yes	Customer reference number
returnSenderType	String	Yes	`CUSTOMER` or `COURIER`
locale	String[5]	No	Order locale - a mix of ISO-3166 country codes and ISO-639 language codes separated by `_`. Examples: `en_GB`, `it_IT`, `de_DE`, `fr_FR`
channel	String	Yes	Order channel
countryCode	String	Yes	Country code

Return Warehouse

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
returnWarehouseId	Integer	Yes	Return warehouse Id
returnWarehouseName	String	No	The name of the return warehouse

Return Lines

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
skuId	String	No	Client Sku Id
thgSkuId	Integer	Yes	Thg Sku Id
barcode	String	Yes	Product Barcode
barcodes	Map (String)	Yes	Map of product barcodes
quantity	Integer	Yes	Quantity expected/returned - updated after return is processed
processedState	String	No	The actual state the item was returned in. This is `null` until the item arrives at the warehouse.
expectedLineNotReceived	Boolean	No	If this return line was expected in the original RMA but was not received. This could be because: - the customer wanted to return product B but did not send product B in; - the customer said they’d return product B in state PRISTINE but sent it in state DAMAGED - this would create a separate processed return line and mark the original as expectedLineNotReceived = true. This is `null` until the return shipment arrives at the warehouse.
returnReason		Yes	Reason of return of product (check all return reason in 'Return')

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"returnShipmentNumber\": {\n      \"type\": \"integer\"\n    },\n    \"createdDate\": {\n      \"type\": \"string\"\n    },\n    \"expiryDate\": {\n      \"type\": \"string\"\n    },\n    \"notes\": {\n      \"type\": \"string\"\n    },\n    \"orderId\": {\n      \"type\": \"string\"\n    },\n    \"externalReturnReference\": {\n      \"type\": \"string\"\n    },\n    \"returnSender\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"channel\": {\n          \"type\": \"string\"\n        },\n        \"countryCode\": {\n          \"type\": \"string\"\n        },\n        \"locale\": {\n          \"type\": \"string\"\n        },\n        \"returnSenderType\": {\n          \"type\": \"string\"\n        },\n        \"senderReferenceNumber\": {\n          \"type\": \"integer\"\n        },\n        \"labelBarcode\": {\n          \"type\": \"string\"\n        }\n      },\n      \"required\": [\n        \"channel\",\n        \"countryCode\",\n        \"locale\",\n        \"returnSenderType\",\n        \"senderReferenceNumber\",\n        \"labelBarcode\"\n      ]\n    },\n    \"returnStatus\": {\n      \"type\": \"string\"\n    },\n    \"returnWarehouse\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"returnWarehouseId\": {\n          \"type\": \"integer\"\n        },\n        \"returnWarehouseName\": {\n          \"type\": \"string\"\n        }\n      },\n      \"required\": [\n        \"returnWarehouseId\",\n        \"returnWarehouseName\"\n      ]\n    },\n    \"returnLines\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"skuId\": {\n              \"type\": \"string\"\n            },\n            \"barcode\": {\n              \"type\": \"string\"\n            },\n            \"barcodes\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"EAN\": {\n                  \"type\": \"array\",\n                  \"items\": [\n                    {\n                      \"type\": \"string\"\n                    }\n                  ]\n                },\n                \"UPC\": {\n                  \"type\": \"array\",\n                  \"items\": [\n                    {\n                      \"type\": \"string\"\n                    }\n                  ]\n                }\n              },\n              \"anyOf\": [\n                {\"required\": [\n                \"EAN\"\n              ]},\n                {\"required\": [\n                \"UPC\"\n              ]}\n              ]\n            },\n            \"productType\": {\n              \"type\": \"string\"\n            },\n            \"sellerId\": {\n              \"type\": \"string\"\n            },\n            \"quantity\": {\n              \"type\": \"integer\"\n            },\n            \"processedState\": {\n              \"type\": \"string\"\n            },\n            \"expectedLineNotReceived\": {\n              \"type\": \"boolean\"\n            },\n            \"returnReason\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"reasonId\": {\n                  \"type\": \"integer\"\n                },\n                \"reasonName\": {\n                  \"type\": \"string\"\n                },\n                \"returnLineState\": {\n                  \"type\": \"string\"\n                }\n              },\n              \"required\": [\n                \"reasonId\",\n                \"reasonName\",\n                \"returnLineState\"\n              ]\n            }\n          },\n          \"required\": [\n            \"skuId\",\n            \"thgSkuId\",\n            \"barcode\",\n            \"barcodes\",\n            \"productType\",\n            \"quantity\",\n            \"processedState\",\n            \"expectedLineNotReceived\",\n            \"returnReason\"\n          ]\n        }\n      ]\n    }\n  },\n  \"required\": [\n    \"returnShipmentNumber\",\n    \"createdDate\",\n    \"expiryDate\",\n    \"notes\",\n    \"orderId\",\n    \"returnSender\",\n    \"returnStatus\",\n    \"returnWarehouse\",\n    \"returnLines\"\n  ]\n}\n\n

\n","urlObject":{"path":["v2","order","return-update"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"d36fcbe4-4230-4021-a39d-e094d1acbb14","name":"Returns Message (Success)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"returnShipmentNumber\": 7401402,\n \"notes\": \"\",\n \"orderId\": \"738693100\",\n \"clientOrderReference\": null,\n \"shippingPrice\": 0.0,\n \"returnSender\": {\n \"senderReferenceNumber\": 183569770,\n \"returnSenderType\": \"CUSTOMER\",\n \"locale\": \"en_GB\",\n \"channel\": \"matalan\",\n \"countryCode\": \"GB\",\n \"labelBarcode\": \"\",\n \"siteCode\": \"MATLN\"\n },\n \"returnStatus\": \"RECEIVED\",\n \"returnWarehouse\": {\n \"returnWarehouseId\": 129,\n \"returnWarehouseName\": \"Matalan Darnley\"\n },\n \"processedBy\": 129,\n \"returnLines\": [\n {\n \"skuId\": \"S3167446_CNB9_Q68\",\n \"thgSkuId\": 17501534,\n \"barcode\": \"3350386000079\",\n \"barcodes\": {\n \"EAN\": [\n \"3350386000079\"\n ],\n \"UPC\": []\n },\n \"productType\": \"REG\",\n \"quantity\": 1,\n \"returnReason\": {\n \"reasonId\": 1,\n \"reasonName\": \"UNWANTED\",\n \"returnLineState\": \"PRISTINE\"\n },\n \"expectedLineNotReceived\": false,\n \"processedState\": \"PRISTINE\",\n \"identifiers\": [\n {\n \"type\": \"IMEI\",\n \"values\": [\n \"1293764932\",\n \"9812674793\"\n ]\n },\n {\n \"type\": \"SERIAL_NO\",\n \"values\": [\n \"12937982367498364932\",\n \"98327984328998079033\"\n ]\n }\n ]\n }\n ],\n \"returnDate\": \"20260204\",\n \"externalReturnReference\": null,\n \"trackingDetails\": {\n \"trackingNumber\": \"123\",\n \"trackingUrl\": \"trackingUrl\"\n },\n \"label\": {\n \"mediaType\": \"application/pdf\",\n \"base64Label\": \"...\",\n \"base64AdditionalLabel\": \"...\"\n },\n \"createdDate\": \"2026-02-04T09:38:36.000000625\",\n \"expiryDate\": \"2026-08-03T09:38:36.000000643\"\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/return-update"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[],"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"60824250-8831-45e9-96a5-39dc9775bf59"}],"id":"de7bf8ef-1b6c-4c8d-be80-11952e14d2a4","_postman_id":"de7bf8ef-1b6c-4c8d-be80-11952e14d2a4","description":""},{"name":"Create Return ref: RET.I.03","id":"fdacd85a-18cd-4459-a2c4-304aa00746fd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n \"orderNumber\": \"string\",\n \"clientOrderReference\": \"string\",\n \"externalReturnReference\": \"string\",\n \"warehouseId\": 0,\n \"returnSender\": {\n \"senderReferenceNumber\": 0,\n \"returnSenderType\": \"CUSTOMER || COURIER\",\n \"locale\": \"string\",\n \"channel\": \"string\",\n \"labelBarcode\": \"string\",\n \"siteCode\": \"string\",\n \"countryCode\": \"string\"\n },\n \"returnLines\": [\n {\n \"productId\": 0,\n \"quantity\": 0,\n \"barcode\": \"string\",\n \"requestedAction\": \"REPLACE || REFUND || NO_ACTION\",\n \"processedAction\": \"REPLACE || REFUND || NO_ACTION\",\n \"processedState\": \"PRISTINE || DAMAGED || FAULTY || NOT_FOUND ||NO_STATE\",\n \"returnReason\": {\n \"reasonName\": \"UNWANTED || OTHERS\"\n },\n \"notes\": \"string\",\n \"action\": \"boolean\",\n \"stock\": \"boolean\",\n \"bundleId\": 0,\n \"alternativeProductId\": 0,\n \"sellerId\": \"string\",\n \"returnProductType\": \"DROP || ECOM || REG\",\n \"miraklReference\": \"string\",\n \"stockOwner\": \"string\",\n \"identifiers\": [\n {\n \"type\": \"string\",\n \"values\": [\n \"string\"\n ]\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/returns","description":"

This endpoint creates a return shipment (RMA/Return). It does not trigger the 'return-create' callback and instead returns this payload synchronously.

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
orderNumber	String	One of `orderNumber` or `clientOrderReference`	THG order number
clientOrderReference	String	One of `orderNumber` or `clientOrderReference`	The client order reference
externalReturnReference	String	Yes - if using THG warehouses for returns processing and if there is a custom reference to scan on the parcel	An external reference to the return. Only needed if the client is using THG warehouses for returns processing. This should be on the customer’s label so that it can be scanned and linked to a THG return shipment on receipt at the warehouse. This reference is order-unique - so it can be used across multiple returns for one order.
warehouseId	Integer	No - if not provided then THG will use an arranged configuration to automatically allocate the return to the correct warehouse	The `warehouseId` of the warehouse this return should be allocated to. This parameter is optional.

Return Sender

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
returnSenderType	String	Yes	`CUSTOMER` or `COURIER`

Return Lines

There should only be one line per product.

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
productId	Integer	One of `productId` or `barcode`	THG Sku Id
barcode	String	One of `productId` or `barcode`	Product barcode - must map to a valid THG Sku
quantity	Integer	Yes	How many items are being returned.
requestAction	String	Yes	`REFUND` or `REPLACE`
returnReason	Object	Yes	Reason of return of product (check all return reasons here) This API only supports one reason per product when creating a return. For example, if product `A` is included in two different return lines with different reasons then this will be rejected.

JSON Schema

{\n    \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n    \"type\": \"object\",\n    \"properties\": {\n        \"orderNumber\": {\n            \"type\": \"string\"\n        },\n        \"externalReturnReference\": {\n            \"type\": \"boolean\"\n        },\n        \"returnSender\": {\n            \"type\": \"object\",\n            \"returnSenderType\": {\n                \"type\": \"string\"\n            },\n            \"required\": [\n                \"returnSenderType\"\n            ]\n        },\n        \"returnLines\": {\n            \"type\": \"array\",\n            \"items\": {\n                \"type\": \"object\",\n                \"productId\": {\n                    \"type\": \"integer\"\n                },\n                \"quantity\": {\n                    \"type\": \"integer\"\n                },\n                \"requestedAction\": {\n                    \"type\": \"string\"\n                },\n                \"returnReason\": {\n                    \"type\": \"object\",\n                    \"reasonName\": {\n                      \"type\": \"string\"\n                    }\n                    \"required\": [\n                      \"reasonName\"\n                    ]\n                },\n                \"required\": [\n                    \"productId\",\n                    \"quantity\",\n                    \"requestedAction\",\n                    \"returnReason\"\n                ]\n            }\n        },\n        \"required\": [\n            \"orderNumber\",\n            \"success\",\n            \"error\"\n        ]\n    }\n}\n\n

Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`201 CREATED`	Return has been created.
`400 BAD REQUEST`	Bad request to gateway.
`401 UNAUTHORIZED`	The authorization token is invalid or expired.
`404 NOT FOUND`	Could not find the original shipment for the order or the order itself.
`422 UNPROCESSABLE ENTITY`	Could not validate the RMA request - this could be because there could be: - Duplicate return lines. - The order does not exist or no order number has been provided. The exact reason will be provided in the returning error message.
`500 INTERNAL SERVER ERROR`	There has been a backend error.

Body

{\n  \"links\": {\n    \"self\": \"string\"\n  },\n  \"data\": {\n    \"returnShipmentNumber\": 0,\n    \"createdDate\": \"string\",\n    \"expiryDate\": \"string\",\n    \"notes\": \"string\",\n    \"orderId\": \"string\",\n    \"externalReturnReference\": \"string\",\n    \"returnSender\": {\n      \"channel\": \"string\",\n      \"countryCode\": \"string\",\n      \"locale\": \"string\",\n      \"returnSenderType\": \"COURIER || CUSTOMER\",\n      \"senderReferenceNumber\": 0,\n      \"labelBarcode\": \"string\"\n    },\n    \"returnStatus\": \"CANCELLED || COMPLETED || CONTACTED || CREATED || HELD || IDENTIFIED || MANUAL_RESOLVED || PROCESSED || UNEXPECTED\",\n    \"returnWarehouse\": {\n      \"returnWarehouseId\": 0,\n      \"returnWarehouseName\": \"string\"\n    },\n    \"processedBy\": 0,\n    \"returnLines\": [\n      {\n        \"skuId\": \"string\",\n        \"barcode\": \"abc\",\n        \"barcodes\": {\n          \"EAN\": [\n            \"string\"\n          ],\n          \"UPC\": [\n            \"string\"\n          ]\n        },\n        \"productType\": \"DROP || ECOM || REG\",\n        \"sellerId\": \"string\",\n        \"quantity\": 0,\n        \"processedState\": \"DAMAGED || FAULTY || PRISTINE\",\n        \"expectedLineNotReceived\": \"boolean\",\n        \"returnReason\": {\n          \"reasonId\": 0,\n          \"reasonName\": \"string\",\n          \"returnLineState\": \"DAMAGED || FAULTY || PRISTINE\"\n        }\n      }\n    ],\n    \"trackingDetails\": {\n        \"trackingNumber\": \"123\",\n        \"trackingUrl\": \"trackingUrl\"\n    },\n    \"label\": {\n        \"mediaType\": \"application/pdf\",\n        \"base64Label\": \"...\",\n        \"base64AdditionalLabel\": \"...\"\n    }\n  }\n}\n\n

Links

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
self	String	Yes	A link to the returned resource

Data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
returnShipmentNumber	String	Yes	Unique Identifier for a returns shipment
orderId	String	Yes	Unique Identifier for an order
clientOrderReference	String	No	The client order reference
createdDate	String	Yes	Date the return is created, Ex: \"2022-01-20T10:00:00\", UTC Format
expiryDate	String	Yes	Date the return is set to expire, Ex: \"2022-01-20T10:00:00\", UTC Format
notes	String	No	Additional notes on the return
externalReturnReference	String	Yes - if using THG warehouse for returns	External reference to the return - to scan at a THG warehouse to link parcel to a return shipment
returnStatus	String	Yes	The state the return is currently in. See 'Return States' here.

Return Sender

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
senderReferenceNumber	Integer	Yes	Customer reference number
returnSenderType	String	Yes	`CUSTOMER` or `COURIER`
locale	String[5]	No	Order locale - a mix of ISO-3166 country codes and ISO-639 language codes separated by `_`. Examples: `en_GB`, `it_IT`, `de_DE`, `fr_FR`
channel	String	Yes	Order channel
countryCode	String	Yes	Country code

Return Warehouse

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
returnWarehouseId	Integer	Yes	Return warehouse Id
returnWarehouseName	String	No	The name of the return warehouse

Return Lines

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
skuId	Integer	No	Client Sku Id
thgSkuId	String	Yes	Thg Sku Id
barcode	String	Yes	Product Barcode
barcodes	Map (String)	Yes	Map of product barcodes
quantity	Integer	Yes	Quantity expected/returned - updated after return is processed
processedState	String	No	The actual state the item was returned in. This is `null` until the item arrives at the warehouse.
expectedLineNotReceived	Boolean	No	If this return line was expected in the original RMA but was not received. This could be because: - the customer wanted to return product B but did not send product B in; - the customer said they’d return product B in state PRISTINE but sent it in state DAMAGED - this would create a separate processed return line and mark the original as expectedLineNotReceived = true. This is `null` until the return shipment arrives at the warehouse.
returnReason		Yes	Reason of return of product (check all return reason in 'Return')

Tracking Details

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
trackingNumber	String	No	ID of the Courier Return
trackingUrl	String	No	URL to view status of Return

Label

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
mediaType	String	No	Object Type definition
base64Label	String	No	Base 64 encoded object for the primary returns label
base64AdditionalLabel	String	No	Base 64 encoded object for any additional returns labels

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"links\": {\n      \"type\": \"object\",\n      \"self\": {\n        \"type\": \"string\"\n      },\n      \"required\": [\n        \"self\"\n      ]\n    },\n    \"data\": {\n      \"returnShipmentNumber\": {\n        \"type\": \"integer\"\n      },\n      \"createdDate\": {\n        \"type\": \"string\"\n      },\n      \"expiryDate\": {\n        \"type\": \"string\"\n      },\n      \"notes\": {\n        \"type\": \"string\"\n      },\n      \"orderId\": {\n        \"type\": \"string\"\n      },\n      \"externalReturnReference\": {\n        \"type\": \"string\"\n      },\n      \"returnSender\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"channel\": {\n            \"type\": \"string\"\n          },\n          \"countryCode\": {\n            \"type\": \"string\"\n          },\n          \"locale\": {\n            \"type\": \"string\"\n          },\n          \"returnSenderType\": {\n            \"type\": \"string\"\n          },\n          \"senderReferenceNumber\": {\n            \"type\": \"integer\"\n          },\n          \"labelBarcode\": {\n            \"type\": \"string\"\n          }\n        },\n        \"required\": [\n          \"channel\",\n          \"countryCode\",\n          \"locale\",\n          \"returnSenderType\",\n          \"senderReferenceNumber\",\n          \"labelBarcode\"\n        ]\n      },\n      \"returnStatus\": {\n        \"type\": \"string\"\n      },\n      \"returnWarehouse\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"returnWarehouseId\": {\n            \"type\": \"integer\"\n          },\n          \"returnWarehouseName\": {\n            \"type\": \"string\"\n          }\n        },\n        \"required\": [\n          \"returnWarehouseId\",\n          \"returnWarehouseName\"\n        ]\n      },\n      \"returnLines\": {\n        \"type\": \"array\",\n        \"items\": [\n          {\n            \"type\": \"object\",\n            \"properties\": {\n              \"skuId\": {\n                \"type\": \"string\"\n              },\n              \"barcode\": {\n                \"type\": \"string\"\n              },\n              \"barcodes\": {\n                \"type\": \"object\",\n                \"properties\": {\n                  \"EAN\": {\n                    \"type\": \"array\",\n                    \"items\": [\n                      {\n                        \"type\": \"string\"\n                      }\n                    ]\n                  },\n                  \"UPC\": {\n                    \"type\": \"array\",\n                    \"items\": [\n                      {\n                        \"type\": \"string\"\n                      }\n                    ]\n                  }\n                },\n                \"anyOf\": [\n                  {\n                    \"required\": [\n                      \"EAN\"\n                    ]\n                  },\n                  {\n                    \"required\": [\n                      \"UPC\"\n                    ]\n                  }\n                ]\n              },\n              \"productType\": {\n                \"type\": \"string\"\n              },\n              \"sellerId\": {\n                \"type\": \"string\"\n              },\n              \"quantity\": {\n                \"type\": \"integer\"\n              },\n              \"processedState\": {\n                \"type\": \"string\"\n              },\n              \"expectedLineNotReceived\": {\n                \"type\": \"boolean\"\n              },\n              \"returnReason\": {\n                \"type\": \"object\",\n                \"properties\": {\n                  \"reasonId\": {\n                    \"type\": \"integer\"\n                  },\n                  \"reasonName\": {\n                    \"type\": \"string\"\n                  },\n                  \"returnLineState\": {\n                    \"type\": \"string\"\n                  }\n                },\n                \"required\": [\n                  \"reasonId\",\n                  \"reasonName\",\n                  \"returnLineState\"\n                ]\n              }\n            },\n            \"required\": [\n              \"skuId\",\n              \"thgSkuId\",\n              \"barcode\",\n              \"barcodes\",\n              \"productType\",\n              \"quantity\",\n              \"returnReason\"\n            ]\n          }\n        ]\n      }\n    },\n    \"required\": [\n      \"returnShipmentNumber\",\n      \"createdDate\",\n      \"expiryDate\",\n      \"notes\",\n      \"orderId\",\n      \"returnSender\",\n      \"returnStatus\",\n      \"returnWarehouse\",\n      \"returnLines\"\n    ]\n  }\n}\n\n

\n","urlObject":{"path":["v2","order","returns"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"2b4bab5b-e64a-4fa9-a46e-1583d459de95","name":"Create Return (Success)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orderNumber\": \"123456789\",\n \"externalReturnReference\": \"22314934240\",\n \"returnSender\": {\n \"returnSenderType\": \"CUSTOMER\"\n },\n \"returnLines\": [\n {\n \"productId\": 3242424,\n \"quantity\": 1,\n \"requestedAction\": \"REFUND\",\n \"returnReason\": {\n \"reasonName\": \"LOOKS DIFFERENT TO IMAGE ON SITE\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/returns"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"links\": {\n \"self\": \"https://thggatewayurl/v2/order/returnShipment/612\"\n },\n \"data\": {\n \"returnShipmentNumber\": 612,\n \"createdDate\": \"2024-01-31T12:13:22\",\n \"expiryDate\": \"2024-07-29T12:13:22\",\n \"notes\": \"\",\n \"orderId\": \"123456789\",\n \"shippingPrice\": null,\n \"externalReturnReference\": \"22314934240\",\n \"returnSender\": {\n \"senderReferenceNumber\": 53542662646,\n \"returnSenderType\": \"CUSTOMER\",\n \"locale\": \"en_GB\",\n \"channel\": \"channel\",\n \"siteCode\": \"SITCD\"\n },\n \"returnStatus\": \"CREATED\",\n \"returnWarehouse\": {\n \"returnWarehouseId\": 31,\n \"returnWarehouseName\": \"Warehouse name\"\n },\n \"returnLines\": [\n {\n \"skuId\": \"1273527\",\n \"thgSkuId\": 3242424,\n \"barcode\": \"457845795545254\",\n \"barcodes\": {\n \"EAN\": [\n \"457845795545254\"\n ],\n \"UPC\": []\n },\n \"quantity\": 1,\n \"processedState\": null,\n \"expectedLineNotReceived\": null,\n \"returnReason\": {\n \"reasonId\": 7,\n \"reasonName\": \"LOOKS DIFFERENT TO IMAGE ON SITE\",\n \"returnLineState\": \"PRISTINE\"\n },\n \"identifiers\": [\n {\n \"type\": \"SERIAL_NUMBER\",\n \"values\": [\n \"TEST99998\",\n \"TEST99999\"\n ]\n },\n {\n \"type\": \"IMEI\",\n \"values\": [\n \"351234567890123\",\n \"351234567890124\"\n ]\n }\n ]\n }\n ]\n }\n}"},{"id":"3e34bdf0-c71d-4fa3-8ea7-4902b5f2685e","name":"Create Return (Failure)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"orderNumber\": \"123456789\",\n \"externalReturnReference\": \"22314934240\",\n \"returnSender\": {\n \"returnSenderType\": \"CUSTOMER\"\n },\n \"returnLines\": [\n {\n \"productId\": 3242424,\n \"quantity\": 0,\n \"requestedAction\": \"REFUND\",\n \"returnReason\": {\n \"reasonName\": \"LOOKS DIFFERENT TO IMAGE ON SITE\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/returns"},"status":"Unprocessable Entity (WebDAV) (RFC 4918)","code":422,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Cannot have a quantity of 0.\"\n}"}],"_postman_id":"fdacd85a-18cd-4459-a2c4-304aa00746fd"},{"name":"Fetch Return by Return Shipment Number ref: RET.I.04","id":"a0faa66a-6a77-47e4-8226-5d2e648d34c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"url":"/v2/order/returns/{returnShipmentNumber}","description":"

This endpoint fetches a return shipment (return/RMA).

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
returnShipmentNumber	Integer	Yes	The return shipment number

Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200 OK`	Return has been found.
`400 BAD REQUEST`	Bad request to gateway.
`401 UNAUTHORIZED`	The authorization token is invalid or expired.
`404 NOT FOUND`	Could not find the return shipment number.
`500 INTERNAL SERVER ERROR`	There has been a backend error.

Body

{\n  \"links\": {\n    \"self\": \"string\"\n  },\n  \"data\": {\n    \"returnShipmentNumber\": 0,\n    \"createdDate\": \"string\",\n    \"expiryDate\": \"string\",\n    \"notes\": \"string\",\n    \"orderId\": \"string\",\n    \"externalReturnReference\": \"string\",\n    \"returnSender\": {\n      \"channel\": \"string\",\n      \"countryCode\": \"string\",\n      \"locale\": \"string\",\n      \"returnSenderType\": \"COURIER || CUSTOMER\",\n      \"senderReferenceNumber\": 0,\n      \"labelBarcode\": \"string\"\n    },\n    \"returnStatus\": \"CANCELLED || COMPLETED || CONTACTED || CREATED || HELD || IDENTIFIED || MANUAL_RESOLVED || PROCESSED || UNEXPECTED\",\n    \"returnWarehouse\": {\n      \"returnWarehouseId\": 0,\n      \"returnWarehouseName\": \"string\"\n    },\n    \"processedBy\": 0,\n    \"returnLines\": [\n      {\n        \"skuId\": \"string\",\n        \"barcode\": \"abc\",\n        \"barcodes\": {\n          \"EAN\": [\n            \"string\"\n          ],\n          \"UPC\": [\n            \"string\"\n          ]\n        },\n        \"productType\": \"DROP || ECOM || REG\",\n        \"sellerId\": \"string\",\n        \"quantity\": 0,\n        \"processedState\": \"DAMAGED || FAULTY || PRISTINE\",\n        \"expectedLineNotReceived\": \"boolean\",\n        \"returnReason\": {\n          \"reasonId\": 0,\n          \"reasonName\": \"string\",\n          \"returnLineState\": \"DAMAGED || FAULTY || PRISTINE\"\n        },\n        \"identifiers\": [\n          {\n            \"type\": \"string\",\n            \"values\": [\n              \"string\"\n            ]\n          }\n        ]\n      }\n    ]\n  }\n}\n\n

Links

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
self	String	Yes	A link to the returned resource

Data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
returnShipmentNumber	String	Yes	Unique Identifier for a returns shipment
orderId	String	Yes	Unique Identifier for an order
clientOrderReference	String	No	The client order reference
createdDate	String	Yes	Date the return is created, Ex: \"2022-01-20T10:00:00\", UTC Format
expiryDate	String	Yes	Date the return is set to expire, Ex: \"2022-01-20T10:00:00\", UTC Format
notes	String	No	Additional notes on the return
externalReturnReference	String	No	External reference to the return - to scan at a THG warehouse to link parcel to a return shipment. This reference is order-unique - so it can be used across multiple returns for one order.
returnStatus	String	Yes	The state the return is currently in. See 'Return States' here.

Return Sender

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
senderReferenceNumber	Integer	Yes	Customer reference number
returnSenderType	String	Yes	`CUSTOMER` or `COURIER`
locale	String[5]	No	Order locale
channel	String	Yes	Order channel
countryCode	String	Yes	Country code

Return Warehouse

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
returnWarehouseId	Integer	Yes	Return warehouse Id
returnWarehouseName	String	No	The name of the return warehouse

Return Lines

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
skuId	String	No	Client Sku Id
thgSkuId	Integer	Yes	Thg Sku Id
barcode	String	Yes	Product Barcode
barcodes	Map (String)	Yes	Map of product barcodes
quantity	Integer	Yes	Quantity expected/returned - updated after return is processed
processedState	String	No	The actual state the item was returned in. This is `null` until the item arrives at the warehouse.
expectedLineNotReceived	Boolean	No	If this return line was expected in the original RMA but was not received. This could be because: - the customer wanted to return product B but did not send product B in; - the customer said they’d return product B in state PRISTINE but sent it in state DAMAGED - this would create a separate processed return line and mark the original as expectedLineNotReceived = true. This is `null` until the return shipment arrives at the warehouse.
returnReason		Yes	Reason of return of product (check all return reason here)
identifiers	Array of Identifiers	No	Array of all identifiers associated with the returned product, where provided.

Identifiers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
type	string	Y	Type of identifier, eg. SERIAL_NUMBER, IMEI
values	Array of string	Y	List of values associated with identifier.

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"links\": {\n      \"type\": \"object\",\n      \"self\": {\n        \"type\": \"string\"\n      },\n      \"required\": [\n        \"self\"\n      ]\n    },\n    \"data\": {\n      \"returnShipmentNumber\": {\n        \"type\": \"integer\"\n      },\n      \"createdDate\": {\n        \"type\": \"string\"\n      },\n      \"expiryDate\": {\n        \"type\": \"string\"\n      },\n      \"notes\": {\n        \"type\": \"string\"\n      },\n      \"orderId\": {\n        \"type\": \"string\"\n      },\n      \"externalReturnReference\": {\n        \"type\": \"string\"\n      },\n      \"returnSender\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"channel\": {\n            \"type\": \"string\"\n          },\n          \"countryCode\": {\n            \"type\": \"string\"\n          },\n          \"locale\": {\n            \"type\": \"string\"\n          },\n          \"returnSenderType\": {\n            \"type\": \"string\"\n          },\n          \"senderReferenceNumber\": {\n            \"type\": \"integer\"\n          },\n          \"labelBarcode\": {\n            \"type\": \"string\"\n          }\n        },\n        \"required\": [\n          \"channel\",\n          \"countryCode\",\n          \"locale\",\n          \"returnSenderType\",\n          \"senderReferenceNumber\",\n          \"labelBarcode\"\n        ]\n      },\n      \"returnStatus\": {\n        \"type\": \"string\"\n      },\n      \"returnWarehouse\": {\n        \"type\": \"object\",\n        \"properties\": {\n          \"returnWarehouseId\": {\n            \"type\": \"integer\"\n          },\n          \"returnWarehouseName\": {\n            \"type\": \"string\"\n          }\n        },\n        \"required\": [\n          \"returnWarehouseId\",\n          \"returnWarehouseName\"\n        ]\n      },\n      \"returnLines\": {\n        \"type\": \"array\",\n        \"items\": [\n          {\n            \"type\": \"object\",\n            \"properties\": {\n              \"skuId\": {\n                \"type\": \"string\"\n              },\n              \"barcode\": {\n                \"type\": \"string\"\n              },\n              \"barcodes\": {\n                \"type\": \"object\",\n                \"properties\": {\n                  \"EAN\": {\n                    \"type\": \"array\",\n                    \"items\": [\n                      {\n                        \"type\": \"string\"\n                      }\n                    ]\n                  },\n                  \"UPC\": {\n                    \"type\": \"array\",\n                    \"items\": [\n                      {\n                        \"type\": \"string\"\n                      }\n                    ]\n                  }\n                },\n                \"anyOf\": [\n                  {\n                    \"required\": [\n                      \"EAN\"\n                    ]\n                  },\n                  {\n                    \"required\": [\n                      \"UPC\"\n                    ]\n                  }\n                ]\n              },\n              \"productType\": {\n                \"type\": \"string\"\n              },\n              \"sellerId\": {\n                \"type\": \"string\"\n              },\n              \"quantity\": {\n                \"type\": \"integer\"\n              },\n              \"processedState\": {\n                \"type\": \"string\"\n              },\n              \"expectedLineNotReceived\": {\n                \"type\": \"boolean\"\n              },\n              \"returnReason\": {\n                \"type\": \"object\",\n                \"properties\": {\n                  \"reasonId\": {\n                    \"type\": \"integer\"\n                  },\n                  \"reasonName\": {\n                    \"type\": \"string\"\n                  },\n                  \"returnLineState\": {\n                    \"type\": \"string\"\n                  }\n                },\n                \"required\": [\n                  \"reasonId\",\n                  \"reasonName\",\n                  \"returnLineState\"\n                ]\n              },\n              \"identifiers\": {\n                  \"type\": \"array\",\n                  \"items\": [\n                    {\n                      \"type\": \"object\",\n                      \"properties\": {\n                        \"type\": {\n                          \"type\": \"string\"\n                        },\n                        \"values\": {\n                          \"type\": \"array\",\n                           \"items\": [\n                             {\n                               \"type\": \"string\"\n                             }\n                           ]\n                         }\n                      },\n                      \"required\": [\n                        \"type\",\n                        \"values\",\n                      ]\n                    }\n                  ]\n                }\n            },\n            \"required\": [\n              \"skuId\",\n              \"thgSkuId\",\n              \"barcode\",\n              \"barcodes\",\n              \"productType\",\n              \"quantity\",\n              \"returnReason\"\n            ]\n          }\n        ]\n      }\n    },\n    \"required\": [\n      \"returnShipmentNumber\",\n      \"createdDate\",\n      \"expiryDate\",\n      \"notes\",\n      \"orderId\",\n      \"returnSender\",\n      \"returnStatus\",\n      \"returnWarehouse\",\n      \"returnLines\"\n    ]\n  }\n}\n\n

\n","urlObject":{"path":["v2","order","returns","{returnShipmentNumber}"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"5aa2f8a8-a9b1-40fb-a00f-6bb84e2781a6","name":"Fetch Return by Return Shipment Number (Success)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"url":"/v2/order/returns/612"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"links\": {\n \"self\": \"https://thggatewayurl/v2/order/returnShipment/612\"\n },\n \"data\": {\n \"returnShipmentNumber\": 612,\n \"createdDate\": \"2024-01-31T12:13:22\",\n \"returnDate\": \"2024-01-31T12:13:22\",\n \"expiryDate\": \"2024-07-29T12:13:22\",\n \"notes\": \"\",\n \"orderId\": \"123456789\",\n \"shippingPrice\": null,\n \"externalReturnReference\": \"22314934240\",\n \"returnSender\": {\n \"senderReferenceNumber\": 53542662646,\n \"returnSenderType\": \"CUSTOMER\",\n \"locale\": \"en_GB\",\n \"channel\": \"channel\",\n \"siteCode\": \"SITCD\"\n },\n \"returnStatus\": \"CREATED\",\n \"returnWarehouse\": {\n \"returnWarehouseId\": 31,\n \"returnWarehouseName\": \"Warehouse name\"\n },\n \"returnLines\": [\n {\n \"skuId\": \"1273527\",\n \"thgSkuId\": 3242424,\n \"barcode\": \"457845795545254\",\n \"barcodes\": {\n \"EAN\": [\n \"457845795545254\"\n ],\n \"UPC\": []\n },\n \"quantity\": 1,\n \"processedState\": null,\n \"expectedLineNotReceived\": null,\n \"returnReason\": {\n \"reasonId\": 7,\n \"reasonName\": \"LOOKS DIFFERENT TO IMAGE ON SITE\",\n \"returnLineState\": \"PRISTINE\"\n },\n \"identifiers\": [\n {\n \"type\": \"SERIAL_NUMBER\",\n \"values\": [\n \"TEST99998\",\n \"TEST99999\"\n ]\n },\n {\n \"type\": \"IMEI\",\n \"values\": [\n \"351234567890123\",\n \"351234567890124\"\n ]\n }\n ]\n }\n ],\n \"trackingDetails\": {\n \"trackingNumber\": \"123\",\n \"trackingUrl\": \"trackingUrl\"\n },\n \"label\": {\n \"mediaType\": \"application/pdf\",\n \"base64Label\": \"...\",\n \"base64AdditionalLabel\": \"...\"\n },\n \"courierService\": {\n \"courierName\": \"RoyalMail\",\n \"courierId\": 190,\n \"serviceName\": \"Royal Mail Sapient\",\n \"serviceId\": 3261\n }\n }\n}"},{"id":"cbcb43dc-a59d-425b-935b-6b92a02f94fa","name":"Fetch Return by Return Shipment Number (Failure)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"url":"/v2/order/returns/613"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Could not find return shipment.\"\n}"}],"_postman_id":"a0faa66a-6a77-47e4-8226-5d2e648d34c7"},{"name":"Fetch Paginated Returns ref: RET.I.05","id":"29430bc3-abe3-446d-b57d-d08c9b6ae157","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"url":"/v2/order/returns/paginated","description":"

This is a paginated endpoint that returns all of the client’s returns. The pagination and filtering options available are described below.

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Default	Notes	Mandatory
pageNumber	int	1	The current page in the pagination - start at 1.	No
pageSize	int	10	How big each page is. Max 25.	No
returnStatus	enum		Filter by return shipment status (see 'Return States' here).	No
warehouseId	int		Filter by the warehouse where the return is assigned to.	No
orderNumber	string		Filter returns by order number (THG or client)	No
fromCreateDate	String (YYYY-MM-DD)		Filter Returns by Date of Creation	No
toCreateDate	String (YYYY-MM-DD)		Filter Returns by Date of Creation	No

Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`200 OK`	Fetches returns given the parameters.
`400 BAD REQUEST`	Bad request to gateway.
`422 UNPROCESSABLE ENTITY`	The request parameters were incorrect in some way.
`401 UNAUTHORIZED`	The authorization token is invalid or expired.
`500 INTERNAL SERVER ERROR`	There has been a backend error.

Body

{\n  \"pagination\": {\n    \"currentPage\": 0,\n    \"pageSize\": 0,\n    \"totalPages\": 0,\n    \"totalItems\": 0,\n    \"next\": \"string\",\n    \"prev\": \"string\",\n    \"first\": \"string\",\n    \"last\": \"string\",\n    \"fromCreateDate\": \"string\",\n    \"toCreateDate\": \"string\"\n  },\n  \"data\": [\n    {\n      \"returnShipmentNumber\": 0,\n      \"createdDate\": \"string\",\n      \"expiryDate\": \"string\",\n      \"notes\": \"string\",\n      \"orderId\": \"string\",\n      \"externalReturnReference\": \"string\",\n      \"returnSender\": {\n        \"channel\": \"string\",\n        \"countryCode\": \"string\",\n        \"locale\": \"string\",\n        \"returnSenderType\": \"COURIER || CUSTOMER\",\n        \"senderReferenceNumber\": 0,\n        \"labelBarcode\": \"string\"\n      },\n      \"returnStatus\": \"CANCELLED || COMPLETED || CONTACTED || CREATED || HELD || IDENTIFIED || MANUAL_RESOLVED || PROCESSED || UNEXPECTED\",\n      \"returnWarehouse\": {\n        \"returnWarehouseId\": 0,\n        \"returnWarehouseName\": \"string\"\n      },\n      \"processedBy\": 0,\n      \"returnLines\": [\n        {\n          \"skuId\": \"string\",\n          \"thgSkuId\": 0,\n          \"barcode\": \"abc\",\n          \"barcodes\": {\n            \"EAN\": [\n              \"string\"\n            ],\n            \"UPC\": [\n              \"string\"\n            ]\n          },\n          \"productType\": \"DROP || ECOM || REG\",\n          \"sellerId\": \"string\",\n          \"quantity\": 0,\n          \"processedState\": \"DAMAGED || FAULTY || PRISTINE\",\n          \"expectedLineNotReceived\": \"boolean\",\n          \"returnReason\": {\n            \"reasonId\": 0,\n            \"reasonName\": \"string\",\n            \"returnLineState\": \"DAMAGED || FAULTY || PRISTINE\"\n          },\n           \"identifiers\": [\n            {\n              \"type\": \"string\",\n              \"values\": [\n                \"string\"\n              ]\n            }\n          ]\n        }\n      ]\n    }\n  ]\n}\n\n

Pagination

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
currentPage	Integer	Yes	The current page number.
pageSize	Integer	Yes	The current page size.
totalPages	Integer	Yes	The total number of pages.
totalItems	Integer	Yes	The total number of return shipment based on the provided filtering criteria.
next	String	Yes	The resource link to the next page.
prev	String	Yes	The resource link to the previous page.
first	String	Yes	The resource link to the first page.
last	String	Yes	The resource link to the last page.

Data

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
returnShipmentNumber	String	Yes	Unique Identifier for a returns shipment
orderId	String	Yes	Unique Identifier for an order
clientOrderReference	String	No	The client order reference
createdDate	String	Yes	Date the return is created, Ex: \"2022-01-20T10:00:00\", UTC Format
expiryDate	String	Yes	Date the return is set to expire, Ex: \"2022-01-20T10:00:00\", UTC Format
notes	String	No	Additional notes on the return
externalReturnReference	String	Yes - if using THG warehouse for returns	External reference to the return - to scan at a THG warehouse to link parcel to a return shipment. This reference is order-unique - so it can be used across multiple returns for one order.
returnStatus	String	Yes	The state the return is currently in. See 'Return States' here.

Return Sender

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
senderReferenceNumber	Integer	Yes	Customer reference number
returnSenderType	String	Yes	`CUSTOMER` or `COURIER`
locale	String[5]	No	Order locale
channel	String	Yes	Order channel
countryCode	String	Yes	Country code

Return Warehouse

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
returnWarehouseId	Integer	Yes	Return warehouse Id
returnWarehouseName	String	No	The name of the return warehouse

Return Lines

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
skuId	String	No	Client Sku Id
thgSkuId	Integer	Yes	Thg Sku Id
barcode	String	Yes	Product Barcode
barcodes	Map (String)	Yes	Map of product barcodes
quantity	Integer	Yes	Quantity expected/returned - updated after return is processed
processedState	String	No	The actual state the item was returned in. This is `null` until the item arrives at the warehouse.
expectedLineNotReceived	Boolean	No	If this return line was expected in the original RMA but was not received. This could be because: - the customer wanted to return product B but did not send product B in; - the customer said they’d return product B in state PRISTINE but sent it in state DAMAGED - this would create a separate processed return line and mark the original as expectedLineNotReceived = true. This is `null` until the return shipment arrives at the warehouse.
returnReason		Yes	Reason of return of product (check all return reason here)
identifiers	Array of Identifiers	No	Array of all identifiers associated with the returned product, where provided.

Identifiers

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
type	string	Y	Type of identifier, eg. SERIAL_NUMBER, IMEI
values	Array of string	Y	List of values associated with identifier.

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"pagination\": {\n      \"type\": \"object\",\n      \"currentPage\": {\n        \"type\": \"integer\"\n      },\n      \"pageSize\": {\n        \"type\": \"integer\"\n      },\n      \"totalPages\": {\n        \"type\": \"integer\"\n      },\n      \"totalItems\": {\n        \"type\": \"integer\"\n      },\n      \"next\": {\n        \"type\": \"string\"\n      },\n      \"prev\": {\n        \"type\": \"string\"\n      },\n      \"first\": {\n        \"type\": \"string\"\n      },\n      \"last\": {\n        \"type\": \"string\"\n      },\n      \"fromCreateDate\": { \n        \"type\": \"string\", \"format\": \"date\" \n      },\n      \"toCreateDate\": { \n        \"type\": \"string\", \"format\": \"date\" \n      },\n      \"required\": [\n        \"currentPage\",\n        \"pageSize\",\n        \"totalPages\",\n        \"totalItems\",\n        \"next\",\n        \"prev\",\n        \"first\",\n        \"last\"\n      ]\n    },\n    \"data\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"returnShipmentNumber\": {\n          \"type\": \"integer\"\n        },\n        \"createdDate\": {\n          \"type\": \"string\"\n        },\n        \"expiryDate\": {\n          \"type\": \"string\"\n        },\n        \"notes\": {\n          \"type\": \"string\"\n        },\n        \"orderId\": {\n          \"type\": \"string\"\n        },\n        \"externalReturnReference\": {\n          \"type\": \"string\"\n        },\n        \"returnSender\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"channel\": {\n              \"type\": \"string\"\n            },\n            \"countryCode\": {\n              \"type\": \"string\"\n            },\n            \"locale\": {\n              \"type\": \"string\"\n            },\n            \"returnSenderType\": {\n              \"type\": \"string\"\n            },\n            \"senderReferenceNumber\": {\n              \"type\": \"integer\"\n            },\n            \"labelBarcode\": {\n              \"type\": \"string\"\n            }\n          },\n          \"required\": [\n            \"channel\",\n            \"countryCode\",\n            \"locale\",\n            \"returnSenderType\",\n            \"senderReferenceNumber\",\n            \"labelBarcode\"\n          ]\n        },\n        \"returnStatus\": {\n          \"type\": \"string\"\n        },\n        \"returnWarehouse\": {\n          \"type\": \"object\",\n          \"properties\": {\n            \"returnWarehouseId\": {\n              \"type\": \"integer\"\n            },\n            \"returnWarehouseName\": {\n              \"type\": \"string\"\n            }\n          },\n          \"required\": [\n            \"returnWarehouseId\",\n            \"returnWarehouseName\"\n          ]\n        },\n        \"returnLines\": {\n          \"type\": \"array\",\n          \"items\": [\n            {\n              \"type\": \"object\",\n              \"properties\": {\n                \"skuId\": {\n                  \"type\": \"string\"\n                },\n                \"barcode\": {\n                  \"type\": \"string\"\n                },\n                \"barcodes\": {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"EAN\": {\n                      \"type\": \"array\",\n                      \"items\": [\n                        {\n                          \"type\": \"string\"\n                        }\n                      ]\n                    },\n                    \"UPC\": {\n                      \"type\": \"array\",\n                      \"items\": [\n                        {\n                          \"type\": \"string\"\n                        }\n                      ]\n                    }\n                  },\n                  \"anyOf\": [\n                    {\n                      \"required\": [\n                        \"EAN\"\n                      ]\n                    },\n                    {\n                      \"required\": [\n                        \"UPC\"\n                      ]\n                    }\n                  ]\n                },\n                \"productType\": {\n                  \"type\": \"string\"\n                },\n                \"sellerId\": {\n                  \"type\": \"string\"\n                },\n                \"quantity\": {\n                  \"type\": \"integer\"\n                },\n                \"processedState\": {\n                  \"type\": \"string\"\n                },\n                \"expectedLineNotReceived\": {\n                  \"type\": \"boolean\"\n                },\n                \"returnReason\": {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"reasonId\": {\n                      \"type\": \"integer\"\n                    },\n                    \"reasonName\": {\n                      \"type\": \"string\"\n                    },\n                    \"returnLineState\": {\n                      \"type\": \"string\"\n                    }\n                  },\n                  \"required\": [\n                    \"reasonId\",\n                    \"reasonName\",\n                    \"returnLineState\"\n                  ]\n                },\n                \"identifiers\": {\n                  \"type\": \"array\",\n                  \"items\": [\n                    {\n                      \"type\": \"object\",\n                      \"properties\": {\n                        \"type\": {\n                          \"type\": \"string\"\n                        },\n                        \"values\": {\n                          \"type\": \"array\",\n                           \"items\": [\n                             {\n                               \"type\": \"string\"\n                             }\n                           ]\n                         }\n                      },\n                      \"required\": [\n                        \"type\",\n                        \"values\",\n                      ]\n                    }\n                  ]\n                }\n              },\n              \"required\": [\n                \"skuId\",\n                \"thgSkuId\",\n                \"barcode\",\n                \"barcodes\",\n                \"productType\",\n                \"quantity\",\n                \"returnReason\"\n              ]\n            }\n          ]\n        }\n      },\n      \"required\": [\n        \"returnShipmentNumber\",\n        \"createdDate\",\n        \"expiryDate\",\n        \"notes\",\n        \"orderId\",\n        \"returnSender\",\n        \"returnStatus\",\n        \"returnWarehouse\",\n        \"returnLines\"\n      ]\n    }\n  }\n}\n\n

\n","urlObject":{"path":["v2","order","returns","paginated"],"host":[""],"query":[{"disabled":true,"description":{"content":"

The current page in the pagination - start at 1.

\n","type":"text/plain"},"key":"pageNumber","value":"1"},{"disabled":true,"description":{"content":"

The size of each page.

\n","type":"text/plain"},"key":"pageSize","value":"10"},{"disabled":true,"description":{"content":"

Filter by return shipment status (see Return Statuses).

\n","type":"text/plain"},"key":"returnStatus","value":""},{"disabled":true,"description":{"content":"

Filter by the warehouse where the return is assigned to.

\n","type":"text/plain"},"key":"warehouseId","value":""},{"disabled":true,"description":{"content":"

Filter returns by order number (THG or client).

\n","type":"text/plain"},"key":"orderNumber","value":""},{"disabled":true,"key":"fromUpdateDate","value":null},{"disabled":true,"key":"toUpdateDate","value":null},{"disabled":true,"key":"fromCreateDate","value":null},{"disabled":true,"key":"toCreateDate","value":null}],"variable":[]}},"response":[{"id":"059ed370-d82b-4d91-8b1f-b0b4b5f2ed45","name":"Fetch Paginated Returns (Success)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"}],"url":{"raw":"/v2/order/returns/paginated?pageSize=1&returnStatus=CREATED","host":[""],"path":["v2","order","returns","paginated"],"query":[{"key":"pageSize","value":"1"},{"key":"returnStatus","value":"CREATED"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"pagination\": {\n \"currentPage\": 1,\n \"pageSize\": 1,\n \"totalPages\": 5,\n \"totalItems\": 5,\n \"next\": \"https://thggatewayurl/v2/order/returns/paginated?page[size]=1&returnStatus=CREATED&page[number]=2\",\n \"prev\": \"https://thggatewayurl/v2/order/returns/paginated?page[size]=1&returnStatus=CREATED&page[number]=1\",\n \"first\": \"https://thggatewayurl/v2/order/returns/paginated?page[size]=1&returnStatus=CREATED&page[number]=3\",\n \"last\": \"https://thggatewayurl/v2/order/returns/paginated?page[size]=1&returnStatus=CREATED&page[number]=5\"\n },\n \"data\": [\n {\n \"returnShipmentNumber\": 612,\n \"createdDate\": \"2024-01-31T12:13:22\",\n \"expiryDate\": \"2024-07-29T12:13:22\",\n \"notes\": \"\",\n \"orderId\": \"123456789\",\n \"shippingPrice\": null,\n \"externalReturnReference\": \"22314934240\",\n \"returnSender\": {\n \"senderReferenceNumber\": 53542662646,\n \"returnSenderType\": \"CUSTOMER\",\n \"locale\": \"en_GB\",\n \"channel\": \"channel\",\n \"siteCode\": \"SITCD\"\n },\n \"returnStatus\": \"CREATED\",\n \"returnWarehouse\": {\n \"returnWarehouseId\": 31,\n \"returnWarehouseName\": \"Warehouse name\"\n },\n \"returnLines\": [\n {\n \"skuId\": \"1273527\",\n \"thgSkuId\": 3242424,\n \"barcode\": \"457845795545254\",\n \"barcodes\": {\n \"EAN\": [\n \"457845795545254\"\n ],\n \"UPC\": []\n },\n \"quantity\": 1,\n \"processedState\": null,\n \"expectedLineNotReceived\": null,\n \"returnReason\": {\n \"reasonId\": 7,\n \"reasonName\": \"LOOKS DIFFERENT TO IMAGE ON SITE\",\n \"returnLineState\": \"PRISTINE\"\n },\n \"identifiers\": [\n {\n \"type\": \"SERIAL_NUMBER\",\n \"values\": [\n \"TEST99998\",\n \"TEST99999\"\n ]\n },\n {\n \"type\": \"IMEI\",\n \"values\": [\n \"351234567890123\",\n \"351234567890124\"\n ]\n }\n ]\n }\n ]\n },\n {\n \"returnShipmentNumber\": 1501,\n \"notes\": \"\",\n \"orderId\": \"SP_46\",\n \"clientOrderReference\": \"1097_7917110559049\",\n \"shippingPrice\": 0.0,\n \"returnSender\": {\n \"senderReferenceNumber\": null,\n \"returnSenderType\": \"CUSTOMER\",\n \"locale\": \"en_GB\",\n \"channel\": \"sonyplaystation\",\n \"countryCode\": \"GB\",\n \"labelBarcode\": null,\n \"siteCode\": \"SNYPS\"\n },\n \"returnStatus\": \"CREATED\",\n \"returnWarehouse\": {\n \"returnWarehouseId\": 31,\n \"returnWarehouseName\": \"Omega\"\n },\n \"processedBy\": 0,\n \"returnLines\": [\n {\n \"skuId\": \"\",\n \"thgSkuId\": 14493837,\n \"barcode\": \"3843243546433\",\n \"barcodes\": {\n \"EAN\": [\n \"3843243546433\"\n ],\n \"UPC\": []\n },\n \"quantity\": 1,\n \"returnReason\": {\n \"reasonId\": 1,\n \"reasonName\": \"UNWANTED\",\n \"returnLineState\": \"PRISTINE\"\n },\n \"identifiers\": []\n }\n ],\n \"returnDate\": \"20260209\",\n \"externalReturnReference\": null,\n \"trackingDetails\": null,\n \"label\": null,\n \"courierService\": null,\n \"createdDate\": \"2026-02-09T10:28:38.000000597\",\n \"expiryDate\": \"2026-08-08T10:28:38.000000602\",\n \"updatedDate\": \"2026-02-09T10:28:38.000000597\"\n },\n {\n \"returnShipmentNumber\": 612,\n \"createdDate\": \"2024-01-31T12:13:22\",\n \"returnDate\": \"2024-01-31T12:13:22\",\n \"expiryDate\": \"2024-07-29T12:13:22\",\n \"notes\": \"\",\n \"orderId\": \"123456789\",\n \"shippingPrice\": null,\n \"externalReturnReference\": \"22314934240\",\n \"returnSender\": {\n \"senderReferenceNumber\": 53542662646,\n \"returnSenderType\": \"CUSTOMER\",\n \"locale\": \"en_GB\",\n \"channel\": \"channel\",\n \"siteCode\": \"SITCD\"\n },\n \"returnStatus\": \"CREATED\",\n \"returnWarehouse\": {\n \"returnWarehouseId\": 31,\n \"returnWarehouseName\": \"Warehouse name\"\n },\n \"returnLines\": [\n {\n \"skuId\": \"1273527\",\n \"thgSkuId\": 3242424,\n \"barcode\": \"457845795545254\",\n \"barcodes\": {\n \"EAN\": [\n \"457845795545254\"\n ],\n \"UPC\": []\n },\n \"quantity\": 1,\n \"processedState\": null,\n \"expectedLineNotReceived\": null,\n \"returnReason\": {\n \"reasonId\": 7,\n \"reasonName\": \"LOOKS DIFFERENT TO IMAGE ON SITE\",\n \"returnLineState\": \"PRISTINE\"\n },\n \"identifiers\": [\n {\n \"type\": \"SERIAL_NUMBER\",\n \"values\": [\n \"TEST99998\",\n \"TEST99999\"\n ]\n },\n {\n \"type\": \"IMEI\",\n \"values\": [\n \"351234567890123\",\n \"351234567890124\"\n ]\n }\n ]\n }\n ],\n \"trackingDetails\": {\n \"trackingNumber\": \"123\",\n \"trackingUrl\": \"trackingUrl\"\n },\n \"label\": {\n \"mediaType\": \"application/pdf\",\n \"base64Label\": \"...\",\n \"base64AdditionalLabel\": \"...\"\n },\n \"courierService\": {\n \"courierName\": \"RoyalMail\",\n \"courierId\": 190,\n \"serviceName\": \"Royal Mail Sapient\",\n \"serviceId\": 3261\n }\n }\n ]\n}"},{"id":"e57bbc5e-eb32-433a-825d-550780c88d6c","name":"Fetch Paginated Returns (Success - No Records)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"url":{"raw":"/v2/order/returns/paginated?pageSize=1&returnStatus=CREATED","host":[""],"path":["v2","order","returns","paginated"],"query":[{"key":"pageSize","value":"1"},{"key":"returnStatus","value":"CREATED"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"pagination\": {\n \"currentPage\": 1,\n \"pageSize\": 1,\n \"totalPages\": 1,\n \"totalItems\": 0,\n \"next\": \"https://thggatewayurl/v2/order/returns/paginated?page[size]=1&returnStatus=CREATED&page[number]=1\",\n \"prev\": \"https://thggatewayurl/v2/order/returns/paginated?page[size]=1&returnStatus=CREATED&page[number]=1\",\n \"first\": \"https://thggatewayurl/v2/order/returns/paginated?page[size]=1&returnStatus=CREATED&page[number]=1\",\n \"last\": \"https://thggatewayurl/v2/order/returns/paginated?page[size]=1&returnStatus=CREATED&page[number]=1\"\n },\n \"data\": []\n}"},{"id":"6bd776c8-5082-426b-b5e9-24032e107c19","name":"Fetch Paginated Returns (Failure)","originalRequest":{"method":"GET","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"url":"/v2/order/returns/613"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"The authentication token is invalid/has expired.\"\n}"}],"_postman_id":"29430bc3-abe3-446d-b57d-d08c9b6ae157"},{"name":"Cancel Return ref: RET.I.06","id":"d3b2a38c-1b6e-48ed-adb8-2911da87c52d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"url":"/v2/order/returns/{returnShipmentNumber}/cancel","description":"

This cancels a return shipment in CREATED and puts it in CANCELLED. The shipment can still be read using the paginated and fetch endpoints.

Should this shipment arrive at the warehouse anyway a new UNEXPECTED return shipment will be created off the back of the warehouse Return Receipt and processed accordingly.

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
returnShipmentNumber	Integer	Yes	The return shipment number

Response

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Code	Meaning
`204 NO CONTENT`	The return has been cancelled.
`400 BAD REQUEST`	Bad request to gateway.
`401 UNAUTHORIZED`	The authorization token is invalid or expired.
`404 NOT FOUND`	Could not find this return shipment.
`409 CONFLICT`	This return shipment cannot be cancelled. This is likely due to it not being in a cancellable state.
`500 INTERNAL SERVER ERROR`	There has been a backend error.

","urlObject":{"path":["v2","order","returns","{returnShipmentNumber}","cancel"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"8cf8ab24-e96e-49da-805d-2c97f89f555e","name":"Cancel Return (Success)","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"url":"/v2/order/returns/612/cancel"},"status":"No Content","code":204,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":""},{"id":"e81f445c-8293-40a4-bf9e-43b8e5e9e288","name":"Cancel Return (Failure)","originalRequest":{"method":"PUT","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"url":"/v2/order/returns/613/cancel"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","name":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"error\": \"Could not find return shipment.\"\n}"}],"_postman_id":"d3b2a38c-1b6e-48ed-adb8-2911da87c52d"}],"id":"5fc12856-a917-4e9f-ae40-34c2c1b185b6","description":"

A return is an RMA (Return Merchandise Authorization) which allows the customer to return purchased products for a multitude of reasons. In this API a return is denoted by a return shipment, and the state of this return shipment from creation to completion also represents the state of the return.

Each return shipment is linked to one order, and an order can have many return shipments.

The Returns API allows 3PL clients to:

create returns;
\n
fetch returns;
\n
cancel returns;
\n
process returns.
\n

Return States

The following are a number of return states that a return shipment can be in:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Return State	Description	Previous State(s)
`CREATED`	The return shipment has just been created and is waiting to be received at a warehouse.	This is an origin state.
`PROCESSED`	The return shipment has arrived at the warehouse and is currently being processed.	`CREATED`, `CANCELLED`
`HELD`	The return shipment has arrived at the warehouse but is awaiting CS action due to: - some items may not have arrived in the expected state; - extra items have arrived in addition to what was requested in the original return. This step can be configured to be on or off.	`PROCESSED`
`COMPLETED` (terminal)	The return shipment has been completed.	`PROCESSED` or `HELD`
`CANCELLED` (terminal)	The return shipment has been cancelled.	`CREATED`
`UNEXPECTED`	The return shipment was created as a result of an unexpected shipment at the warehouse. For example, the customer sends in their faulty product without letting us know beforehand, which would create an unexpected return once it reaches the warehouse. Once this shipment is processed and completed it will be set to `COMPLETED`.	This is an origin state.
`IDENTIFIED`	If products arrive at the warehouse in a parcel with no identifiable information (or these products don't match the order on the parcel) they are stored in a separate system until they can be identified with the correct order/return. Once this information is found the parcel will be re-processed with the identified return or we will create a new return with status `IDENTIFIED`. This return is then processed as normal with the return-create callback upon completion.	This is an origin state.

States only transition when:

the return is processed at a warehouse and sent via Return Receipt;
\n
the return is cancelled;
\n
the return was HELD and has then been actioned, where it will continue on to COMPLETED.
\n

Product Condition States

These product condition states are used

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Product State	Description
`PRISTINE`	This product is in new/pristine condition.
`DAMAGED`	This product is clearly damaged.
`FAULTY`	The product doesn’t show signs of damage but is faulty, e.g. an electrical item that doesn’t turn on when it should but shows no sign of damage. Likely a manufacturer defect.

Return Reasons

These are the THG return reasons for why a customer would return a product.

Depending on the reason for the return the expected condition of the product is different. If the product arrives at the warehouse in the expected condition then the return is automatically successfully completed (this is the happy path).

If the product arrives in a condition that is different to what we expected (e.g. the customer claims the product is damaged but it’s returned in pristine condition), then typically this return is transitioned into the HELD state to be further actioned by customer services (this can be configured to complete automatically regardless of the state the product is in).

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Return Reason Id	Return Reason	Condition that the item is expected to be in on return
1	`UNWANTED`	`PRISTINE`
2	`ARRIVED TOO LATE`	`PRISTINE`
3	`INCORRECT ITEM RECEIVED`	`PRISTINE`
4	`DAMAGED ON ARRIVAL`	`DAMAGED`
5	`POOR QUALITY`	`FAULTY`
6	`FAULTY`	`FAULTY`
7	`LOOKS DIFFERENT TO IMAGE ON SITE`	`PRISTINE`
8	`ORDERED MORE THAN ONE SIZE`	`PRISTINE`
9	`DOESN'T FIT PROPERLY`	`PRISTINE`
10	`INCORRECT ITEM ORDERED`	`PRISTINE`
11	`UNEXPECTED - CUSTOMER RETURN`	No expected state - this is an unexpected return so the product could be in any state.
12	`UNEXPECTED - COURIER RETURN`	No expected state - this is an unexpected return so the product could be in any state.
40	`SECURITY TAG ON PRODUCT`	`FAULTY`

","_postman_id":"5fc12856-a917-4e9f-ae40-34c2c1b185b6"},{"name":"Stock","item":[{"name":"Outbound","item":[{"name":"Send Stock Adjustments to Client","id":"b334d345-8510-4eea-ae66-3ee0a7c3fe82","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"url":"/stock/adjustments","description":"

The outbound Stock Adjustment request that allows a client to expose a webhook which accepts messages from the Ingenuity API for every stock adjustment which occurs.

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
stockAdjustmentId	integer	The unique identifier for the stock adjustment.
warehouseReference	string	The identifier passed from the warehouse.
productId	integer	The THG Product ID of the product.
warehouseId	integer	The THG warehouse identifier.
quantity	integer	The quantity of stock adjusted.
stockOwnerId	integer	The THG stock owner identifier for this stock.
fromStatus	string	The previous status of the stock.
toStatus	string	The new status of the stock.
reasonCode	string	The reasonCode for the stock adjustment.
adjustmentDate	DateTime	The date and time that the stock adjustment occurred. Format: yyyy-MM-ddTHH:mm:ssZ
adjustmentProcessedDate	DateTime	The date and time that the stock adjustment was processed and stock position updated. Format: yyyy-MM-ddTHH:mm:ssZ
batch	string	The batch of the stock that was adjusted.
expiryDate	DateTime	The date and time of expiry of the stock that was adjusted. Format: yyyy-MM-ddTHH:mm:ssZ
identifiers	List	This would include the list of identifier types (such as Serial Number or IMEI) and their values associated with each stock-adjusted unit.

identifiers (List of Identifiers consisting identifierType and identifierValues)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
identifierType	String	SERIAL_NUMBER, IMEI or any other Identifier Types
identifierValues	List < String >	List of Identifier Values eg list of Serial numbers : A00JA116D33108, or List of IMEI numbers : 302620123436735

Request Schema

{\n         \"type\":\"object\",\n         \"properties\":{\n            \"stockAdjustmentId\":{\n               \"type\":\"integer\",\n               \"description\":\"The unique identifier for the stock adjustment\"\n            },\n            \"warehouseReference\":{\n               \"type\":\"string\",\n               \"description\":\"The unique identifier from the warehouse\"\n            },\n            \"productId\":{\n               \"type\":\"integer\",\n               \"description\":\"The unique identifier for the product\"\n            },\n            \"warehouseId\":{\n               \"type\":\"integer\",\n               \"description\":\"The unique identifier for the warehouse\"\n            },\n            \"quantity\":{\n               \"type\":\"integer\",\n               \"description\":\"The quantity of stock adjustment\"\n            },\n            \"stockOwnerId\":{\n               \"type\":\"integer\",\n               \"description\":\"The unique identifier for the stock owner\"\n            },\n            \"fromStatus\":{\n               \"type\":\"string\",\n               \"description\":\"The previous status of the stock\"\n            },\n            \"toStatus\":{\n               \"type\":\"string\",\n               \"description\":\"The new status of the stock\"\n            },\n            \"reasonCode\":{\n               \"type\":\"string\",\n               \"description\":\"The code for the stock adjustment reason\"\n            },\n            \"adjustmentDate\":{\n               \"type\":\"DateTime\",\n               \"format\":\"date-time\",\n               \"description\":\"The date and time of the stock adjustment\"\n            },\n            \"adjustmentProcessedDate\":{\n               \"type\":\"DateTime\",\n               \"format\":\"date-time\",\n               \"description\":\"The date and time that the stock adjustment was processed and stock position updated.\"\n            },\n            \"batch\":{\n               \"type\":\"string\",\n               \"description\":\"The batch of the stock that was adjusted\"\n            },\n            \"expiryDate\":{\n               \"type\":\"DateTime\",\n               \"format\":\"date-time\",\n               \"description\":\"The date and time of expiry of the stock that was adjusted\"\n            },\n            \"identifiers\":{\n                \"type\":\"Object\",\n                \"format\":\"identifier\",\n                \"description\":\"List of Identifer Types and their Values like IMEI and Serial Numbers of the Stock units that was adjusted\"\n            }\n         }\n      }\n\n

\n","urlObject":{"path":["stock","adjustments"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"f18ea520-28a2-452e-91ab-130aefd5f21c","name":"Success","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json","type":"text"}],"body":{"mode":"raw","raw":"[\n {\n \"stockAdjustmentId\":123456,\n \"warehouseReference\":\"whRef1234\",\n \"productId\":1234567,\n \"warehouseId\":99,\n \"quantity\":10,\n \"stockOwnerId\": 200,\n \"fromStatus\": \"NOT_SPECIFIED\",\n \"toStatus\": \"GOOD\",\n \"reasonCode\":\"P4\",\n \"adjustmentDate\":\"2026-01-01T01:10:07.000Z\",\n \"adjustmentProcessedDate\":\"2026-01-01T01:10:27.000Z\",\n \"batch\": \"BATCH-2026-01-01\",\n \"expiryDate\": \"2026-01-12T01:10:27.000Z\",\n \"identifiers\": [\n {\n \"identifierType\": \"IMEI\",\n \"identifierValues\": [\"1000000041\",\"1000000042\"]\n },\n {\n \"identifierType\": \"SERIAL_NUMBER\",\n \"identifierValues\": [\"SN12345678A016\",\"SN12345678A017\",\"SN12345678A018\"]\n }\n ]\n }\n]","options":{"raw":{"language":"json"}}},"url":"/stock/adjustments"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"stockAdjustmentId\":123456,\n \"warehouseReference\":\"whRef1234\",\n \"productId\":1234567,\n \"warehouseId\":99,\n \"quantity\":10,\n \"stockOwnerId\": 200,\n \"fromStatus\": \"NOT_SPECIFIED\",\n \"toStatus\": \"GOOD\",\n \"reasonCode\":\"P4\",\n \"adjustmentDate\":\"2026-01-01T01:10:07.000Z\",\n \"adjustmentProcessedDate\":\"2026-01-01T01:10:27.000Z\",\n \"batch\": \"BATCH-2026-01-01\",\n \"expiryDate\": \"2026-01-12T01:10:27.000Z\",\n \"identifiers\": [\n {\n \"identifierType\": \"IMEI\",\n \"identifierValues\": [\"1000000041\",\"1000000042\"]\n },\n {\n \"identifierType\": \"SERIAL_NUMBER\",\n \"identifierValues\": [\"SN12345678A016\",\"SN12345678A017\",\"SN12345678A018\"]\n }\n ]\n }\n]"}],"_postman_id":"b334d345-8510-4eea-ae66-3ee0a7c3fe82"}],"id":"1bbdc811-3a2e-4064-8b43-eb45c20e3fa4","description":"

Endpoints in the 'Outbound' folder are requests which can be sent from THG Ingenuity API to a client URL.

The client must provide the URL to hit with each request and any authentication method which is required.

\n","_postman_id":"1bbdc811-3a2e-4064-8b43-eb45c20e3fa4"},{"name":"Hold Warehouse Stock Status for Product (Upcoming)","id":"ef6e235c-4fcb-49e2-8112-33ab488915e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"POST","header":[{"key":"accept","value":"application/json"},{"key":"organisation","value":"client-name"}],"body":{"mode":"raw","raw":"{\n \"clientRequestReference\": \"ABC-123456789\",\n \"productId\": \"50000012045\",\n \"warehouseId\" : 31,\n \"toStatus\": \"QA\",\n \"batch\": \"BATCH-001\"\n}","options":{"raw":{"language":"json"}}},"url":"/v1/stock/status","description":"

The purpose of this API call is to enable clients to hold warehouse stock for a given product based on operational statuses such as KITTING, AGED, QA, QC.

Move stock into a Hold state (non-sellable)

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Field	Type	Mandatory	Description
clientRequestReference	String upto 20 Chars	Y	Idempotency reference from client
productId	String	Y	Unique product identifier. This can be either the Barcode or the THG Product ID, depending on which attribute is configured for the organisation during setup.
warehouseId	Integer	Y	The \"warehouseId\" field is an integer and is the external client warehouseId that is mapped to an internal THG warehouseId.
toStatus	ENUM	Y	Target stock status : KITTING, AGED, QA, QC
batch	String	N	Batch identifier

Response :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Description
202	Accepted
400	Invalid request / enum value or Request Attribute Type , Invalid Organisation
404	Product Id or Barcode not found
409	Duplicate Request . The client request reference has already been successfully held.
500	Internal server error

","urlObject":{"path":["v1","stock","status"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"8762ffac-c8c8-47e3-8bbe-b2541ae5f3c9","name":"HTTP 202","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"organisation","value":"maurten","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientRequestReference\": \"ABC-123456789\",\n \"productId\": \"50000012045\",\n \"warehouseId\" : 31,\n \"toStatus\": \"QA\",\n \"batch\": \"BATCH-001\"\n}","options":{"raw":{"language":"json"}}},"url":"/v1/stock/status"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\"Hold client request ABC-123456789 accepted for processing\""},{"id":"870e53c2-56e8-49d1-b2fe-ca4c28937179","name":"HTTP 400 Invalid Status","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"organisation","value":"maurten","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientRequestReference\": \"ABC-123456789\",\n \"productId\": \"50000012045\",\n \"warehouseId\" : 31,\n \"toStatus\": \"XXXXXX\",\n \"batch\": \"BATCH-001\"\n}","options":{"raw":{"language":"json"}}},"url":"/v1/stock/status"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\"Invalid status. Please provide a valid Status value.\""},{"id":"0ff5d108-fb76-414f-bcc8-5a575228886c","name":"HTTP 400 Invalid Organisation","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"rganisation","value":"invalidClientName","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientRequestReference\": \"ABC-123456789\",\n \"productId\": \"50000012045\",\n \"warehouseId\" : 31,\n \"toStatus\": \"QA\",\n \"batch\": \"BATCH-001\"\n}","options":{"raw":{"language":"json"}}},"url":"/v1/stock/status"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\"Invalid organisation or no stock owner mapping found for organisation: invalidClientName\""},{"id":"e6464e37-73af-4547-a879-28aade391bec","name":"HTTP 400 Invalid WarehouseId","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientRequestReference\": \"ABC-123456789\",\n \"productId\": \"50000012045\",\n \"warehouseId\" : 123213,\n \"toStatus\": \"QC\",\n \"batch\": \"BATCH-001\"\n}","options":{"raw":{"language":"json"}}},"url":"/v1/stock/status"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\"Invalid warehouse ID: 123213. Warehouse not found\""},{"id":"d33a7cf5-bc38-4e13-85a4-19997c69115a","name":"HTTP 404 Invalid ProductId or Barcode","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientRequestReference\": \"ABC-123456789\",\n \"productId\": \"500000120459898989898\",\n \"warehouseId\" : 31,\n \"toStatus\": \"QC\",\n \"batch\": \"BATCH-001\"\n}","options":{"raw":{"language":"json"}}},"url":"/v1/stock/status"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\"Product not found for the given external product ID: 500000120459898989898\""},{"id":"ee24b943-4073-494c-9e1e-cca24e27f41b","name":"HTTP 404 Hold Request with Another Status exists","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientRequestReference\": \"ABC-123456789\",\n \"productId\": \"50000012045\",\n \"warehouseId\" : 31,\n \"toStatus\": \"QC\",\n \"batch\": \"BATCH-001\"\n}","options":{"raw":{"language":"json"}}},"url":"/v1/stock/status"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\"Hold cannot be placed because a request already exists for the same product, batch and warehouse with status: {{EXISTING_REQUEST_STATUS}\""},{"id":"72d8a809-d8b4-4256-b922-cc6cdb617bcc","name":"HTTP 404 Hold Request with Empty Batch Request When Batch request exists","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientRequestReference\": \"ABC-123456789\",\n \"productId\": \"50000012045\",\n \"warehouseId\" : 31,\n \"toStatus\": \"QC\",\n \"batch\": \"\"\n}","options":{"raw":{"language":"json"}}},"url":"/v1/stock/status"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\"Hold cannot be placed because a request already exists for the same product and warehouse with status: {{EXISTING_REQUEST_STATUS}\""},{"id":"97b5e107-238c-4d9a-b431-c8565e197e0a","name":"HTTP 404 Hold Request when Full Stock hold Exists","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientRequestReference\": \"ABC-123456789\",\n \"productId\": \"50000012045\",\n \"warehouseId\" : 31,\n \"toStatus\": \"QC\",\n \"batch\": \"BATCH-001\"\n}","options":{"raw":{"language":"json"}}},"url":"/v1/stock/status"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\"Hold cannot be placed when full stock hold already exists for the same product, warehouse and with status: {{EXISTING_REQUEST_STATUS}}\""},{"id":"e62d466c-47e5-4c92-a5bb-01412ba5b6a1","name":"HTTP 409 Duplicate Client request Reference","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientRequestReference\": \"ABC-123456789\",\n \"productId\": \"50000012045\",\n \"warehouseId\" : 31,\n \"toStatus\": \"QC\",\n \"batch\": \"BATCH-001\"\n}","options":{"raw":{"language":"json"}}},"url":"/v1/stock/status"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\"Duplicate client request reference\""},{"id":"51c7d7e0-449c-433c-abae-bfcb02928d4c","name":"HTTP 500 Internal Server Error","originalRequest":{"method":"POST","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"},{"key":"Content-Type","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"}],"body":{"mode":"raw","raw":"{\n \"clientRequestReference\": \"ABC-123456789\",\n \"productId\": \"50000012045\",\n \"warehouseId\" : 31,\n \"toStatus\": \"QC\",\n \"batch\": \"BATCH-001\"\n}","options":{"raw":{"language":"json"}}},"url":"/v1/stock/status"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\"Internal server error occurred\""}],"_postman_id":"ef6e235c-4fcb-49e2-8112-33ab488915e8"},{"name":"Unhold Warehouse Stock Status for Product (Upcoming)","id":"3c568f62-c59f-4106-9f1e-01e2a6ae8484","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"DELETE","header":[{"key":"accept","value":"application/json"},{"key":"organisation","value":"client-name"}],"url":"/v1/stock/status/{{clientRequestReference}}","description":"

The purpose of this API call is to enable clients to unhold warehouse stock for a given product from operational statuses such as KITTING, AGED, QA, QC to Good

Move stock back to GOOD (sellable)

Response :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Description
202	Accepted
400	Invalid request or Invalid Organisation
404	Client Request Reference Not Found
409	Duplicate Request . The client request reference has already been successfully unheld.
500	Internal server error

","urlObject":{"path":["v1","stock","status","{{clientRequestReference}}"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"b598d003-08e7-4ce0-9055-6fa20d486452","name":"HTTP 202","originalRequest":{"method":"DELETE","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"}],"url":"/v1/stock/status/ABC-123456789"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\"Unhold client request ABC-123456789 accepted for processing\""},{"id":"34eb0936-99fe-4fee-9a1a-393a390f0059","name":"HTTP 404 Invalid Client request reference","originalRequest":{"method":"DELETE","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"}],"url":"/v1/stock/status/ABC-12345678923"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\"No hold request with client request reference: ABC-1234560 found\""},{"id":"2de63e6a-7a39-40fb-8579-b7b50f4c8bae","name":"HTTP 400 Invalid Organisation","originalRequest":{"method":"DELETE","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"}],"url":"/v1/stock/status/ABC-12345678923"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\"Invalid organisation or no stock owner mapping found for organisation: {{invalid_Organisation}}\""},{"id":"0623a0d1-209d-40ee-89ab-95706ce87e13","name":"HTTP 409 Duplicate Client Request Reference","originalRequest":{"method":"DELETE","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"}],"url":"/v1/stock/status/ABC-12345678923"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\"The client request with reference ABC-1234560 has already been unheld.\""},{"id":"5150725e-2ec6-4379-83cc-33d815a9e0c1","name":"HTTP 500 Internal Server","originalRequest":{"method":"DELETE","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"}],"url":"/v1/stock/status/ABC-12345678923"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\"Internal server error occurred\""}],"_postman_id":"3c568f62-c59f-4106-9f1e-01e2a6ae8484"},{"name":"Get All Hold Unhold Client Requests for an Organisation (Upcoming)","id":"273cf072-4ba6-4d15-96fa-032424182422","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{"token":""},"isInherited":false},"method":"GET","header":[{"key":"accept","value":"application/json"},{"key":"organisation","value":"client-name"}],"url":"/v1/stock/statuses?pageNumber={{PAGE_NUMBER}}&pageSize={{PAGE_SIZE}}&fromDate={{FROM_DATE}}&toDate={{TO_DATE}}&status={{HOLD_STATUS}}","description":"

Retrieve All Hold Unhold Client Requests for an Organisation

This endpoint retrieves all the Hold and Unhold Client requests for an organisation based on request parameters . User can filter the records based on fromDate and toDate and also based on hold status.

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Mandatory	Description
pageNumber	int	N	The page number to retrieve. Default is 1.
pageSize	int	N	Number of records to return per page. Default is 20.
fromDate	LocalDate	N	Filter records starting from date
toDate	LocalDate	N	Filter records until date
status	String	N	Hold Unhold Statuses

Response :

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Description
200	ok
400	Invalid request or Invalid Organisation
500	Internal server error

Response Body

Pagination

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
page	Integer	Yes	The current page number.
size	Integer	Yes	The current page size.
totalPages	Integer	Yes	The total number of pages.
totalElements	Integer	Yes	The total number of Hold unhold requests based on the provided filtering criteria.
hasNext	Boolean	Yes	Boolean value whether it has next page
hasPrevious	Boolean	Yes	Boolean value whether it has previous page
first	Boolean	Yes	Boolean value whether its first page.
last	Boolean	Yes	Boolean value whether its last page.

Records

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
clientRequestReference	String	Yes	Idempotency reference from client
requestType	String	Yes	Request Types (Hold/Unhold)
externalProductId	String	Yes	Unique Identifier for a ProductId. It might be either barcode or THG product id configured for Client
productId	Integer	Yes	Unique Identifier for a ProductId . This is THG productId
warehouseId	Integer	Yes	Unique Identifier for a Warehouse
toStatus	String	Yes	Different Hold or Unhold Statuses.
batch	String	Yes	Batch Identifier
error	Boolean	Yes	Boolean flag indicating whether an error occurred
errorMessage	String	Yes	Error Message
receivedDate	LocalDate	Yes	Date when the request is received.

Response Schema

{\n  \"type\": \"object\",\n  \"required\": [\n    \"records\",\n    \"page\",\n    \"size\",\n    \"totalElements\",\n    \"totalPages\",\n    \"first\",\n    \"last\",\n    \"hasNext\",\n    \"hasPrevious\"\n  ],\n  \"properties\": {\n    \"records\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"object\",\n        \"required\": [\n          \"clientRequestReference\",\n          \"requestType\",\n          \"externalProductId\",\n          \"productId\",\n          \"warehouseId\",\n          \"toStatus\",\n          \"batch\",\n          \"error\",\n          \"receivedDate\"\n        ],\n        \"properties\": {\n          \"clientRequestReference\": {\n            \"type\": \"string\"\n          },\n          \"requestType\": {\n            \"type\": \"string\",\n            \"enum\": [\"HOLD\", \"UNHOLD\"]\n          },\n          \"externalProductId\": {\n            \"type\": \"string\"\n          },\n          \"productId\": {\n            \"type\": \"integer\"\n          },\n          \"warehouseId\": {\n            \"type\": \"integer\"\n          },\n          \"toStatus\": {\n            \"type\": \"string\"\n          },\n          \"batch\": {\n            \"type\": \"string\"\n          },\n          \"error\": {\n            \"type\": \"boolean\"\n          },\n          \"errorMessage\": {\n            \"type\": [\"string\", \"null\"]\n          },\n          \"receivedDate\": {\n            \"type\": \"string\",\n            \"format\": \"date-time\"\n          }\n        }\n      }\n    },\n    \"page\": {\n      \"type\": \"integer\",\n      \"minimum\": 0\n    },\n    \"size\": {\n      \"type\": \"integer\",\n      \"minimum\": 1\n    },\n    \"totalElements\": {\n      \"type\": \"integer\",\n      \"minimum\": 0\n    },\n    \"totalPages\": {\n      \"type\": \"integer\",\n      \"minimum\": 0\n    },\n    \"first\": {\n      \"type\": \"boolean\"\n    },\n    \"last\": {\n      \"type\": \"boolean\"\n    },\n    \"hasNext\": {\n      \"type\": \"boolean\"\n    },\n    \"hasPrevious\": {\n      \"type\": \"boolean\"\n    }\n  }\n}\n\n

\n","urlObject":{"path":["v1","stock","statuses"],"host":[""],"query":[{"key":"pageNumber","value":"{{PAGE_NUMBER}}"},{"key":"pageSize","value":"{{PAGE_SIZE}}"},{"key":"fromDate","value":"{{FROM_DATE}}"},{"key":"toDate","value":"{{TO_DATE}}"},{"key":"status","value":"{{HOLD_STATUS}}"}],"variable":[]}},"response":[{"id":"1c1794ae-e5f0-4a78-af1a-7bc5a42c8009","name":"HTTP 200","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"}],"url":{"raw":"/v1/stock/statuses?pageNumber=1&pageSize=10&fromDate=2025-01-01&toDate=2025-01-31&status=QC","host":[""],"path":["v1","stock","statuses"],"query":[{"key":"pageNumber","value":"1"},{"key":"pageSize","value":"10"},{"key":"fromDate","value":"2025-01-01"},{"key":"toDate","value":"2025-01-31"},{"key":"status","value":"QC"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"records\": [\n {\n \"clientRequestReference\": \"ABC-123456782\",\n \"requestType\": \"UNHOLD\",\n \"externalProductId\": \"12255620\",\n \"productId\": 12255620,\n \"warehouseId\": 31,\n \"toStatus\": \"GOOD\",\n \"batch\": \"BATCH-003\",\n \"error\": false,\n \"errorMessage\": null,\n \"receivedDate\": \"2026-03-16T23:23:07.147406\"\n },\n {\n \"clientRequestReference\": \"ABC-123456787\",\n \"requestType\": \"HOLD\",\n \"externalProductId\": \"12255620\",\n \"productId\": 12255620,\n \"warehouseId\": 31,\n \"toStatus\": \"QA\",\n \"batch\": \"BATCH-004\",\n \"error\": false,\n \"errorMessage\": null,\n \"receivedDate\": \"2026-03-16T22:08:42.72006\"\n },\n {\n \"clientRequestReference\": \"ABC-123456786\",\n \"requestType\": \"HOLD\",\n \"externalProductId\": \"12255620\",\n \"productId\": 12255620,\n \"warehouseId\": 31,\n \"toStatus\": \"QC\",\n \"batch\": \"BATCH-004\",\n \"error\": true,\n \"errorMessage\": \"Stock hold failed: server error - 500 : \\\"{\\\"timestamp\\\":1773697405649,\\\"status\\\":500,\\\"error\\\":\\\"Internal Server Error\\\",\\\"path\\\":\\\"/StockManager/stock/warehouse-stock/status/external-hold-stock\\\"}\\\"\",\n \"receivedDate\": \"2026-03-16T21:43:25.31534\"\n }\n ],\n \"page\": 0,\n \"size\": 10,\n \"totalElements\": 14,\n \"totalPages\": 2,\n \"first\": true,\n \"last\": false,\n \"hasNext\": true,\n \"hasPrevious\": false\n}"},{"id":"20f725f0-4c1d-4bed-a501-aa373f41a5c3","name":"HTTP 200 No Records","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"}],"url":{"raw":"/v1/stock/statuses?pageNumber=1&pageSize=10&fromDate=2025-01-01&toDate=2025-01-31&status=QC","host":[""],"path":["v1","stock","statuses"],"query":[{"key":"pageNumber","value":"1"},{"key":"pageSize","value":"10"},{"key":"fromDate","value":"2025-01-01"},{"key":"toDate","value":"2025-01-31"},{"key":"status","value":"QC"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"records\": [],\n \"page\": 3,\n \"size\": 10,\n \"totalElements\": 14,\n \"totalPages\": 2,\n \"first\": false,\n \"last\": true,\n \"hasNext\": false,\n \"hasPrevious\": true\n}"},{"id":"2a5a88ac-470f-4253-b7e9-55e5bcdd1f73","name":"400 Invalid Status","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"}],"url":{"raw":"/v1/stock/statuses?pageNumber=1&pageSize=10&fromDate=2025-01-01&toDate=2025-01-31&status=EXPIRED","host":[""],"path":["v1","stock","statuses"],"query":[{"key":"pageNumber","value":"1"},{"key":"pageSize","value":"10"},{"key":"fromDate","value":"2025-01-01"},{"key":"toDate","value":"2025-01-31"},{"key":"status","value":"EXPIRED"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\"Invalid status. Please provide a valid Status value.\""},{"id":"0e4867aa-da1a-44e9-8c0a-459369f398e4","name":"400 Invalid Date format","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"}],"url":{"raw":"/v1/stock/statuses?pageNumber=1&pageSize=10&fromDate=2025/01/01&toDate=2025/01/31&status=QA","host":[""],"path":["v1","stock","statuses"],"query":[{"key":"pageNumber","value":"1"},{"key":"pageSize","value":"10"},{"key":"fromDate","value":"2025/01/01"},{"key":"toDate","value":"2025/01/31"},{"key":"status","value":"QA"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\"Invalid fromDate or ToDate. Please provide input in valid Date format (YYYY-MM-DD).\""},{"id":"2f50f254-c6a0-43d9-9e4d-ee855bab8552","name":"400 FromDate after Todate","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"}],"url":{"raw":"/v1/stock/statuses?pageNumber=1&pageSize=10&fromDate=2026-05-01&toDate=2026-01-31&status=QA","host":[""],"path":["v1","stock","statuses"],"query":[{"key":"pageNumber","value":"1"},{"key":"pageSize","value":"10"},{"key":"fromDate","value":"2026-05-01"},{"key":"toDate","value":"2026-01-31"},{"key":"status","value":"QA"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\"fromDate cannot be after toDate\""}],"_postman_id":"273cf072-4ba6-4d15-96fa-032424182422"},{"name":"Stock Availability","id":"69f8c6a0-c2f0-4725-8e94-7568c75e54b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{},"isInherited":false},"method":"GET","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"}],"url":"/v1/availability/productId/{{productId}}","description":"

Retrieve Current Stock Availability

This endpoint retrieves stock availability for a specific productId. There are many possible stock statuses which may be included in the Response Body - all of which are listed below. Any status with a non-zero quantity will be returned, zero quantity statuses may also be returned.

Each status e.g. good has a corresponding Allocated status, e.g. goodAllocated. The quantity of stock listed in good includes the quantity listed in goodAllocated.

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
`productId`	string	The THG Product ID of the product.

Response Body

Property	Type	Description
`warehouseId`	integer	The THG Warehouse identifier
`good`	integer	The total count of stock in the GOOD status. This includes the `goodAllocated` stock.
`goodAllocated`	integer	The total count of stock in the GOOD status allocated to orders.
`held`	integer	The total count of stock in the HELD status. This includes the `heldAllocated` stock.
`heldAllocated`	integer	The total count of stock in the HELD status allocated to orders.
`damaged`	integer	The total count of stock in the DAMAGED status. This includes the `damagedAllocated` stock.
`damagedAllocated`	integer	The total count of stock in the DAMAGED status allocated to orders.
`transit`	integer	The total count of stock in the TRANSIT status. This includes the `transitAllocated` stock.
`transitAllocated`	integer	The total count of stock in the TRANSIT status allocated to orders.
`transfer`	integer	The total count of stock in the TRANSFER status. This includes the `transferAllocated` stock.
`transferAllocated`	integer	The total count of stock in the TRANSFER status allocated to orders.
`return`	integer	The total count of stock in the RETURN status. This includes the `returnAllocated` stock.
`returnAllocated`	integer	The total count of stock in the RETURN status allocated to orders.
`qc`	integer	The total count of stock in the QC status. This includes the `qcAllocated` stock.
`qcAllocated`	integer	The total count of stock in the QC status allocated to orders.
`qa`	integer	The total count of stock in the QA status. This includes the `qaAllocated` stock.
`qaAllocated`	integer	The total count of stock in the QA status allocated to orders.
`kitting`	integer	The total count of stock in the KITTING status. This includes the `kittingAllocated` stock.
`kittingAllocated`	integer	The total count of stock in the KITTING status allocated to orders.
`expired`	integer	The total count of stock in the EXPIRED status. This includes the `expiredAllocated` stock.
`expiredAllocated`	integer	The total count of stock in the EXPIRED status allocated to orders.

Response Schema

{\n   \"type\":\"array\",\n   \"items\":[\n      {\n         \"type\":\"object\",\n         \"properties\":{\n            \"warehouseId\":{\n               \"type\":\"integer\",\n               \"description\":\"The warehouse identifier\"\n            },\n            \"good\":{\n               \"type\":\"integer\",\n               \"description\":\"The amount of good stock in this warehouse\"\n            },\n            \"allocated\":{\n               \"type\":\"integer\",\n               \"description\":\"The amount of stock already allocated to orders\"\n            },\n            \"held\":{\n               \"type\":\"integer\",\n               \"description\":\"The amount of held stock in this warehouse\"\n            },\n            \"damaged\":{\n               \"type\":\"integer\",\n               \"description\":\"The amount of damaged stock in this warehouse\"\n            }\n         }\n      }\n   ]\n}\n\n

\n","urlObject":{"path":["v1","availability","productId","{{productId}}"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"40d1d46b-5dfb-4544-9188-8538d106aee1","name":"HTTP 200","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"}],"url":"/v1/availability/productId/1234567"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"warehouseId\": 99,\n \"good\": 1000,\n \"goodAllocated\": 120,\n \"held\": 0,\n \"heldAllocated\": 0,\n \"damaged\": 2,\n \"damagedAllocated\": 0\n },\n {\n \"warehouseId\": 98,\n \"good\": 10,\n \"goodAllocated\": 0,\n \"held\": 1,\n \"heldAllocated\": 0\n }\n]"}],"_postman_id":"69f8c6a0-c2f0-4725-8e94-7568c75e54b2"},{"name":"Warehouse Stock","id":"b2ec08a2-f97c-42c0-b202-f8450f1e5aa1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{},"isInherited":false},"method":"GET","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"}],"url":"/v2/stock/warehouse/{{warehouseId}}?pageNumber=1&pageSize=10","description":"

Retrieve Current Stock Position for Stock in a Single Warehouse

This endpoint retrieves the current stock position for all of the calling organisation's stock in a given warehouseId. There are many possible stock statuses which may be included in the Response Body - all of which are listed below. Any status with a non-zero quantity will be returned, zero quantity statuses may also be returned.

Each status e.g. good has a corresponding Allocated status, e.g. goodAllocated. The quantity of stock listed in good includes the quantity listed in goodAllocated.

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Mandatory	Description
`warehouseId`	int	Y	The THG Warehouse ID to be returned.

Query Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Mandatory	Description
`pageNumber`	int	N	The page number to retrieve. Default is 1.
`pageSize`	int	N	Number of records to return per page.

Response Body

Property	Type	Description
`productId`	integer	The THG Product ID.
`good`	integer	The total count of stock in the GOOD status. This includes the `goodAllocated` stock.
`goodAllocated`	integer	The total count of stock in the GOOD status allocated to orders.
`held`	integer	The total count of stock in the HELD status. This includes the `heldAllocated` stock.
`heldAllocated`	integer	The total count of stock in the HELD status allocated to orders.
`damaged`	integer	The total count of stock in the DAMAGED status. This includes the `damagedAllocated` stock.
`damagedAllocated`	integer	The total count of stock in the DAMAGED status allocated to orders.
`transit`	integer	The total count of stock in the TRANSIT status. This includes the `transitAllocated` stock.
`transitAllocated`	integer	The total count of stock in the TRANSIT status allocated to orders.
`transfer`	integer	The total count of stock in the TRANSFER status. This includes the `transferAllocated` stock.
`transferAllocated`	integer	The total count of stock in the TRANSFER status allocated to orders.
`return`	integer	The total count of stock in the RETURN status. This includes the `returnAllocated` stock.
`returnAllocated`	integer	The total count of stock in the RETURN status allocated to orders.
`qc`	integer	The total count of stock in the QC status. This includes the `qcAllocated` stock.
`qcAllocated`	integer	The total count of stock in the QC status allocated to orders.
`qa`	integer	The total count of stock in the QA status. This includes the `qaAllocated` stock.
`qaAllocated`	integer	The total count of stock in the QA status allocated to orders.
`kitting`	integer	The total count of stock in the KITTING status. This includes the `kittingAllocated` stock.
`kittingAllocated`	integer	The total count of stock in the KITTING status allocated to orders.
`expired`	integer	The total count of stock in the EXPIRED status. This includes the `expiredAllocated` stock.
`expiredAllocated`	integer	The total count of stock in the EXPIRED status allocated to orders.

Response Schema

{\n   \"type\":\"array\",\n   \"items\":[\n      {\n         \"type\":\"object\",\n         \"properties\":{\n            \"productId\":{\n               \"type\":\"integer\",\n               \"description\":\"The THG Product identifier\"\n            },\n            \"good\":{\n               \"type\":\"integer\",\n               \"description\":\"The amount of good stock in this warehouse\"\n            },\n            \"goodAllocated\":{\n               \"type\":\"integer\",\n               \"description\":\"The amount of good stock allocated to orders\"\n            }\n         }\n      }\n   ]\n}\n\n

\n","urlObject":{"path":["v2","stock","warehouse","{{warehouseId}}"],"host":[""],"query":[{"description":{"content":"

Page number to retrieve - starts from 1.

\n","type":"text/plain"},"key":"pageNumber","value":"1"},{"description":{"content":"

Number of records to return per page.

\n","type":"text/plain"},"key":"pageSize","value":"10"}],"variable":[]}},"response":[{"id":"a24210e9-27f2-4e55-8581-8e54ae2928fc","name":"200 Records Returned","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"}],"url":{"raw":"/v2/stock/warehouse/90?pageNumber=1&pageSize=10","host":[""],"path":["v2","stock","warehouse","90"],"query":[{"key":"pageNumber","value":"1"},{"key":"pageSize","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"11223344\": {\n \"good\": 100,\n \"goodAllocated\": 0,\n \"held\": 0,\n \"heldAllocated\": 0,\n \"damaged\": 0,\n \"damagedAllocated\": 0,\n \"transit\": 0,\n \"transitAllocated\": 0,\n \"transfer\": 0,\n \"transferAllocated\": 0,\n \"return\": 0,\n \"returnAllocated\": 0,\n \"qc\": 0,\n \"qcAllocated\": 0,\n \"qa\": 0,\n \"qaAllocated\": 0,\n \"kitting\": 0,\n \"kittingAllocated\": 0,\n \"expired\": 0,\n \"expiredAllocated\": 0\n },\n \"11223345\": {\n \"good\": 78,\n \"goodAllocated\": 0,\n \"held\": 0,\n \"heldAllocated\": 0,\n \"damaged\": 0,\n \"damagedAllocated\": 0,\n \"transit\": 0,\n \"transitAllocated\": 0,\n \"transfer\": 0,\n \"transferAllocated\": 0,\n \"return\": 0,\n \"returnAllocated\": 0,\n \"qc\": 0,\n \"qcAllocated\": 0,\n \"qa\": 0,\n \"qaAllocated\": 0,\n \"kitting\": 0,\n \"kittingAllocated\": 0,\n \"expired\": 0,\n \"expiredAllocated\": 0\n }\n }\n]"},{"id":"96d381fb-cce9-4687-88ee-5b8211f4f673","name":"200 No Records","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"}],"url":{"raw":"/v2/stock/warehouse/31?pageNumber=1&pageSize=10","host":[""],"path":["v2","stock","warehouse","31"],"query":[{"key":"pageNumber","value":"1"},{"key":"pageSize","value":"10"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {}\n]"},{"id":"2d99a9b4-ae76-474d-8fab-daa4f53bd1a3","name":"404 Not Found","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"}],"url":{"raw":"/v2/stock/warehouse/0?pageNumber=1&pageSize=10","host":[""],"path":["v2","stock","warehouse","0"],"query":[{"key":"pageNumber","value":"1"},{"key":"pageSize","value":"10"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n \"Warehouse not found for warehouse id 0\"\n]"}],"_postman_id":"b2ec08a2-f97c-42c0-b202-f8450f1e5aa1"},{"name":"Get Stock Adjustment by ID","id":"c76a928f-9847-444c-84c2-ba9b2549c293","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"auth":{"type":"bearer","bearer":{},"isInherited":false},"method":"GET","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"}],"url":"/v1/stock/adjustments/stockadjustmentid/{{stockAdjustmentId}}","description":"

Retrieve a Stock Adjustment by its ID

This endpoint retrieves a stock adjustment by its stockAdjustmentId.

Request Parameters

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
stockAdjustmentId	integer	The unique identifier for the stock adjustment.

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
stockAdjustmentId	integer	The unique identifier for the stock adjustment.
warehouseReference	string	The identifier passed from the warehouse.
productId	integer	The THG Product ID of the product.
warehouseId	integer	The THG warehouse identifier.
quantity	integer	The quantity of stock adjusted.
stockOwnerId	integer	The THG stock owner identifier for this stock.
fromStatus	string	The previous status of the stock.
toStatus	string	The new status of the stock.
reasonCode	string	The reasonCode for the stock adjustment.
adjustmentDate	DateTime	The date and time that the stock adjustment occurred. Format: yyyy-MM-ddTHH:mm:ssZ
adjustmentProcessedDate	DateTime	The date and time that the stock adjustment was processed and stock position updated. Format: yyyy-MM-ddTHH:mm:ssZ
batch	string	The batch of the stock that was adjusted.
expiryDate	DateTime	The date and time of expiry of the stock that was adjusted. Format: yyyy-MM-ddTHH:mm:ssZ
identifiers	List	This would include the list of identifier types (such as Serial Number or IMEI) and their values associated with each stock-adjusted unit.

identifiers (List of Identifiers consisting identifierType and identifierValues)

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
identifierType	String	SERIAL_NUMBER, IMEI or any other Identifier Types
identifierValues	List < String >	List of IdentifierValues eg list of Serial numbers : A00JA116D33108, or List of IMEI numbers : 302620123436735

Response Schema

{\n   \"type\":\"array\",\n   \"items\":[\n      {\n         \"type\":\"object\",\n         \"properties\":{\n            \"stockAdjustmentId\":{\n               \"type\":\"integer\",\n               \"description\":\"The unique identifier for the stock adjustment\"\n            },\n            \"warehouseReference\":{\n               \"type\":\"string\",\n               \"description\":\"The unique identifier from the warehouse\"\n            },\n            \"productId\":{\n               \"type\":\"integer\",\n               \"description\":\"The unique identifier for the product\"\n            },\n            \"quantity\":{\n               \"type\":\"integer\",\n               \"description\":\"The quantity of stock adjustment\"\n            },\n            \"fromStatus\":{\n               \"type\":\"string\",\n               \"description\":\"The previous status of the stock\"\n            },\n            \"toStatus\":{\n               \"type\":\"string\",\n               \"description\":\"The new status of the stock\"\n            },\n            \"reasonCode\":{\n               \"type\":\"string\",\n               \"description\":\"The code for the stock adjustment reason\"\n            },\n            \"adjustmentDate\":{\n               \"type\":\"DateTime\",\n               \"format\":\"date-time\",\n               \"description\":\"The date and time of the stock adjustment\"\n            },\n            \"adjustmentProcessedDate\":{\n               \"type\":\"DateTime\",\n               \"format\":\"date-time\",\n               \"description\":\"The date and time that the stock adjustment was processed and stock position updated.\"\n            },\n            \"batch\":{\n               \"type\":\"string\",\n               \"description\":\"The batch of the stock that was adjusted\"\n            },\n            \"expiryDate\":{\n               \"type\":\"DateTime\",\n               \"format\":\"date-time\",\n               \"description\":\"The date and time of expiry of the stock that was adjusted\"\n            },\n           \"identifiers\":{\n               \"type\":\"Object\",\n               \"format\":\"identifier\",\n               \"description\":\"List of Identifer Types and thier values like IMEI and Serial Numbers of the Stock units that was adjusted\"\n            }\n         }\n      }\n   ]\n}\n\n

\n","urlObject":{"path":["v1","stock","adjustments","stockadjustmentid","{{stockAdjustmentId}}"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"37c817cb-ef1b-4957-b97d-ea2327e61770","name":"HTTP 200","originalRequest":{"method":"GET","header":[{"key":"accept","value":"application/json","type":"text"},{"key":"organisation","value":"client-name","type":"text"}],"url":"/v1/stock/adjustments/stockadjustmentid/{{stockAdjustmentId}}"},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"stockAdjustmentId\":123456,\n \"warehouseReference\":\"whRef1234\",\n \"productId\":1234567,\n \"warehouseId\":99,\n \"quantity\":10,\n \"stockOwnerId\": 200,\n \"fromStatus\": null,\n \"toStatus\": \"GOOD\",\n \"reasonCode\":\"P4\",\n \"adjustmentDate\":\"2026-01-01T01:10:07.000Z\",\n \"adjustmentProcessedDate\":\"2026-01-01T01:10:27.000Z\",\n \"batch\":\"BATCH-2026-09\",\n \"expiryDate\":\"2026-01-01T01:10:27.000Z\",\n \"identifiers\": [\n {\n \"identifierType\": \"IMEI\",\n \"identifierValues\": [\"1000000041\",\"1000000042\"]\n },\n {\n \"identifierType\": \"SERIAL_NUMBER\",\n \"identifierValues\": [\"SN12345678A016\",\"SN12345678A017\",\"SN12345678A018\"]\n }\n ]\n }\n]"}],"_postman_id":"c76a928f-9847-444c-84c2-ba9b2549c293"},{"name":"Get stock","id":"52dcf496-ae70-4a84-ae18-bc9a09892d08","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"body":{"mode":"raw","raw":"","options":{"raw":{"language":"json"}}},"url":"/v2/stock/product/{{productId}}","description":"

This endpoint is deprecated. Instead, the GET Stock Availability should be used for a more complete response.

This endpoint is used to get total good stock details for the requested product id.

The response includes warehouse id, name and quantity of the good stock.

Quantity returned by API represents total good stock product quantity which is the quantity of the product currently stored in the inventory, including any unfulfilled quantities.

Request

Authorization:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
Token	Bearer Token	The access token issued by the our customer specyfic autentication provider service.

Path Paramaters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
productId	String	Either the internal THG product ID or product barcode should be provided in this parameter, as prearranged with THG to ensure the correct configuration is set up. The product ID is mandatory. Example: 123456

Response

Returns the list of the following parameters:

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Parameter	Type	Description
quantity	int	Total good stock product quantity currently stored in the inventory, including any unfulfilled quantities.
warehouseId	int	THG internal Id of a warehouse where the product is stored.
warehouseName	String	Name of the warehouse where the product is stored.

Response JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"array\",\n  \"items\": [\n    {\n      \"type\": \"object\",\n      \"properties\": {\n        \"quantity\": {\n          \"type\": \"integer\"\n        },\n        \"warehouseId\": {\n          \"type\": \"integer\"\n        },\n        \"warehouseName\": {\n          \"type\": \"string\"\n        }\n      },\n      \"required\": [\n        \"quantity\",\n        \"warehouseId\",\n        \"warehouseName\"\n      ]\n    }\n  ]\n}\n\n

Response Body (raw)

[\n   {\n      \"quantity\":1000,\n      \"warehouseId\":99,\n      \"warehouseName\":\"Warehouse Name\"\n   }\n]\n\n

\n","urlObject":{"path":["v2","stock","product","{{productId}}"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"4aaec0c9-cae6-4e7a-8a83-347b38a1b2f3","name":"HTTP 200","originalRequest":{"method":"GET","header":[],"url":"/v2/stock/product/{{productId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"quantity\": 1000,\n \"warehouseId\": 99,\n \"warehouseName\": \"Warehouse Name\"\n }\n]"},{"id":"07a94d1c-72f5-408c-84c2-01bbb78f2dcb","name":"HTTP 404","originalRequest":{"method":"GET","header":[],"url":"/v2/stock/product/{{productId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"\"Barcode 99093 returned product ID list size of 0\""},{"id":"a880b7dd-bcbc-49ae-9cb7-2540bc473361","name":"HTTP 500","originalRequest":{"method":"GET","header":[],"url":"/v2/stock/product/{{productId}}"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"timestamp\": \"2023-01-26T12:23:30.210+00:00\",\n \"path\": \"/api/v2/stock/product/99093\",\n \"status\": 504,\n \"error\": \"Gateway Timeout\",\n \"requestId\": \"6e5b5f66-1\"\n}"}],"_postman_id":"52dcf496-ae70-4a84-ae18-bc9a09892d08"}],"id":"f991c7ba-4f96-46f2-8849-ed0f57251649","_postman_id":"f991c7ba-4f96-46f2-8849-ed0f57251649","description":""},{"name":"Courier Cross Dock","item":[{"name":"Create Cross Dock Manifest","id":"037957b3-2ed9-415e-be12-e41d2c409694","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"warehouseId\": 89,\n \"clientReference\": \"ASN-20240508-0001\",\n \"expectedDeliveryBookingDate\": \"2024-06-01\",\n \"deliveryVehicle\": {\n \"type\": \"VAN\",\n \"registrationNumber\": \"AB-123-CD\",\n \"driverName\": \"John Doe\",\n \"haulierName\": \"THG Logistics\"\n },\n \"pallets\": [\n {\n \"palletId\": \"006141411234567890\",\n \"sortCode\": \"CD-AMS-01\",\n \"parcels\": [\n {\n \"trackingNumber\": \"TRK-10001\",\n \"orderId\": \"ORD-20001\",\n \"shipmentId\": \"468783101\",\n \"shipmentLabelId\": \"LBL-40001\",\n \"sortCode\": \"SC-123\"\n },\n {\n \"trackingNumber\": \"TRK-10002\",\n \"orderId\": \"ORD-20002\",\n \"shipmentId\": \"468783100\",\n \"shipmentLabelId\": \"LBL-40002\",\n \"sortCode\": \"SC-123\"\n }\n ]\n },\n {\n \"palletId\": \"006141411234567891\",\n \"sortCode\": \"CD-AMS-02\",\n \"parcels\": [\n {\n \"trackingNumber\": \"TRK-10003\",\n \"orderId\": \"ORD-20003\",\n \"shipmentId\": \"468783102\",\n \"shipmentLabelId\": \"LBL-40003\",\n \"sortCode\": \"CD-AMS-01\"\n }\n ]\n }\n ]\n }","options":{"raw":{"language":"json"}}},"url":"/cross-dock/asn/notification","description":"

This endpoint creates a manifest for inbound courier cross dock deliveries to THGi. If successfully created, the response includes information needed for the delivery.

Request

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`warehouseId`	integer	Y	The ID of the warehouse where the delivery will be arriving.
`clientReference`	string	N	Client's reference for the Cross Dock delivery.
`deliveryVehicle`	DeliveryVehicle	Y	Details about the delivery vehicle transporting the delivery.
`pallets`	Array of Pallet	Y	A list of pallets and their contents.

DeliveryVehicle

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`type`	string	Y	The type of delivery vehicle: `CURTAIN`, `REAR`, `VAN`, or `UNKNOWN`.
`registrationNumber`	string	N	The vehicle's registration number.
`driverName`	string	N	The driver's name.
`haulierName`	string	N	The name of the haulier company.

Pallet

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`palletId`	string	N	Identifier of the pallet.
`sortCode`	string	Y	The THGi sortcode of parcels on the pallet. All parcels on the pallet should have the same sortcode.
`parcels`	Array of Parcel	Y	A list of parcels which are on this pallet.

Parcel

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`trackingNumber`	string	Y	Courier tracking number of the parcel.
`shipmentId`	string	Y	The shipment identifier of the parcel.
`shipmentLabelId`	string	Y	The value encoded on the scannable barcode on the shipping label.

Response

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`label`	Label	A label which can be printed and affixed to the pallets to aid in the identification of the delivery.
`asnId`	string	THGi generated reference to the delivery.
`clientReference`	string	Client's reference for the cross dock delivery.

Label

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`mediaType`	string	`application/pdf`
`base64Label`	string	Base64-encoded label.
`base64AdditionalLabel`	string	Second base64-encoded label.

OpenAPI Spec

openapi: 3.0.3\ninfo:\n  title: CrossDock API\n  version: 1.0.0\npaths:\n  /crossdock/client:\n    post:\n      summary: This endpoint takes an asn request from client and sends it over to cross dock\n      requestBody:\n        required: true\n        content:\n          application/json:\n            schema:\n              $ref: '#/components/schemas/CrossDockClientRequestDto'\n      responses:\n        '200':\n          description: Successful response\n          content:\n            application/json:\n              schema:\n                $ref: '#/components/schemas/CrossDockClientResponseDto'\ncomponents:\n  schemas:\n    CrossDockClientRequestDto:\n      type: object\n      required:\n        - warehouseId\n        - deliveryVehicle\n        - pallets\n      properties:\n        warehouseId:\n          type: integer\n        clientReference:\n          type: string\n          nullable: true\n        deliveryVehicle:\n          $ref: '#/components/schemas/ClientDeliveryVehicleDto'\n        pallets:\n          type: array\n          items:\n            $ref: '#/components/schemas/Pallet'\n    ClientDeliveryVehicleDto:\n      type: object\n      required:\n        - type\n      properties:\n        type:\n          $ref: '#/components/schemas/ClientDeliveryVehicleType'\n        registrationNumber:\n          type: string\n          nullable: true\n        driverName:\n          type: string\n          nullable: true\n        haulierName:\n          type: string\n          nullable: true\n    ClientDeliveryVehicleType:\n      type: string\n      enum:\n        - CURTAIN\n        - REAR\n        - VAN\n        - UNKNOWN\n    Pallet:\n      type: object\n      required:\n        - sortCode\n        - parcels\n      properties:\n        palletId:\n          type: string\n          nullable: true\n        sortCode:\n          type: string\n        parcels:\n          type: array\n          items:\n            $ref: '#/components/schemas/Parcel'\n    Parcel:\n      type: object\n      required:\n        - trackingNumber\n        - shipmentId\n        - shipmentLabelId\n      properties:\n        trackingNumber:\n          type: string\n        shipmentId:\n          type: string\n        shipmentLabelId:\n          type: string\n    CrossDockClientResponseDto:\n      type: object\n      properties:\n        clientReference:\n          type: string\n        asnId:\n          type: string\n        label:\n          $ref: '#/components/schemas/Label'\n    Label:\n      type: object\n      properties:\n        mediaType:\n          type: string\n        base64Label:\n          type: string\n        base64AdditionalLabel:\n          type: string\n\n

\n","urlObject":{"path":["cross-dock","asn","notification"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"ac561695-1e39-4031-af31-68ab062714f8","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"warehouseId\": 123,\n \"clientReference\": \"REF-456\",\n \"deliveryVehicle\": {\n \"type\": \"CURTAIN\",\n \"registrationNumber\": \"AB12CDE\",\n \"driverName\": \"John Doe\",\n \"haulierName\": \"Haulier Ltd\"\n },\n \"pallets\": [\n {\n \"palletId\": \"PALLET-001\",\n \"sortCode\": \"SC-789\",\n \"parcels\": [\n {\n \"trackingNumber\": \"TRACK-001\",\n \"shipmentId\": \"SHIP-001\",\n \"shipmentLabelId\": \"LABEL-001\"\n },\n {\n \"trackingNumber\": \"TRACK-002\",\n \"shipmentId\": \"SHIP-002\",\n \"shipmentLabelId\": \"LABEL-002\"\n }\n ]\n },\n {\n \"palletId\": \"PALLET-002\",\n \"sortCode\": \"SC-456\",\n \"parcels\": [\n {\n \"trackingNumber\": \"TRACK-003\",\n \"shipmentId\": \"SHIP-003\",\n \"shipmentLabelId\": \"LABEL-003\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/cross-dock/asn/notification?organisation=&clientId","host":[""],"path":["cross-dock","asn","notification"],"query":[{"key":"organisation","value":"","type":"text"},{"key":"clientId","value":null,"type":"text"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"clientReference\": \"REF-456\",\n \"asnId\": \"ASNX-31-020326-51\",\n \"label\": {\n \"mediaType\": \"application/pdf\",\n \"base64Label\": \"JVBERi0xLjQKJcfs...\",\n \"base64AdditionalLabel\": \"QWx0ZXJuYXRpdmVCYXNlNjQ=\"\n }\n}"}],"_postman_id":"037957b3-2ed9-415e-be12-e41d2c409694"},{"name":"Create Cross Dock without Manifest - loose parcels","id":"86f2e49b-8ff3-4a14-bcf7-6c3ab0107d3a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"warehouseId\": 89,\n \"clientReference\": \"REF-456\",\n \"expectedDeliveryBookingDate\": \"2024-06-01\",\n \"deliveryVehicle\": {\n \"type\": \"CURTAIN\",\n \"registrationNumber\": \"XY-456-ZW\",\n \"driverName\": \"Jane Smith\",\n \"haulierName\": \"Express Freight\"\n },\n \"parcels\": [\n {\n \"trackingNumber\": \"TRK-20001\",\n \"orderId\": \"ORD-30001\",\n \"shipmentId\": \"468783201\",\n \"shipmentLabelId\": \"LBL-50001\",\n \"sortCode\": \"SC-789\"\n },\n {\n \"trackingNumber\": \"TRK-20002\",\n \"orderId\": \"ORD-30002\",\n \"shipmentId\": \"468783202\",\n \"shipmentLabelId\": \"LBL-50002\",\n \"sortCode\": \"SC-789\"\n },\n {\n \"trackingNumber\": \"TRK-20003\",\n \"orderId\": \"ORD-30003\",\n \"shipmentId\": \"468783203\",\n \"shipmentLabelId\": \"LBL-50003\",\n \"sortCode\": \"SC-101\"\n },\n {\n \"trackingNumber\": \"TRK-20004\",\n \"orderId\": \"ORD-30004\",\n \"shipmentId\": \"468783204\",\n \"shipmentLabelId\": \"LBL-50004\",\n \"sortCode\": \"SC-101\"\n }\n ]\n }","options":{"raw":{"language":"json"}}},"url":"/cross-dock/asn/notification","description":"

This endpoint creates a manifest for inbound courier cross dock deliveries to THGi. If successfully created, the response includes information needed for the delivery.

Request

Request Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`warehouseId`	integer	Y	The ID of the warehouse where the delivery will be arriving.
`clientReference`	string	N	Client's reference for the Cross Dock delivery.
`deliveryVehicle`	DeliveryVehicle	Y	Details about the delivery vehicle transporting the delivery.
`pallets`	Array of Pallet	Y	A list of pallets and their contents.

DeliveryVehicle

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`type`	string	Y	The type of delivery vehicle: `CURTAIN`, `REAR`, `VAN`, or `UNKNOWN`.
`registrationNumber`	string	N	The vehicle's registration number.
`driverName`	string	N	The driver's name.
`haulierName`	string	N	The name of the haulier company.

Pallet

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`palletId`	string	N	Identifier of the pallet.
`sortCode`	string	Y	The THGi sortcode of parcels on the pallet. All parcels on the pallet should have the same sortcode.
`parcels`	Array of Parcel	Y	A list of parcels which are on this pallet.

Parcel

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
`trackingNumber`	string	Y	Courier tracking number of the parcel.
`shipmentId`	string	Y	The shipment identifier of the parcel.
`shipmentLabelId`	string	Y	The value encoded on the scannable barcode on the shipping label.

Response

Response Body

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`label`	Label	A label which can be printed and affixed to the pallets to aid in the identification of the delivery.
`asnId`	string	THGi generated reference to the delivery.
`clientReference`	string	Client's reference for the cross dock delivery.

Label

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Description
`mediaType`	string	`application/pdf`
`base64Label`	string	Base64-encoded label.
`base64AdditionalLabel`	string	Second base64-encoded label.

OpenAPI Spec

openapi: 3.0.3\ninfo:\n  title: CrossDock API\n  version: 1.0.0\npaths:\n  /crossdock/client:\n    post:\n      summary: This endpoint takes an asn request from client and sends it over to cross dock\n      requestBody:\n        required: true\n        content:\n          application/json:\n            schema:\n              $ref: '#/components/schemas/CrossDockClientRequestDto'\n      responses:\n        '200':\n          description: Successful response\n          content:\n            application/json:\n              schema:\n                $ref: '#/components/schemas/CrossDockClientResponseDto'\ncomponents:\n  schemas:\n    CrossDockClientRequestDto:\n      type: object\n      required:\n        - warehouseId\n        - deliveryVehicle\n        - pallets\n      properties:\n        warehouseId:\n          type: integer\n        clientReference:\n          type: string\n          nullable: true\n        deliveryVehicle:\n          $ref: '#/components/schemas/ClientDeliveryVehicleDto'\n        pallets:\n          type: array\n          items:\n            $ref: '#/components/schemas/Pallet'\n    ClientDeliveryVehicleDto:\n      type: object\n      required:\n        - type\n      properties:\n        type:\n          $ref: '#/components/schemas/ClientDeliveryVehicleType'\n        registrationNumber:\n          type: string\n          nullable: true\n        driverName:\n          type: string\n          nullable: true\n        haulierName:\n          type: string\n          nullable: true\n    ClientDeliveryVehicleType:\n      type: string\n      enum:\n        - CURTAIN\n        - REAR\n        - VAN\n        - UNKNOWN\n    Pallet:\n      type: object\n      required:\n        - sortCode\n        - parcels\n      properties:\n        palletId:\n          type: string\n          nullable: true\n        sortCode:\n          type: string\n        parcels:\n          type: array\n          items:\n            $ref: '#/components/schemas/Parcel'\n    Parcel:\n      type: object\n      required:\n        - trackingNumber\n        - shipmentId\n        - shipmentLabelId\n      properties:\n        trackingNumber:\n          type: string\n        shipmentId:\n          type: string\n        shipmentLabelId:\n          type: string\n    CrossDockClientResponseDto:\n      type: object\n      properties:\n        clientReference:\n          type: string\n        asnId:\n          type: string\n        label:\n          $ref: '#/components/schemas/Label'\n    Label:\n      type: object\n      properties:\n        mediaType:\n          type: string\n        base64Label:\n          type: string\n        base64AdditionalLabel:\n          type: string\n\n

\n","urlObject":{"path":["cross-dock","asn","notification"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"9dc6e8e4-0bb2-4635-aed3-7ab15d5740c0","name":"Success","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"warehouseId\": 123,\n \"clientReference\": \"REF-456\",\n \"deliveryVehicle\": {\n \"type\": \"CURTAIN\",\n \"registrationNumber\": \"AB12CDE\",\n \"driverName\": \"John Doe\",\n \"haulierName\": \"Haulier Ltd\"\n },\n \"pallets\": [\n {\n \"palletId\": \"PALLET-001\",\n \"sortCode\": \"SC-789\",\n \"parcels\": [\n {\n \"trackingNumber\": \"TRACK-001\",\n \"shipmentId\": \"SHIP-001\",\n \"shipmentLabelId\": \"LABEL-001\"\n },\n {\n \"trackingNumber\": \"TRACK-002\",\n \"shipmentId\": \"SHIP-002\",\n \"shipmentLabelId\": \"LABEL-002\"\n }\n ]\n },\n {\n \"palletId\": \"PALLET-002\",\n \"sortCode\": \"SC-456\",\n \"parcels\": [\n {\n \"trackingNumber\": \"TRACK-003\",\n \"shipmentId\": \"SHIP-003\",\n \"shipmentLabelId\": \"LABEL-003\"\n }\n ]\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/cross-dock/asn/notification?organisation&clientId","host":[""],"path":["cross-dock","asn","notification"],"query":[{"key":"organisation","value":null,"type":"text"},{"key":"clientId","value":null,"type":"text"}]}},"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"clientReference\": \"REF-456\",\n \"asnId\": \"ASNX-31-020326-51\",\n \"label\": {\n \"mediaType\": \"application/pdf\",\n \"base64Label\": \"JVBERi0xLjQKJcfs...\",\n \"base64AdditionalLabel\": \"QWx0ZXJuYXRpdmVCYXNlNjQ=\"\n }\n}"}],"_postman_id":"86f2e49b-8ff3-4a14-bcf7-6c3ab0107d3a"}],"id":"86b6d10d-96ee-40fa-811f-d20a874be870","description":"

Courier Cross Dock describes a process whereby pallets of parcels sorted by THGi sort codes are shipped into THGi facilities for onwards fulfilment.

\n","_postman_id":"86b6d10d-96ee-40fa-811f-d20a874be870"}],"id":"22de6d7f-860d-4114-8675-52c1ccc79740","description":"

This folder contains documentation for the THG Fulfil APIs. These APIs describe the ways in which you can interact with THG Fulfil.

THG Fulfil has a sandbox, which can be used to interact with the API and receive pre-determined resopnses. Documentation of the THG Fulfil Sandbox is at the top of this page.

\n","_postman_id":"22de6d7f-860d-4114-8675-52c1ccc79740"},{"name":"Warehouse API","item":[{"name":"Shipments","item":[{"name":"Outbound","item":[{"name":"Shipment Message ref: SHI.O.01","id":"fe3a5561-411a-4335-91dd-49d3901d72ac","protocolProfileBehavior":{"disableBodyPruning":true,"disabledSystemHeaders":{"content-type":true}},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"shipmentNumber\": \"string\",\n \"orderId\": \"string\",\n \"orderCreatedDate\": \"string\",\n \"fulfilmentChannel\": {\n \"locationId\": 0,\n \"locationName\": \"WEB || STORE || DROP\"\n },\n \"address\": {\n \"name\": \"string\",\n \"companyName\": \"string\",\n \"houseNameNumber\": \"string\",\n \"streetName\": \"string\",\n \"line2\": \"string\",\n \"line3\": \"string\",\n \"line4\": \"string\",\n \"country\": \"string\",\n \"postCode\": \"string\",\n \"emailId\": \"string\",\n \"mobileNumber\": \"string\"\n },\n \"shipmentLines\": [\n {\n \"skuId\": \"string\",\n \"barcode\": \"string\",\n \"barcodes\": {\n \"EAN\": [\n \"string\"\n ],\n \"UPC\": [\n \"string\"\n ]\n },\n \"quantity\": 0,\n \"bundleId\": 0,\n \"bundleComponents\": [\n {\n \"id\": \"string\",\n \"quantity\": 0\n }\n ],\n \"expectedDispatchDate\": \"string\",\n \"totalAmount\": {\n \"currency\": \"string\",\n \"value\": 0,\n \"vat\": 0.00\n },\n \"productPricePerUnit\": {\n \"currency\": \"string\",\n \"value\": 0\n },\n \"shipmentLineId\": 0\n }\n ],\n \"deliveryType\": \"string\",\n \"shipmentType\": \"DC2STORE || B2B || B2C\",\n \"shippingCost\": {\n \"currency\": \"string\",\n \"value\": 0,\n \"vat\": 0\n },\n \"labelBarcode\": \"string\",\n \"trackingNumber\": \"string\",\n \"trackingUrl\": \"string\",\n \"site\": \"string\",\n \"locale\": \"string\",\n \"paymentType\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"/v4/order/shipment","description":"

Shipment requests are sent as soon as an order is ready to be sent to a warehouse or store. One shipment will be sent per request.

In cases where the courier assignment and label generation are handled by THG, a unique label corresponding to each shipment number will be generated and transferred to the 3PL – via SFTP or otherwise. In cases where courier assignment is handled by 3PL, THG will simply communicate the courier service identifier as described above to indicate what courier/service level to use.

For bundles support, kindly refer to examples specific to bundles.

Request

Property	Type	Mandatory	Description
shipmentNumber	String	Yes	Unique Identifier for a shipment
orderId	String	Yes	Unique Identifier for an order
orderCreatedDate	String	Yes	Date the order is created, Ex: \"2022-01-20T10:00:00\", UTC Format
shipmentType	String	Yes	B2C/B2B/ DC2STORE - type of shipment
deliveryType	String	Yes	Standard, Click and Collect, Next Day etc
fulfilmentChannel	Object	Yes	Fulfilment Channel Info (object details below)
address	Object	Yes	Shipping address (object details below)
shipmentLines	Object	Yes	Shipment Lines (object details below)
shippingCost currency value vat	Object String BigDecimal BigDecimal	Yes Yes Yes Yes	Shipping value associated with the shipment
labelBarcode	String	Yes	Barcode on courier label. If THG uses their own courier then this information is mandatory.
trackingNumber	String	Yes	Carrier track number will contain the generated consignment number for the relevant carrier. If THG uses their own courier then this information is mandatory.
trackingUrl	String	Yes	Carrier tracking url for the relevant carrier. If THG uses their own courier then this information is mandatory.
site	String	Yes	Site code agreed with client and configured in Catalogue
locale	String	No	Locale agreed with client and configured in Catalogue
paymentType	String	Yes	How the customer is paying for this order. Possible values are: CREDIT_CARD, APPLE_PAY, PAY_ON_DELIVERY Pay on delivery is the interesting one here because if the client does manage his own fulfillment then he needs to arrange cash collection on delivery.

Fulfilment Channel

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
locationId	Long	Yes	Id of fulfilment location, eg store id or warehouse id
locationName	String	Yes	Either Web or Store or Dropship. Allowed values are WEB (for warehouse fulfilment location), STORE (for store fulfilment location), DROP (for dropship fulfilment location).

Shipping Address

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
name	String	Yes	Customer Name
companyName	String	No	Company Name
houseNameNumber	String	Yes	House Number
streetName	String	Yes	Street Name
line2	String	No	Address Line 2
line3	String	Yes	City
liine4	String	No	County/state/province
country	String	Yes	Two-character country code eg GB
postCode	String	Yes	Delivery Postcode
emailId	String	Yes	Email Id
mobileNumber	String	Yes	Contact number

Shipment Lines

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
skuId	String	Yes	This is client's product id (External product id)
barcode	String	Yes	Product primary barcode
barcodes	Object	No	Multiple barcode types eg. EAN, UPC
quantity	Integer	Yes	Product quantity
bundleId	Integer	No	This field serves as an identifier for the related bundle components made available along with this field. It will be available only if shipment line is a bundle. It is THG bundle SKU id.
bundleComponents id quantity	Object String Integer	No Yes Yes	Bundle components is an array of individual components of the bundle. This object is available only if this shipment line is a bundle and has bundleId present as explained above. Bundle component has 2 fields: Id is barcode of bundle component. Quantity corresponds to quantity of the bundle component for a single bundle.
expectedDispatchDate	String	Yes	Ex: \"2022-01-20T10:00:00\", UTC Format
totalAmount currency value vat	Object String BigDecimal BigDecimal	Yes Yes Yes No	Total charge of the shipment alongside currency, value and estimated tax.
productPricePerUnit currency value	Object String BigDecimal	Yes Yes Yes	Charge price per product unit
shipmentLineId	Long	Yes	Unique shipment identifier

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"shipmentNumber\": {\n      \"type\": \"string\"\n    },\n    \"orderId\": {\n      \"type\": \"string\"\n    },\n    \"orderCreatedDate\": {\n      \"type\": \"string\"\n    },\n    \"fulfilmentChannel\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"locationId\": {\n          \"type\": \"integer\"\n        },\n        \"locationName\": {\n          \"type\": \"string\"\n        }\n      },\n      \"required\": [\n        \"locationId\",\n        \"locationName\"\n      ]\n    },\n    \"address\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"name\": {\n          \"type\": \"string\"\n        },\n        \"companyName\": {\n          \"type\": \"string\"\n        },\n        \"houseNameNumber\": {\n          \"type\": \"string\"\n        },\n        \"streetName\": {\n          \"type\": \"string\"\n        },\n        \"line2\": {\n          \"type\": \"string\"\n        },\n        \"line3\": {\n          \"type\": \"string\"\n        },\n        \"line4\": {\n          \"type\": \"string\"\n        },\n        \"country\": {\n          \"type\": \"string\"\n        },\n        \"postCode\": {\n          \"type\": \"string\"\n        },\n        \"emailId\": {\n          \"type\": \"string\"\n        },\n        \"mobileNumber\": {\n          \"type\": \"string\"\n        }\n      },\n      \"required\": [\n        \"name\",\n        \"houseNameNumber\",\n        \"streetName\",\n        \"line3\",\n        \"country\",\n        \"postCode\",\n        \"emailId\",\n        \"mobileNumber\"\n      ]\n    },\n    \"shipmentLines\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"skuId\": {\n              \"type\": \"string\"\n            },\n            \"barcode\": {\n              \"type\": \"string\"\n            },\n            \"barcodes\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"EAN\": {\n                  \"type\": \"array\",\n                  \"items\": [\n                    {\n                      \"type\": \"string\"\n                    }\n                  ]\n                },\n                \"UPC\": {\n                  \"type\": \"array\",\n                  \"items\": [\n                    {\n                      \"type\": \"string\"\n                    }\n                  ]\n                }\n              },\n              \"anyOf\" : [\n                {\"required\": [\n                \"EAN\",\n              ]},\n                {\"required\": [\n                \"UPC\"\n              ]}\n              ]\n            },\n            \"quantity\": {\n              \"type\": \"integer\"\n            },\n            \"bundleId\": {\n              \"type\": \"integer\"\n            },\n            \"bundleComponents\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"id\": {\n                      \"type\": \"string\"\n                    },\n                    \"quantity\": {\n                      \"type\": \"integer\"\n                    }\n                  },\n                  \"required\": [\n                    \"id\",\n                    \"quantity\"\n                  ]\n                }\n              ]\n            },\n            \"expectedDispatchDate\": {\n              \"type\": \"string\"\n            },\n            \"totalAmount\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"currency\": {\n                  \"type\": \"string\"\n                },\n                \"value\": {\n                  \"type\": \"number\"\n                },\n                \"vat\": {\n                  \"type\": \"number\"\n                }\n              },\n              \"required\": [\n                \"currency\",\n                \"value\"\n              ]\n            },\n            \"productPricePerUnit\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"currency\": {\n                  \"type\": \"string\"\n                },\n                \"value\": {\n                  \"type\": \"number\"\n                }\n              },\n              \"required\": [\n                \"currency\",\n                \"value\"\n              ]\n            },\n            \"shipmentLineId\": {\n              \"type\": \"integer\"\n            }\n          },\n          \"required\": [\n            \"barcode\",\n            \"quantity\",\n            \"expectedDispatchDate\",\n            \"totalAmount\",\n            \"productPricePerUnit\",\n            \"shipmentLineId\"\n          ]\n        }\n      ]\n    },\n    \"deliveryType\": {\n      \"type\": \"string\"\n    },    \n    \"shipmentType\": {\n      \"type\": \"string\"\n    },\n    \"shippingCost\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"currency\": {\n          \"type\": \"string\"\n        },\n        \"value\": {\n          \"type\": \"number\"\n        },\n        \"vat\": {\n          \"type\": \"number\"\n        }\n      },\n      \"required\": [\n        \"currency\",\n        \"value\",\n        \"vat\"\n      ]\n    },\n    \"labelBarcode\": {\n      \"type\": \"string\"\n    },\n    \"trackingNumber\": {\n      \"type\": \"string\"\n    },\n    \"trackingUrl\": {\n      \"type\": \"string\"\n    },\n    \"site\": {\n      \"type\": \"string\"\n    }\n  },\n  \"required\": [\n    \"shipmentNumber\",\n    \"orderId\",\n    \"orderCreatedDate\",\n    \"fulfilmentChannel\",\n    \"address\",\n    \"shipmentLines\",\n    \"shipmentType\",\n    \"shippingCost\",\n    \"site\",\n    \"locale\"\n  ]\n}\n\n

\n","urlObject":{"path":["v4","order","shipment"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"2cfa9494-1128-4e3c-874a-4a02e8d21913","name":"Shipment Message (Success)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"shipmentNumber\": \"245645704\",\n \"orderId\": \"405524478\",\n \"orderCreatedDate\": \"2022-05-19T13:19:28Z\",\n \"fulfilmentChannel\": {\n \"locationId\": 1021,\n \"locationName\": \"STORE\"\n },\n \"address\": {\n \"name\": \"Marie Culloden\",\n \"houseNameNumber\": \"11\",\n \"streetName\": \"Mellon Lane\",\n \"line2\": \"Byron Apartments\",\n \"line3\": \"Lanes End\",\n \"line4\": \"Manchester\",\n \"country\": \"GB\",\n \"postCode\": \"M33 6PS\",\n \"emailId\": \"marrie.cze@gmail.com\",\n \"mobileNumber\": \"07898786666\"\n },\n \"shipmentLines\": [\n {\n \"skuId\": \"Loreal/Black/40\",\n \"barcode\": \"3600520761145\",\n \"barcodes\": {\n \"EAN\": [\n \"3600520761145\"\n ]\n },\n \"quantity\": 2,\n \"expectedDispatchDate\": \"2022-05-20T14:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 50.00,\n \"vat\": 0.00\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"value\": 25.00\n },\n \"shipmentLineId\": 201\n }\n ],\n \"deliveryType\": \"Click and Collect\",\n \"shipmentType\": \"DC2STORE\",\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 5.95,\n \"vat\": 1.50\n },\n \"labelBarcode\": \"THG245645704\",\n \"trackingNumber\": \"HZYEJC0131117751\",\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=HZYEJC0131117751\",\n \"site\": \"MTLN\",\n \"locale\": \"en\",\n \"paymentType\": \"CREDIT_CARD\"\n}","options":{"raw":{"language":"json"}}},"url":"/v4/order/shipment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"00483285-9afd-441b-a3b6-c8f692cf0f64","name":"Bundle Shipment Message having bundle and non-bundle products(Success)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"shipmentNumber\": \"245645704\",\n \"orderId\": \"405524478\",\n \"orderCreatedDate\": \"2022-05-19T13:19:28Z\",\n \"fulfilmentChannel\": {\n \"locationId\": 123,\n \"locationName\": \"WEB\"\n },\n \"address\": {\n \"name\": \"Marie Culloden\",\n \"houseNameNumber\": \"11\",\n \"streetName\": \"Mellon Lane\",\n \"line2\": \"Byron Apartments\",\n \"line3\": \"Lanes End\",\n \"line4\": \"Manchester\",\n \"country\": \"GB\",\n \"postCode\": \"M35 6PA\",\n \"emailId\": \"marrie.cul@gmail.com\",\n \"mobileNumber\": \"07777786666\"\n },\n \"shipmentLines\": [\n {\n \"barcode\": \"PRERELEASE\",\n \"quantity\": 2,\n \"bundleId\": 9999,\n \"bundleComponents\": [\n {\n \"id\": \"2600520761144\",\n \"quantity\": 1\n },\n {\n \"id\": \"2600520761145\",\n \"quantity\": 2\n }\n ],\n \"expectedDispatchDate\": \"2022-05-20T14:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 50.00,\n \"vat\": 0.00\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"value\": 25.00\n },\n \"shipmentLineId\": 201\n },\n {\n \"barcode\": \"PRERELEASE\",\n \"quantity\": 1,\n \"bundleId\": 9998,\n \"bundleComponents\": [\n {\n \"id\": \"2600520761146\",\n \"quantity\": 1\n },\n {\n \"id\": \"2600520761147\",\n \"quantity\": 1\n }\n ],\n \"expectedDispatchDate\": \"2022-05-20T14:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 25.00,\n \"vat\": 0.00\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"value\": 25.00\n },\n \"shipmentLineId\": 202\n },\n {\n \"barcode\": \"3600520761143\",\n \"quantity\": 1,\n \"expectedDispatchDate\": \"2022-05-20T14:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 10.00,\n \"vat\": 0.00\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"value\": 10.00\n },\n \"shipmentLineId\": 203\n }\n ],\n \"deliveryType\": \"Standard\",\n \"shipmentType\": \"B2C\",\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 5.95,\n \"vat\": 1.50\n },\n \"site\": \"SITEA\",\n \"locale\": \"en\",\n \"paymentType\": \"CREDIT_CARD\"\n}","options":{"raw":{"language":"json"}}},"url":"/v4/order/shipment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"b4d823ac-fc0f-4e36-8e8d-909ed9aa7745","name":"Shipment Message (Failure)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"shipmentNumber\": \"245645704\",\n \"orderId\": \"405524478\",\n \"orderCreatedDate\": \"2022-05-19T13:19:28Z\",\n \"fulfilmentChannel\": {\n \"locationId\": 1021,\n \"locationName\": \"STORE\"\n },\n \"address\": {\n \"name\": \"Marie Culloden\",\n \"houseNameNumber\": \"11\",\n \"streetName\": \"Mellon Lane\",\n \"line2\": \"Byron Apartments\",\n \"line3\": \"Lanes End\",\n \"line4\": \"Manchester\",\n \"country\": \"GB\",\n \"postCode\": \"M33 6PS\",\n \"emailId\": \"marrie.cze@gmail.com\",\n \"mobileNumber\": \"07898786666\"\n },\n \"shipmentLines\": [\n {\n \"skuId\": \"Loreal/Black/40\",\n \"barcode\": \"3600520761145\",\n \"barcodes\": {\n \"EAN\": [\n \"3600520761145\"\n ]\n },\n \"quantity\": 0,\n \"expectedDispatchDate\": \"2022-05-20T14:19:28Z\",\n \"totalAmount\": {\n \"currency\": \"GBP\",\n \"value\": 50.00,\n \"vat\": 0.00\n },\n \"productPricePerUnit\": {\n \"currency\": \"GBP\",\n \"value\": 25.00\n },\n \"shipmentLineId\": 201\n }\n ],\n \"deliveryType\": \"Standard\",\n \"shipmentType\": \"DC2STORE || B2B || B2C\",\n \"shippingCost\": {\n \"currency\": \"GBP\",\n \"value\": 5.95,\n \"vat\": 1.50\n },\n \"labelBarcode\": \"THG245645704\",\n \"trackingNumber\": \"HZYEJC0131117751\",\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=HZYEJC0131117751\",\n \"site\": \"MTLN\",\n \"locale\": \"\",\n \"paymentType\": \"CREDIT_CARD\"\n}","options":{"raw":{"language":"json"}}},"url":"/v4/order/shipment"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"fe3a5561-411a-4335-91dd-49d3901d72ac"},{"name":"Parcel Dispatch Notification ref: SHI.O.02","id":"8ff85506-104a-4512-aabe-13c918f4b948","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"fulfilmentLocationId\": 1021,\n \"shipmentNumber\": \"245645704\",\n \"parcelId\": \"string\",\n \"success\": false,\n \"error\": [{\n \"errorCode\": \"IDENTIFIER_MISSING || INVALID_CONTENT || INVALID_QUANTITY\",\n \"errorMessage\": \"Missing fulfilment location identifier\"\n }]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/dispatchParcelNotification","description":"

Shipments sent to the 3PL can be further split into parcels. If any validation fails in THG we will send a notification to the 3PL with pre-defined error codes and explanations. The 3PL is obligated to provide an endpoint for such notification and remedy the communication.

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
shipmentNumber	String	Yes	Unique shipment identifier
fulfilmentLocationId	Long	Yes	Id of fulfilment location, eg store id or warehouse id
success	Boolean	Yes	Either true or false. If success is False then errorCode and errorMessage are mandatory
error errorCode errorMessage	Object String String	Only if success=false	Error message with error code. Allowed values are \"INVALID_QUANTITY, INVALID_CONTENT or IDENTIFIER_MISSING\"

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"fulfilmentLocationId\": {\n      \"type\": \"integer\"\n    },\n    \"shipmentNumber\": {\n      \"type\": \"string\"\n    },\n    \"parcelId\": {\n      \"type\": \"string\"\n    },\n    \"success\": {\n      \"type\": \"boolean\"\n    },\n    \"error\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"errorCode\": {\n              \"type\": \"string\"\n            },\n            \"errorMessage\": {\n              \"type\": \"string\"\n            }\n          },\n          \"required\": [\n            \"errorCode\",\n            \"errorMessage\"\n          ]\n        }\n      ]\n    }\n  },\n  \"required\": [\n    \"fulfilmentLocationId\",\n    \"shipmentNumber\",\n    \"success\",\n    \"error\"\n  ]\n}\n\n

\n","urlObject":{"path":["v2","order","dispatchParcelNotification"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"0a695ccf-6956-4efd-8db6-13b42435d43e","name":"Parcel Dispatch Notification (Success)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"fulfilmentLocationId\": 1021,\n \"shipmentNumber\": \"245645704\",\n \"parcelId\": \"1001\",\n \"success\": true,\n \"error\": []\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/dispatchParcelNotification"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"4cc85aac-0420-4e3d-9af0-510e22b22d17","name":"Parcel Dispatch Notification (Failure)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"fulfilmentLocationId\": 1021,\n \"shipmentNumber\": \"245645704\",\n \"parcelId\": \"1001\",\n \"success\": false,\n \"error\": [{\n \"errorCode\": \"IDENTIFIER_MISSING\",\n \"errorMessage\": \"Missing fulfilment location identifier\"\n }]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/dispatchParcelNotification"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"8ff85506-104a-4512-aabe-13c918f4b948"},{"name":"Shipment Dispatch Notification ref: SHI.O.04","id":"0cc249b6-f24b-4a27-bf40-01640d111f49","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"fulfilmentLocationId\": 1021,\n \"shipmentNumber\": \"245645704\",\n \"success\": false,\n \"error\": [{\n \"errorCode\": \"IDENTIFIER_MISSING || INVALID_CONTENT || INVALID_QUANTITY\",\n \"errorMessage\": \"Missing fulfilment location identifier\"\n }]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/dispatchShipmentNotification","description":"

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
shipmentNumber	String	Yes	Unique shipment identifier
fulfilmentLocationId	Long	Yes	Id of fulfilment location, eg store id or warehouse id
success	Boolean	Yes	Either true or false. If success is False then errorCode and errorMessage are mandatory
error errorCode errorMessage	Object String String	Only if success=false	Error message with error code. Allowed values are \"INVALID_QUANTITY, INVALID_CONTENT or IDENTIFIER_MISSING\"

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"fulfilmentLocationId\": {\n      \"type\": \"integer\"\n    },\n    \"shipmentNumber\": {\n      \"type\": \"string\"\n    },\n    \"parcelId\": {\n      \"type\": \"string\"\n    },\n    \"success\": {\n      \"type\": \"boolean\"\n    },\n    \"error\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"errorCode\": {\n              \"type\": \"string\"\n            },\n            \"errorMessage\": {\n              \"type\": \"string\"\n            }\n          },\n          \"required\": [\n            \"errorCode\",\n            \"errorMessage\"\n          ]\n        }\n      ]\n    }\n  },\n  \"required\": [\n    \"fulfilmentLocationId\",\n    \"shipmentNumber\",\n    \"success\",\n    \"error\"\n  ]\n}\n\n

\n","urlObject":{"path":["v2","order","dispatchShipmentNotification"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"79f871d9-7bdf-4d8b-b48d-9d42803e68fa","name":"Shipment Dispatch Notification (Success)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"fulfilmentLocationId\": 1021,\n \"shipmentNumber\": \"245645704\",\n \"success\": true,\n \"error\": []\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/dispatchShipmentNotification"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"08ba622e-7207-4043-b707-57056c788797","name":"Shipment Dispatch Notification (Failure)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"fulfilmentLocationId\": 1021,\n \"shipmentNumber\": \"245645704\",\n \"success\": false,\n \"error\": [{\n \"errorCode\": \"IDENTIFIER_MISSING\",\n \"errorMessage\": \"Missing fulfilment location identifier\"\n }]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/dispatchShipmentNotification"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"e444e9d5-f92d-48d9-9253-b9d97ea360b0","name":"Bundle Shipment Dispatch Notification for partial bundle dispatch (Failure)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"fulfilmentLocationId\": 123,\n \"shipmentNumber\": \"245645704\",\n \"success\": false,\n \"error\": [\n {\n \"errorCode\": \"INVALID_CONTENT\",\n \"errorMessage\": \"Partial dispatch of bundle is not allowed.\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/dispatchShipmentNotification"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"0cc249b6-f24b-4a27-bf40-01640d111f49"},{"name":"Cancel Shipment Notification (Partial/Full) ref: SHI.O.03","id":"5a86e611-626d-4170-943d-0880883fa69b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"shipmentNumber\": \"string\",\n \"cancelDate\": \"2022-05-29T13:19:28Z\",\n \"fulfilmentLocationId\": 0,\n \"success\": true,\n \"cancelledLines\": [\n {\n \"skuId\": \"string\",\n \"cancelledQty\": 0\n }\n ],\n \"error\": {\n \"orderLines\": [\n {\n \"skuId\": \"string\",\n \"errorCode\": \"INVALID_QUANTITY || INVALID_CONTENT || IDENTIFIER_MISSING\",\n \"errorMessage\": \"Quantity for the sku is incorrect.\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/cancelShipmentNotification","description":"

When the 3PL wants to cancel a Shipment either partially or fully, they can send THG a shipment cancellation message. THG will provide the 3PL with a limited number of HTTP response codes. After the shipment cancellation message is received, THG will close the shipment if there are no more outstanding products to deliver. If any validation fails in THG we will send a notification to the 3PL with pre-defined error codes and explanations. The 3PL is obligated to provide an endpoint for such notification and remedy the communication.

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
shipmentNumber	String	Yes	Unique shipment identifier
cancelDate
fulfilmentLocationId	Long	Yes	Id of fulfilment location, eg store id or warehouse id
cancelledLines skuId cancelledQty	Object String Integer	Yes	A list of cancelled shipment lines with unique product identifiers & their relevant quantity.
success	Boolean	Yes	Either true or false. If success is False then errorCode and errorMessage are mandatory
error orderLines skuId errorCode errorMessage		Object Object String String String

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"shipmentNumber\": {\n      \"type\": \"string\"\n    },\n    \"cancelDate\": {\n      \"type\": \"string\"\n    },\n    \"fulfilmentLocationId\": {\n      \"type\": \"integer\"\n    },\n    \"success\": {\n      \"type\": \"boolean\"\n    },\n    \"cancelledLines\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"skuId\": {\n              \"type\": \"string\"\n            },\n            \"cancelledQty\": {\n              \"type\": \"integer\"\n            }\n          },\n          \"required\": [\n            \"skuId\",\n            \"cancelledQty\"\n          ]\n        }\n      ]\n    },\n    \"error\": {\n      \"type\": [\"object\" , \"null\"],\n      \"properties\": {\n        \"orderLines\": {\n          \"type\": \"array\",\n          \"items\": [\n            {\n              \"type\": \"object\",\n              \"properties\": {\n                \"skuId\": {\n                  \"type\": \"string\"\n                },\n                \"errorCode\": {\n                  \"type\": \"string\"\n                },\n                \"errorMessage\": {\n                  \"type\": \"string\"\n                }\n              },\n              \"required\": [\n                \"skuId\",\n                \"errorCode\",\n                \"errorMessage\"\n              ]\n            }\n          ]\n        }\n      },\n      \"required\": [\n        \"orderLines\"\n      ]\n    }\n  },\n  \"required\": [\n    \"shipmentNumber\",\n    \"cancelDate\",\n    \"fulfilmentLocationId\",\n    \"success\",\n    \"cancelledLines\"\n  ]\n}\n\n

\n","urlObject":{"path":["v2","order","cancelShipmentNotification"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"0745a977-f06e-4331-9895-6737694d8a99","name":"Cancel Shipment Notification (Success)","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"shipmentNumber\": \"245645704\",\n \"cancelDate\": \"2022-05-29T13:19:28Z\",\n \"fulfilmentLocationId\": 1021,\n \"success\": true,\n \"cancelledLines\": [\n {\n \"skuId\": \"Loreal/Black/40\",\n \"cancelledQty\": 1\n }\n ],\n \"error\": null\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/cancelShipmentNotification"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"00105248-c2bf-431b-bae7-7a2b799349fd","name":"Cancel Shipment Notification (Dropship_Partial_Cancellation)","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"shipmentNumber\": \"222222222\",\n \"cancelDate\": \"2022-05-27T13:19:28Z\",\n \"fulfilmentLocationId\": 300,\n \"success\": true,\n \"cancelledLines\": [\n {\n \"skuId\": \"TedBaker/Medium/12\",\n \"cancelledQty\": 1\n }\n ],\n \"error\": null\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/cancelShipmentNotification"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"aabb87ce-ee28-4172-a35a-1ce39cb2ce8a","name":"Cancel Shipment Notification (Dropship_Full_Cancellation)","originalRequest":{"method":"GET","header":[],"body":{"mode":"raw","raw":"{\n \"shipmentNumber\": \"222222222\",\n \"cancelDate\": \"2022-05-27T13:19:28Z\",\n \"fulfilmentLocationId\": 300,\n \"success\": true,\n \"cancelledLines\": [\n {\n \"skuId\": \"TedBaker/Medium/12\",\n \"cancelledQty\": 2\n }\n ],\n \"error\": null\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/cancelShipmentNotification"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"b8260530-e516-4244-a334-d9557def1630","name":"Cancel Shipment Notification (Failure)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","name":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"raw","raw":"{\n \"shipmentNumber\": \"245645704\",\n \"cancelDate\": \"2022-05-29T13:19:28Z\",\n \"fulfilmentLocationId\": 1021,\n \"success\": false,\n \"cancelledLines\": [],\n \"error\": {\n \"orderLines\": [\n {\n \"skuId\": \"Loreal/Black/40\",\n \"errorCode\": \"INVALID_QUANTITY\",\n \"errorMessage\": \"Quantity for the sku is incorrect.\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/cancelShipmentNotification"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"5b6a0023-8b33-4d8b-927e-9a80d40a8680","name":"Bundle Cancel Shipment Notification for partial bundle cancellation(Failure)","originalRequest":{"method":"GET","header":[{"key":"Content-Type","value":"application/x-www-form-urlencoded","type":"text"}],"body":{"mode":"raw","raw":"{\n \"shipmentNumber\": \"245645704\",\n \"cancelDate\": \"2022-05-29T13:19:28Z\",\n \"fulfilmentLocationId\": 123,\n \"success\": false,\n \"cancelledLines\": [],\n \"error\": {\n \"orderLines\": [\n {\n \"barcode\": \"2600520761144\",\n \"errorCode\": \"INVALID_CONTENT\",\n \"errorMessage\": \"Partial cancellation of bundle is not allowed.\"\n }\n ]\n }\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/cancelShipmentNotification"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"5a86e611-626d-4170-943d-0880883fa69b"}],"id":"8952b38c-2ca9-4282-85e5-316d9066413e","_postman_id":"8952b38c-2ca9-4282-85e5-316d9066413e","description":""},{"name":"Inbound","item":[{"name":"Shipment Notification ref: SHI.I.01","id":"f4f42029-4f85-4c83-8d12-bf810a8261ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"fulfilmentLocationId\": 0,\n \"shipmentNumber\": \"string\",\n \"success\": false,\n \"error\": [{\n \"errorCode\": \"INVALID_QUANTITY || INVALID_CONTENT || IDENTIFIER_MISSING\",\n \"errorMessage\": \"string\"\n }]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/shipmentNotification","description":"

If there are any validation failures or errors related to the shipment, the 3PL is obligated to send us a notification with pre-defined error codes and explanations.

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
shipmentNumber	String	Yes	Unique shipment identifier
fulfilmentLocationId	Long	Yes	Id of fulfilment location, eg store id or warehouse id
success	Boolean	Yes	Either true or false. If success is False then errorCode and errorMessage are mandatory
error errorCode errorMessage	Object String String	Only if success=false	Error message with error code. Allowed values are \"INVALID_QUANTITY, INVALID_CONTENT or IDENTIFIER_MISSING\"

Error Code Description

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Message
INVALID_QUANTITY	Quantity cannot be negative or Zero
INVALID_CONTENT	Request Content is Invalid
IDENTIFIER_MISSING	fulfilmentLocationId is missing

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"fulfilmentLocationId\": {\n      \"type\": \"integer\"\n    },\n    \"shipmentNumber\": {\n      \"type\": \"string\"\n    },\n    \"success\": {\n      \"type\": \"boolean\"\n    },\n    \"error\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"errorCode\": {\n              \"type\": \"string\"\n            },\n            \"errorMessage\": {\n              \"type\": \"string\"\n            }\n          },\n          \"required\": [\n            \"errorCode\",\n            \"errorMessage\"\n          ]\n        }\n      ]\n    }\n  },\n  \"required\": [\n    \"fulfilmentLocationId\",\n    \"shipmentNumber\",\n    \"success\",\n    \"error\"\n  ]\n}\n\n

\n","urlObject":{"path":["v2","order","shipmentNotification"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"480eb3a0-27aa-4169-92cf-42a915915038","name":"Shipment Notification (Success)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"fulfilmentLocationId\": 0,\n \"shipmentNumber\": \"245645704\",\n \"success\": false,\n \"error\": [{\n \"errorCode\": \"IDENTIFIER_MISSING || INVALID_CONTENT || INVALID_QUANTITY\",\n \"errorMessage\": \"Fulfilment Location ID is not specified\"\n }]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/shipmentNotification"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"bd350609-39f6-4bb6-a21c-4c8c8e93ce1a","name":"Shipment Notification (Failure)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"fulfilmentLocationId\": 0,\n \"shipmentNumber\": \"\",\n \"success\": false,\n \"error\": [{\n \"errorCode\": \"INVALID_QUANTITY\",\n \"errorMessage\": \"Unable to fulfil.\"\n }]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/shipmentNotification"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"f4f42029-4f85-4c83-8d12-bf810a8261ce"},{"name":"Parcel Dispatch Message ref: SHI.I.02","id":"a1287697-90d7-4b0d-b061-10963b5ff278","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dispatchDate\": \"2000-01-20T10:00:00\",\n \"shipmentNumber\": \"string\",\n \"fulfilmentLocationId\": 0,\n \"dispatchedItems\": [\n {\n \"skuId\": \"string\",\n \"barcode\": \"string\",\n \"quantity\": 0\n }\n ],\n \"labelBarcode\": \"string\",\n \"trackingNumber\": \"string\",\n \"trackingUrl\": \"string\",\n \"parcelId\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/dispatchParcel","description":"

Parcel dispatch

The client that does the fulfillment themselves can decide to dispatch the shipment in multiple parcels from one or more locations. The client's systems need to inform THG Ingenuity about every parcel that has been shipped for this shipment. Of course the parcel dispatches can only contain products that were part of the shipment and not exceed the quantities ordered. If the client has arranged the courier, then the tracking number and tracking URL needs to be populated.

Shipment closure

While normally a shipment will be closed when we receive a valid shipment dispatch message, the shipment that has received one or more parcel dispatch messages will be closed only in oen or two ways:

All requested products have been dispatched for exactly the quantitie requested.
Not all products have been dispatched for exactly the quantitie requested (Out of stock situations) but the remainder of the products and quantities have been cancelled with a cancellation message. (ref: SHI.I.03)

THG Ingenuity customer service can't perform any manual overrides for this shipment closure, you MUST either dispatch or cancell all products and quantities to move the shipment forward.

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
shipmentNumber	String	Yes	Unique Identifier for a shipment
dispatchDate	String	Yes	Date the order is created, Ex: \"2022-01-20T10:00:00\", UTC Format
fulfilmentLocationId	Long	Yes	Id of fulfilment location, eg store id or warehouse id
dispatchedItems skuId barcode quantity	Object String String Integer	Yes Yes No Yes	Items dispatched in the parcel
labelBarcode	String	Yes	Barcode on courier label. If THG uses their own courier then this information is mandatory.
trackingNumber	String	Yes	Carrier track number will contain the generated consignment number for the relevant carrier. If THG uses their own courier then this information is mandatory.
trackingUrl	String	Yes	Carrier tracking url for the relevant carrier. If THG uses their own courier then this information is mandatory.
parcelId	String	No	If the warehouse or stores decides to further split up the shipment into parcels, they can send THG a parcel identifier.

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"dispatchDate\": {\n      \"type\": \"string\"\n    },\n    \"shipmentNumber\": {\n      \"type\": \"string\"\n    },\n    \"fulfilmentLocationId\": {\n      \"type\": \"integer\"\n    },\n    \"dispatchedItems\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"skuId\": {\n              \"type\": \"string\"\n            },\n            \"barcode\": {\n              \"type\": \"string\"\n            },\n            \"quantity\": {\n              \"type\": \"integer\"\n            }\n          },\n          \"required\": [\n            \"skuId\",\n            \"quantity\"\n          ]\n        }\n      ]\n    },\n    \"labelBarcode\": {\n      \"type\": \"string\"\n    },\n    \"trackingNumber\": {\n      \"type\": \"string\"\n    },\n    \"trackingUrl\": {\n      \"type\": \"string\"\n    },\n    \"parcelId\": {\n      \"type\": \"string\"\n    }\n  },\n  \"required\": [\n    \"dispatchDate\",\n    \"shipmentNumber\",\n    \"fulfilmentLocationId\",\n    \"dispatchedItems\",\n    \"labelBarcode\",\n    \"trackingNumber\",\n    \"trackingUrl\"\n  ]\n}\n\n

\n","urlObject":{"path":["v2","order","dispatchParcel"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"4cd90216-e02c-42bd-a45c-a0e1cb827d55","name":"Parcel Dispatch Message (Success)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"dispatchDate\": \"2022-05-27T13:19:28Z\",\n \"shipmentNumber\": \"245645704\",\n \"fulfilmentLocationId\": 1021,\n \"dispatchedItems\": [\n {\n \"skuId\": \"Loreal/Black/40\",\n \"barcode\": \"3600520761145\",\n \"quantity\": 1\n }\n ],\n \"labelBarcode\": \"THG245645704\",\n \"trackingNumber\": \"HZYEJC0131117751\",\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=HZYEJC0131117751\",\n \"parcelId\": \"THG245645704Parcel\"\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/dispatchParcel"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"6f6619c9-d704-4297-9f83-13f25e58bf41","name":"Parcel Dispatch Message (Failure)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"dispatchDate\": \"\",\n \"shipmentNumber\": \"245645704\",\n \"fulfilmentLocationId\": 0,\n \"dispatchedItems\": [\n {\n \"skuId\": \"Loreal/Black/40\",\n \"barcode\": \"3600520761145\",\n \"quantity\": 1\n }\n ],\n \"labelBarcode\": \"THG245645704\",\n \"trackingNumber\": \"HZYEJC0131117751\",\n \"trackingUrl\": \"https://www.hermesworld.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=HZYEJC0131117751\",\n \"parcelId\": \"THG245645704Parcel\"\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/dispatchParcel"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"a1287697-90d7-4b0d-b061-10963b5ff278"},{"name":"Shipment Dispatch Message ref: SHI.I.04","id":"01b65a56-ce15-4a0f-83bd-8fca86e8f3e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"dispatchDate\": \"2000-01-20T10:00:00\",\n \"shipmentNumber\": \"string\",\n \"fulfilmentLocationId\": 0,\n \"dispatchedItems\": [\n {\n \"skuId\": \"string\",\n \"barcode\": \"string\",\n \"quantity\": 0,\n \"bundleId\": 0\n }\n ],\n \"labelBarcode\": \"string\",\n \"trackingNumber\": \"string\",\n \"trackingUrl\": \"string\",\n \"courierProviderName\": \"string\",\n \"courierServiceName\": \"string\"\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/dispatchShipment","description":"

The unique product identifier of the dispatched item should exactly match those sent to the 3PL in the shipment request message. If the 3PL has arranged the courier, then the tracking number and tracking URL needs to be populated.

The quantities in the shipment dispatch message should not be more than the quantities sent to the 3PL in the shipment request message.

Shipment dispatch with 0 quantities against all product lines will lead to partial shipment cancellation, which can result in incorrect reporting. It is recommended to use the shipment cancellation module instead.

For bundles support, kindly refer to examples specific to bundles.

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
shipmentNumber	String	Yes	Unique Identifier for a shipment
dispatchDate	String	Yes	Date the order is created, Ex: \"2022-01-20T10:00:00\", UTC Format
fulfilmentLocationId	Long	Yes	Id of fulfilment location, eg store id or warehouse id
dispatchedItems skuId barcode quantity bundleId	Object String String Integer Integer	Yes Yes No Yes No	Items dispatched in the parcel skuId is client's product id (External product id) bundleId is Mandatory if dispatched item is a bundle. bundleId is THG bundle SKU id. This is sent in shipment message along with bundleComponents if a shipment line is a bundle. In order to let us know about dispatch of a bundle from the shipment, its corresponding bundleId is expected to be sent. quantity field in this case refers to the quantity of complete bundle that is dispatched and not individual components of the bundle.
labelBarcode	String	Yes	Barcode on courier label. If THG uses their own courier then this information is mandatory.
trackingNumber	String	Yes	Carrier track number will contain the generated consignment number for the relevant carrier. If THG uses their own courier then this information is mandatory.
trackingUrl	String	Yes	Carrier tracking url for the relevant carrier. If THG uses their own courier then this information is mandatory.
courierProviderName	String	No	Name of courier provider used. eg. Evri
courierServiceName	String	No	Name of courier provider's service used. eg. Evri Standard

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"dispatchDate\": {\n      \"type\": \"string\"\n    },\n    \"shipmentNumber\": {\n      \"type\": \"string\"\n    },\n    \"fulfilmentLocationId\": {\n      \"type\": \"integer\"\n    },\n    \"dispatchedItems\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"skuId\": {\n              \"type\": \"string\"\n            },\n            \"barcode\": {\n              \"type\": \"string\"\n            },\n            \"quantity\": {\n              \"type\": \"integer\"\n            },\n            \"bundleId\": {\n              \"type\": \"integer\"\n            }\n          },\n          \"required\": [\n            \"skuId\",\n            \"quantity\"\n          ]\n        }\n      ]\n    },\n    \"labelBarcode\": {\n      \"type\": \"string\"\n    },\n    \"trackingNumber\": {\n      \"type\": \"string\"\n    },\n    \"trackingUrl\": {\n      \"type\": \"string\"\n    }\n  },\n  \"required\": [\n    \"dispatchDate\",\n    \"shipmentNumber\",\n    \"fulfilmentLocationId\",\n    \"dispatchedItems\",\n    \"labelBarcode\",\n    \"trackingNumber\",\n    \"trackingUrl\"\n  ]\n}\n\n

\n","urlObject":{"path":["v2","order","dispatchShipment"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"066d5509-8913-4980-a190-7f0be003f550","name":"Shipment Dispatch Message (Success)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"dispatchDate\": \"2022-05-27T13:19:28Z\",\n \"shipmentNumber\": \"245645704\",\n \"fulfilmentLocationId\": 1021,\n \"dispatchedItems\": [\n {\n \"skuId\": \"Loreal/Black/40\",\n \"barcode\": \"3600520761145\",\n \"quantity\": 1\n }\n ],\n \"labelBarcode\": \"THG245645704\",\n \"trackingNumber\": \"HZYEJC0131117751\",\n \"trackingUrl\": \"https://www.evri.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=HZYEJC0131117751\",\n \"courierProviderName\": \"Evri\",\n \"courierServiceName\": \"Evri Standard\"\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/dispatchShipment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"df47e853-d438-4994-b819-9153395793fa","name":"Bundle Shipment Dispatch Message - Full Shipment Dispatch(Success)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"dispatchDate\": \"2022-05-20T13:19:28Z\",\n \"shipmentNumber\": \"245645704\",\n \"fulfilmentLocationId\": 123,\n \"dispatchedItems\": [\n {\n \"barcode\": \"PRERELEASE\",\n \"bundleId\": 9999,\n \"quantity\": 2\n },\n {\n \"barcode\": \"PRERELEASE\",\n \"bundleId\": 9998,\n \"quantity\": 1\n },\n {\n \"barcode\": \"3600520761143\",\n \"quantity\": 1\n }\n ],\n \"labelBarcode\": \"THG245645704\",\n \"trackingNumber\": \"HZYEJC0131117751\",\n \"trackingUrl\": \"https://www.evri.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=HZYEJC0131117751\",\n \"courierProviderName\": \"Evri\",\n \"courierServiceName\": \"Evri Standard\"\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/dispatchShipment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"7a9aa0f9-d4e6-4abd-8ba3-ffe93400be39","name":"Bundle Shipment Dispatch Message - Partial shipment dispatch (Success)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"dispatchDate\": \"2022-05-20T13:19:28Z\",\n \"shipmentNumber\": \"245645704\",\n \"fulfilmentLocationId\": 123,\n \"dispatchedItems\": [\n {\n \"barcode\": \"PRERELEASE\",\n \"bundleId\": 9999,\n \"quantity\": 1\n },\n {\n \"barcode\": \"3600520761143\",\n \"quantity\": 1\n }\n ],\n \"labelBarcode\": \"THG245645704\",\n \"trackingNumber\": \"HZYEJC0131117751\",\n \"trackingUrl\": \"https://www.evri.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=HZYEJC0131117751\",\n \"courierProviderName\": \"Evri\",\n \"courierServiceName\": \"Evri Standard\"\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/dispatchShipment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"dff22715-ed7e-4b5b-8b32-f20fa9b83a25","name":"Bundle Shipment Dispatch Message - Dispatching bundle components without bundle id 9999(Failure)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"dispatchDate\": \"2022-05-20T13:19:28Z\",\n \"shipmentNumber\": \"245645704\",\n \"fulfilmentLocationId\": 123,\n \"dispatchedItems\": [\n {\n \"barcode\": \"2600520761144\",\n \"quantity\": 2\n },\n {\n \"barcode\": \"2600520761145\",\n \"quantity\": 3\n },\n {\n \"barcode\": \"PRERELEASE\",\n \"bundleId\": 9998,\n \"quantity\": 1\n },\n {\n \"barcode\": \"3600520761143\",\n \"quantity\": 1\n }\n ],\n \"labelBarcode\": \"THG245645704\",\n \"trackingNumber\": \"HZYEJC0131117751\",\n \"trackingUrl\": \"https://www.evri.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=HZYEJC0131117751\",\n \"courierProviderName\": \"Evri\",\n \"courierServiceName\": \"Evri Standard\"\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/dispatchShipment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"3d2046e4-de33-4728-91fe-bcbd72325410","name":"Shipment Dispatch Message (Failure)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"dispatchDate\": \"\",\n \"shipmentNumber\": \"245645704\",\n \"fulfilmentLocationId\": 0,\n \"dispatchedItems\": [\n {\n \"skuId\": \"Loreal/Black/40\",\n \"barcode\": \"3600520761145\",\n \"quantity\": 1\n }\n ],\n \"labelBarcode\": \"THG245645704\",\n \"trackingNumber\": \"HZYEJC0131117751\",\n \"trackingUrl\": \"https://www.evri.com/en/our-services/distribution/parcel-delivery/parcel-tracking/?trackingNo=HZYEJC0131117751\",\n \"courierProviderName\": \"Evri\",\n \"courierServiceName\": \"Evri Standard\"\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/dispatchShipment"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"01b65a56-ce15-4a0f-83bd-8fca86e8f3e4"},{"name":"Cancel Shipment Message (Partial/Full) ref: SHI.I.03","id":"fcdc3ff7-6e43-4fdd-ae45-f9ffd20bd2f6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"shipmentNumber\": \"string\",\n \"cancelDate\": \"2000-01-20T10:00:00\",\n \"reasonCode\": \"DAMAGED || FAULTY || NOT_AVAILABLE\",\n \"fulfilmentLocationId\": 0,\n \"orderLines\": [\n {\n \"skuId\": \"string\",\n \"barcode\": \"string\",\n \"quantity\": 0,\n \"bundleId\": 0,\n \"toBeRecycled\": true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/cancelShipment","description":"

When the 3PL wants to cancel a Shipment either partially or fully (i.e. short shipping), they can send THG a shipment cancellation message. THG will provide the 3PL with a limited number of HTTP response codes. After receiving shipment cancellation message, THG will close the shipment if there are no more outstanding products to deliver. Any errors or validations will be notified to the 3PL via the cancel shipment notification endpoint (details outlined within the Outbound communication section).

THG will hold configuration per client site/locale to determine if the shipment needs to be recycled.

For bundles support, kindly refer to examples specific to bundles.

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"shipmentNumber\": {\n      \"type\": \"string\"\n    },\n    \"cancelDate\": {\n      \"type\": \"string\"\n    },\n    \"reasonCode\": {\n      \"type\": \"string\"\n    },\n    \"fulfilmentLocationId\": {\n      \"type\": \"integer\"\n    },\n    \"orderLines\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"skuId\": {\n              \"type\": \"string\"\n            },\n            \"barcode\": {\n              \"type\": \"string\"\n            },\n            \"quantity\": {\n              \"type\": \"integer\"\n            },\n            \"toBeRecycled\": {\n              \"type\": \"boolean\"\n            },\n            \"bundleId\": {\n              \"type\": \"integer\"\n            }\n          },\n          \"required\": [\n            \"skuId\",\n            \"quantity\"\n          ]\n        }\n      ]\n    }\n  },\n  \"required\": [\n    \"shipmentNumber\",\n    \"cancelDate\",\n    \"reasonCode\",\n    \"fulfilmentLocationId\",\n    \"orderLines\"\n  ]\n}\n\n

\n","urlObject":{"path":["v2","order","cancelShipment"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"bcf00edc-c5ef-45ae-8876-2e7a67c63e8d","name":"Cancel Shipment Message (Success)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"shipmentNumber\": \"245645704\",\n \"cancelDate\": \"2022-05-29T13:19:28Z\",\n \"reasonCode\": \"DAMAGED\",\n \"fulfilmentLocationId\": 1021,\n \"orderLines\": [\n {\n \"skuId\": \"Loreal/Black/40\",\n \"quantity\": 1,\n \"toBeRecycled\": true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/cancelShipment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"612e3a6d-7a45-4730-9252-a1b93e1cbb62","name":"Bundle Cancel Shipment Message - Full cancel (Success)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"shipmentNumber\": \"245645704\",\n \"cancelDate\": \"2022-05-29T13:19:28Z\",\n \"reasonCode\": \"DAMAGED\",\n \"fulfilmentLocationId\": 123,\n \"orderLines\": [\n {\n \"barcode\": \"PRERELEASE\",\n \"bundleId\": 9999,\n \"quantity\": 2,\n \"toBeRecycled\": false\n },\n {\n \"barcode\": \"PRERELEASE\",\n \"bundleId\": 9998,\n \"quantity\": 1,\n \"toBeRecycled\": false\n },\n {\n \"barcode\": \"3600520761143\",\n \"quantity\": 1,\n \"toBeRecycled\": false\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/cancelShipment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"637b03a7-8428-4487-a0bc-213f02ae9780","name":"Bundle Cancel Shipment Message - Partial shipment cancel (Success)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"shipmentNumber\": \"245645704\",\n \"cancelDate\": \"2022-05-29T13:19:28Z\",\n \"reasonCode\": \"DAMAGED\",\n \"fulfilmentLocationId\": 123,\n \"orderLines\": [\n {\n \"barcode\": \"PRERELEASE\",\n \"bundleId\": 9999,\n \"quantity\": 1,\n \"toBeRecycled\": false\n },\n {\n \"barcode\": \"3600520761143\",\n \"quantity\": 1,\n \"toBeRecycled\": false\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/cancelShipment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"1f99a37c-f3bd-4397-afaf-6f5ed4740581","name":"Bundle Cancel Shipment Message - Partial shipment cancel (Success) Copy","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"shipmentNumber\": \"245645704\",\n \"cancelDate\": \"2022-05-29T13:19:28Z\",\n \"reasonCode\": \"DAMAGED\",\n \"fulfilmentLocationId\": 123,\n \"orderLines\": [\n {\n \"barcode\": \"PRERELEASE\",\n \"bundleId\": 9999,\n \"quantity\": 1,\n \"toBeRecycled\": false\n },\n {\n \"barcode\": \"3600520761143\",\n \"quantity\": 1,\n \"toBeRecycled\": false\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/cancelShipment"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"5f2a7003-0a2b-45f4-a3d1-a4f0c6aac2bb","name":"Cancel Shipment Message (Failure)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"shipmentNumber\": \"245645704\",\n \"cancelDate\": \"2022-05-29T13:19:28Z\",\n \"reasonCode\": \"DAMAGED\",\n \"fulfilmentLocationId\": 1021,\n \"orderLines\": [\n {\n \"skuId\": \"Loreal/Black/40\",\n \"quantity\": 1,\n \"toBeRecycled\": true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/cancelShipment"},"status":"Internal Server Error","code":500,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"fcdc3ff7-6e43-4fdd-ae45-f9ffd20bd2f6"}],"id":"ab276484-049d-41af-9e01-30c4a4621882","_postman_id":"ab276484-049d-41af-9e01-30c4a4621882","description":""}],"id":"9206f21c-984b-4fa6-884a-fe3433d4b19f","description":"

THG will send Shipments to the 3PL Warehouse or Store for fulfillment. The call to the 3PL’s will be asynchronous expecting only a limited number of HTTP response codes and ignoring any message body. Any errors or validations will have to be notified to THG via the Shipment Notification endpoint (details outlined below within Inbound communication).

An Order refers to the comprehensive list of items that a customer has selected and completed the checkout process for on the website. A Shipment denotes a specific allocation of items dispatched to a designated warehouse for fulfilment. It is important to note that a single order may generate multiple shipments, depending on factors such as item availability, shipping methods, and warehouse locations.

\n","_postman_id":"9206f21c-984b-4fa6-884a-fe3433d4b19f"},{"name":"Returns","item":[{"name":"Outbound","item":[{"name":"Returns Message ref: RET.O.01","id":"1f67f1bc-5b2b-4e9a-a071-fe1e96ecbe06","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}"}],"body":{"mode":"raw","raw":"{\n \"returnShipmentNumber\": 0,\n \"createdDate\": \"string\",\n \"expiryDate\": \"string\",\n \"notes\": \"string\",\n \"orderId\": \"string\",\n \"externalReturnReference\": \"string\",\n \"returnSender\": {\n \"channel\": \"string\",\n \"countryCode\": \"string\",\n \"locale\": \"string\",\n \"returnSenderType\": \"COURIER || CUSTOMER\",\n \"senderReferenceNumber\": 0,\n \"labelBarcode\": \"string\"\n },\n \"returnStatus\": \"CANCELLED || COMPLETED || CONTACTED || CREATED || HELD || IDENTIFIED || MANUAL_RESOLVED || PROCESSED || UNEXPECTED\",\n \"returnWarehouse\": {\n \"returnWarehouseId\": 0,\n \"returnWarehouseName\": \"string\"\n },\n \"processedBy\":0,\n \"returnLines\": [\n {\n \"skuId\": \"string\",\n \"thgSkuId\": 0,\n \"barcode\": \"abc\",\n \"barcodes\": {\n \"EAN\": [\n \"string\"\n ],\n \"UPC\": [\n \"string\"\n ]\n },\n \"productType\": \"DROP || ECOM || REG\",\n \"sellerId\": \"string\",\n \"quantity\": 0,\n \"processedState\": \"DAMAGED || FAULTY || PRISTINE\",\n \"expectedLineNotReceived\": \"boolean\",\n \"returnReason\": {\n \"reasonId\": 0,\n \"reasonName\": \"string\",\n \"returnLineState\": \"DAMAGED || FAULTY || PRISTINE\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/return-create","description":"

The notification message is the full view of the return shipment. This is in the same form as the response from fetching the return shipment via the API.

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
returnShipmentNumber	Integer	Yes	Unique Identifier for a returns shipment
orderId	String	Yes	Unique Identifier for an order
clientOrderReference	String	No	The client order reference
createdDate	String	Yes	Date the return is created, Ex: \"2022-01-20T10:00:00\", UTC Format
expiryDate	String	Yes	Date the return is set to expire, Ex: \"2022-01-20T10:00:00\", UTC Format
notes	String	No	Additional notes on the return
externalReturnReference	String	Yes - if using THG warehouse for returns	External reference to the return - to scan at a THG warehouse to link parcel to a return shipment
returnStatus	String	Yes	The state the return is currently in. See 'Return States' here.

Return Sender

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
senderReferenceNumber	Integer	Yes	Customer reference number
returnSenderType	String	Yes	`CUSTOMER` or `COURIER`
locale	String[5]	No	Order locale - a mix of ISO-3166 country codes and ISO-639 language codes separated by `_`. Examples: `en_GB`, `it_IT`, `de_DE`, `fr_FR`
channel	String	Yes	Order channel
countryCode	String	Yes	Country code

Return Warehouse

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
returnWarehouseId	Integer	Yes	Return warehouse Id
returnWarehouseName	String	No	The name of the return warehouse

Return Lines

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
skuId	String	No	Client Sku Id
thgSkuId	Integer	Yes	Thg Sku Id
barcode	String	Yes	Product Barcode
barcodes	Map (String)	Yes	Map of product barcodes
quantity	Integer	Yes	Quantity expected/returned - updated after return is processed
processedState	String	No	The actual state the item was returned in. This is `null` until the item arrives at the warehouse.
expectedLineNotReceived	Boolean	No	If this return line was expected in the original RMA but was not received. This could be because: - the customer wanted to return product B but did not send product B in; - the customer said they’d return product B in state PRISTINE but sent it in state DAMAGED - this would create a separate processed return line and mark the original as expectedLineNotReceived = true. This is `null` until the return shipment arrives at the warehouse.
returnReason		Yes	Reason of return of product (check all return reason in 'Return')

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"returnShipmentNumber\": {\n      \"type\": \"integer\"\n    },\n    \"createdDate\": {\n      \"type\": \"string\"\n    },\n    \"expiryDate\": {\n      \"type\": \"string\"\n    },\n    \"notes\": {\n      \"type\": \"string\"\n    },\n    \"orderId\": {\n      \"type\": \"string\"\n    },\n    \"externalReturnReference\": {\n      \"type\": \"string\"\n    },\n    \"returnSender\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"channel\": {\n          \"type\": \"string\"\n        },\n        \"countryCode\": {\n          \"type\": \"string\"\n        },\n        \"locale\": {\n          \"type\": \"string\"\n        },\n        \"returnSenderType\": {\n          \"type\": \"string\"\n        },\n        \"senderReferenceNumber\": {\n          \"type\": \"integer\"\n        },\n        \"labelBarcode\": {\n          \"type\": \"string\"\n        }\n      },\n      \"required\": [\n        \"channel\",\n        \"countryCode\",\n        \"locale\",\n        \"returnSenderType\",\n        \"senderReferenceNumber\",\n        \"labelBarcode\"\n      ]\n    },\n    \"returnStatus\": {\n      \"type\": \"string\"\n    },\n    \"returnWarehouse\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"returnWarehouseId\": {\n          \"type\": \"integer\"\n        },\n        \"returnWarehouseName\": {\n          \"type\": \"string\"\n        }\n      },\n      \"required\": [\n        \"returnWarehouseId\",\n        \"returnWarehouseName\"\n      ]\n    },\n    \"returnLines\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"skuId\": {\n              \"type\": \"string\"\n            },\n            \"barcode\": {\n              \"type\": \"string\"\n            },\n            \"barcodes\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"EAN\": {\n                  \"type\": \"array\",\n                  \"items\": [\n                    {\n                      \"type\": \"string\"\n                    }\n                  ]\n                },\n                \"UPC\": {\n                  \"type\": \"array\",\n                  \"items\": [\n                    {\n                      \"type\": \"string\"\n                    }\n                  ]\n                }\n              },\n              \"anyOf\": [\n                {\"required\": [\n                \"EAN\"\n              ]},\n                {\"required\": [\n                \"UPC\"\n              ]}\n              ]\n            },\n            \"productType\": {\n              \"type\": \"string\"\n            },\n            \"sellerId\": {\n              \"type\": \"string\"\n            },\n            \"quantity\": {\n              \"type\": \"integer\"\n            },\n            \"processedState\": {\n              \"type\": \"string\"\n            },\n            \"expectedLineNotReceived\": {\n              \"type\": \"boolean\"\n            },\n            \"returnReason\": {\n              \"type\": \"object\",\n              \"properties\": {\n                \"reasonId\": {\n                  \"type\": \"integer\"\n                },\n                \"reasonName\": {\n                  \"type\": \"string\"\n                },\n                \"returnLineState\": {\n                  \"type\": \"string\"\n                }\n              },\n              \"required\": [\n                \"reasonId\",\n                \"reasonName\",\n                \"returnLineState\"\n              ]\n            }\n          },\n          \"required\": [\n            \"skuId\",\n            \"thgSkuId\",\n            \"barcode\",\n            \"barcodes\",\n            \"productType\",\n            \"quantity\",\n            \"processedState\",\n            \"expectedLineNotReceived\",\n            \"returnReason\"\n          ]\n        }\n      ]\n    }\n  },\n  \"required\": [\n    \"returnShipmentNumber\",\n    \"createdDate\",\n    \"expiryDate\",\n    \"notes\",\n    \"orderId\",\n    \"returnSender\",\n    \"returnStatus\",\n    \"returnWarehouse\",\n    \"returnLines\"\n  ]\n}\n\n

\n","urlObject":{"path":["v2","order","return-create"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"6ee55f86-060d-486a-9af7-4755acff9d3b","name":"Returns Message (Success)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"returnShipmentNumber\": 801094241,\n \"createdDate\": \"2022-05-29T13:19:28Z\",\n \"expiryDate\": \"2022-10-29T13:19:28Z\",\n \"notes\": \"Wrong shade ordered\",\n \"orderId\": \"405524478\",\n \"externalReturnReference\": \"636363636\",\n \"returnSender\": {\n \"channel\": \"MyProtein\",\n \"countryCode\": \"GB\",\n \"locale\": \"en_GB\",\n \"returnSenderType\": \"COURIER\",\n \"senderReferenceNumber\": 12345678,\n \"labelBarcode\": \"123456780\"\n },\n \"returnStatus\": \"CREATED\",\n \"returnWarehouse\": {\n \"returnWarehouseId\": 99,\n \"returnWarehouseName\": \"KDC\"\n },\n \"returnLines\": [\n {\n \"skuId\": \"Loreal/Black/40\",\n \"thgSkuId\": 4353266,\n \"barcode\": \"3600520761145\",\n \"barcodes\": {\n \"EAN\": [\n \"3600520761145\"\n ]\n },\n \"productType\": \"DROP\",\n \"sellerId\": \"1234\",\n \"quantity\": 1,\n \"processedState\": \"DAMAGED\",\n \"expectedLineNotReceived\": false,\n \"returnReason\": {\n \"reasonId\": 10,\n \"reasonName\": \"INCORRECT_ITEM_ORDERED\",\n \"returnLineState\": \"PRISTINE\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/return-create"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"d7716e5b-d28f-4c13-8393-b244f8efffda","name":"Returns Message (Failure)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"returnShipmentNumber\": 501094231,\n \"createdDate\": \"2022-05-29T13:19:28Z\",\n \"expiryDate\": \"2022-10-29T13:19:28Z\",\n \"notes\": \"Wrong shade ordered\",\n \"orderId\": \"405524478\",\n \"returnSender\": {\n \"channel\": \"Matalan\",\n \"countryCode\": \"GB\",\n \"locale\": \"en_GB\",\n \"returnSenderType\": \"COURIER\",\n \"senderReferenceNumber\": 12345678,\n \"labelBarcode\": \"123456780\"\n },\n \"returnStatus\": \"CREATED\",\n \"returnWarehouse\": {\n \"returnWarehouseId\": 99,\n \"returnWarehouseName\": \"KDC\"\n },\n \"processedBy\": 0,\n \"returnLines\": [\n {\n \"skuId\": \"Loreal/Black/40\",\n \"barcode\": \"3600520761145\",\n \"barcodes\": {\n \"EAN\": [\n \"3600520761145\"\n ]\n },\n \"productType\": \"ECOM\",\n \"quantity\": 0,\n \"returnReason\": {\n \"reasonId\": 10,\n \"reasonName\": \"INCORRECT_ITEM_ORDERED\",\n \"returnLineState\": \"PRISTINE\"\n }\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/return-create"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"1f67f1bc-5b2b-4e9a-a071-fe1e96ecbe06"}],"id":"daebaa7d-c51a-4a05-bc4d-3a78f21dc6fa","_postman_id":"daebaa7d-c51a-4a05-bc4d-3a78f21dc6fa","description":""},{"name":"Inbound","item":[{"name":"Returns Receipt Message ref: RET.I.01","id":"e1988e2c-c24c-4d1a-919e-f792f5cc8698","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"createdDate\": \"string\",\n \"returnSenderType\": \"COURIER || CUSTOMER\",\n \"returnWarehouseId\": 0,\n \"returnReceipts\": [\n {\n \"returnShipmentNumber\": \"string\",\n \"orderId\": \"string\",\n \"shipmentNumber\": \"string\",\n \"returnSenderType\": \"COURIER || CUSTOMER\",\n \"returnWarehouseId\": 0,\n \"returnWarehouseName\": \"string\",\n \"returnLines\": [\n {\n \"skuId\": \"string\",\n \"barcode\": \"abc\",\n \"identified\": true,\n \"notes\": \"string\",\n \"processedState\": \"DAMAGED || FAULTY || PRISTINE\",\n \"quantity\": 0\n }\n ],\n \"includesOrderShippingCost\": true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/returnsReceipt","description":"

When a return arrives at the warehouse, the 3PL is responsible for processing it and sending the response of the processing to THG. This is required in order for THG’s system to update the stock accordingly, and either refund or send a replacement product to the customer as per their return shipment requested.

It is essential for the 3PL to send the processed state of each product to THG, as this will decide whether the customer requested action will be actioned or not.

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"createdDate\": {\n      \"type\": \"string\"\n    },\n    \"returnReceipts\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"returnShipmentNumber\": {\n              \"type\": \"string\"\n            },\n            \"shipmentNumber\": {\n              \"type\": \"string\"\n            },\n            \"orderId\": {\n              \"type\": \"string\"\n            },\n            \"returnSenderType\": {\n              \"type\": \"string\"\n            },\n            \"returnWarehouseName\": {\n              \"type\": \"string\"\n            },\n                                \"includesOrderShippingCost\": {\n                      \"type\": \"boolean\"\n                    },\n            \"returnWarehouseId\": {\n              \"type\": \"integer\"\n            },\n            \"returnLines\": {\n              \"type\": \"array\",\n              \"items\": [\n                {\n                  \"type\": \"object\",\n                  \"properties\": {\n                    \"skuId\": {\n                      \"type\": \"string\"\n                    },\n                    \"barcode\": {\n                      \"type\": \"string\"\n                    },\n                    \"identified\": {\n                      \"type\": \"boolean\"\n                    },\n                    \"notes\": {\n                      \"type\": \"string\"\n                    },\n                    \"processedState\": {\n                      \"type\": \"string\"\n                    },\n                    \"quantity\": {\n                      \"type\": \"integer\"\n                    }\n                  },\n                  \"required\": [\n                    \"skuId\",\n                    \"barcode\",\n                    \"identified\",\n                    \"processedState\",\n                    \"quantity\"\n                  ]\n                }\n              ]\n            }\n          },\n          \"required\": [\n            \"returnWarehouseId\",\n            \"returnWarehouseName\",\n            \"returnLines\"\n          ]\n        }\n      ]\n    }\n  },\n  \"required\": [\n    \"createdDate\",\n    \"returnSenderType\",\n    \"returnWarehouseId\",\n    \"returnReceipts\"\n  ]\n}\n\n

The API is very responsive to different scenarios, from happy paths to unexpected situations. For the system to allow multiple returns, the identifier that a return receipt needs to be used is flexible, and not mandatory. The three options for a receipt identfier are:

ReturnShipmentNumber - the return identifier
\n
OrderId - the order number against which the return was raised
\n
ShipmentNumber - the shipment number of the original order, or one of the identifiers in case the order has multiple shipments
\n

Only one of these identifiers needs to be populated in a return receipt, following the rules below:

In a happy path scenario, where the return arriving in the warehouse was expected, you should only populate the ReturnShipmentNumber (you can leave orderId and ShipmentNuber empty).
\n
In an unhappy path scenario, where you have either OrderId or ShipmentNumber, only one of these should be populated. You can leave ReturnShipmentNumber empty. The preference is to use OrderId if you have it rather than shipment number, as returns are raised against orders, not shipments.
\n

As mentioned above, the identifier of the return receipt is interchangeable, and only one of the three mentioned above is expected in each scenario. This allows you to use the same API for both happy and unhappy scenarios.

The use of the identified flag in our API

A client may use the identified flag to mark items which have arrived in the warehouse as part of a return, which they could not identify in the original order against the return has been raised.

\n
Say ORDER 1234 has items 123 and 124 as part of it. If RETURN 385 that was raised against ORDER 1234 has in the box arriving at the warehouse also the product 128, then 128 can be receipted against the return, but with the flag identifed set to false, while 123 and 124 will have the identifed flag set to true.
\n

If the client's warehouse does not have the capability of differentiating between items returned in a warehouse as being part of the original order or not, then all items should be having the identified flag set to true. The THG Returns mechanism runs the items through an internal check too and will separate the identification itself, being able to handle a case like the one examplified above after the receipting happens in the warehouse.

\n
In the example of ORDER 1234, if all 123, 124, and 128 arrive from the warehouse with the identifed flag set to true, although 128 is not part of the original order, our upstream system will still separate it from the expected items, and flag the relevant teams about its receival.
\n

Processed State

Valid processed states can be found here: Ingenuity API: Returns

This state represents the state the product has been returned in.

\n","urlObject":{"path":["v2","order","returnsReceipt"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"18a829aa-256b-4542-ad3d-ee02148f655b","name":"Returns Receipt Notification (Success)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"createdDate\": \"2022-05-31T13:19:28Z\",\n \"returnSenderType\": \"COURIER || CUSTOMER\",\n \"returnWarehouseId\": 0,\n \"returnReceipts\": [\n {\n \"returnShipmentNumber\": \"801094241\",\n \"shipmentNumber\": \"501094231\",\n \"orderId\": \"405524478\",\n \"returnSenderType\": \"COURIER\",\n \"returnWarehouseName\": \"KDC\",\n \"returnWarehouseId\": 99,\n \"returnLines\": [\n {\n \"skuId\": \"Loreal/Black/40\",\n \"barcode\": \"3600520761145\",\n \"identified\": true,\n \"processedState\": \"PRISTINE\",\n \"quantity\": 1\n }\n ],\n \"includesOrderShippingCost\": true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/returnsReceipt"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"shipmentNumber\": \"801094241\",\n \"fulfilmentLocationId\": 99,\n \"success\": true,\n \"error\": {\n \"errorCode\": null, \n \"errorMessage\": null\n }\n}"},{"id":"27b1ae5a-886f-412f-a7c7-ad14558625b3","name":"Returns Receipt Notification (Failure)","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"shipmentNumber\": \"501094231\",\n \"returnShipmentNumber\": \"801094241\",\n \"createdDate\": \"2022-05-31T13:19:28Z\",\n \"returnSenderType\": \"COURIER\",\n \"returnWarehouseId\": 0,\n \"returnWarehouseName\": \"KDC\",\n \"returnReceipts\": [\n {\n \"orderId\": \"405524478\",\n \"returnSenderType\": \"COURIER || CUSTOMER\",\n \"returnWarehouseId\": 0,\n \"returnWarehouseName\": \"KDC\",\n \"returnLines\": [\n {\n \"skuId\": \"Loreal/Black/40\",\n \"barcode\": \"3600520761145\",\n \"identified\": false,\n \"processedState\": \"PRISTINE\",\n \"quantity\": 1\n }\n ],\n \"includesOrderShippingCost\": true\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/returnsReceipt"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":null,"cookie":[],"responseTime":null,"body":"{\n \"shipmentNumber\": \"801094241\",\n \"fulfilmentLocationId\": 0,\n \"success\": false,\n \"error\": {\n \"errorCode\": \"IDENTIFIER_MISSING\",\n \"errorMessage\": null\n }\n}"}],"_postman_id":"e1988e2c-c24c-4d1a-919e-f792f5cc8698"},{"name":"Returns Notification ref: RET.I.02","id":"0bf6a92f-242a-4db0-9c22-051d2cc912bb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"returnShipmentNumber\": \"int\",\n \"success\": false,\n \"error\": [\n {\n \"errorCode\": \"INVALID_QUANTITY || INVALID_CONTENT || IDENTIFIER_MISSING\",\n \"errorMessage\": \"string\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/returnsNotification","description":"

Any there are any validation failures or errors related to the returns, the 3PL is obligated to send us a notification with pre-defined error codes and explanations.

Request

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Property	Type	Mandatory	Description
returnShipmentNumber	Integer	Yes	Unique Return Shipment Identifier
success	Boolean	Yes	Either `true` or `false`. If `success` is `false` then `errorCode` and `errorMessage` are mandatory
error errorCode errorMessage	Object String String	Only if `success`is `false`	Error message with error code. Allowed values are: `INVALID_QUANTITY`, `INVALID_CONTENT` or `IDENTIFIER_MISSING`

Error Code Description

\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n

Error Code	Message
INVALID_QUANTITY	Quantity cannot be negative or Zero
INVALID_CONTENT	Request Content is Invalid
IDENTIFIER_MISSING	`fulfilmentLocationId` is missing

JSON Schema

{\n  \"$schema\": \"http://json-schema.org/draft-04/schema#\",\n  \"type\": \"object\",\n  \"properties\": {\n    \"returnShipmentNumber\": {\n      \"type\": \"string\"\n    },\n    \"success\": {\n      \"type\": \"boolean\"\n    },\n    \"error\": {\n      \"type\": \"array\",\n      \"items\": [\n        {\n          \"type\": \"object\",\n          \"properties\": {\n            \"errorCode\": {\n              \"type\": \"string\"\n            },\n            \"errorMessage\": {\n              \"type\": \"string\"\n            }\n          },\n          \"required\": [\n            \"errorCode\",\n            \"errorMessage\"\n          ]\n        }\n      ]\n    }\n  },\n  \"required\": [\n    \"returnShipmentNumber\",\n    \"success\",\n    \"error\"\n  ]\n}\n\n

\n","urlObject":{"path":["v2","order","returnsNotification"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"c5a06667-66c5-42bf-84ba-84b8b8f4bd4f","name":"Returns Notification (Success)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"returnShipmentNumber\": 245645704,\n \"success\": true,\n \"error\": []\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/returnsNotification"},"status":"OK","code":200,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"},{"id":"4e8b1e34-bbe1-44e1-b986-b1bf57503964","name":"Returns Notification (Failure)","originalRequest":{"method":"POST","header":[{"key":"Authorization","value":"{{token}}","type":"text"}],"body":{"mode":"raw","raw":"{\n \"returnShipmentNumber\": 245645704,\n \"success\": false,\n \"error\": [\n {\n \"errorCode\": \"INVALID_CONTENT\",\n \"errorMessage\": \"Incorrect Country Code\"\n },\n {\n \"errorCode\": \"INVALID_QUANTITY\",\n \"errorMessage\": \"Inadequate Quantity Received\"\n }\n ]\n}","options":{"raw":{"language":"json"}}},"url":"/v2/order/returnsNotification"},"status":"Bad Request","code":400,"_postman_previewlanguage":null,"header":null,"cookie":[],"responseTime":null,"body":"{}"}],"_postman_id":"0bf6a92f-242a-4db0-9c22-051d2cc912bb"}],"id":"8e0ba442-830e-49d7-bd4b-612119813cd0","_postman_id":"8e0ba442-830e-49d7-bd4b-612119813cd0","description":""}],"id":"7dc6fe27-a51a-49a0-9153-2dc7814389ab","description":"

This is the warehouse section of returns - for more information please proceed here.

\n","_postman_id":"7dc6fe27-a51a-49a0-9153-2dc7814389ab"}],"id":"045b3af3-df65-4f8b-841b-2ebfc81925f3","description":"

Asynchronous!

This warehouse API is an asynchronous API whereby the structure of the messages are checked while sending and receiving the messages but the content is not.

This means that any message that follows the JSON schema definition MUST be accepted by the receiving party and be answered with a 202 - Accepted status response.

Content validation

Any content validation needs to happen after the message is received. Based on the agreed SLA with THG Ingenuity on for instance address checking and postal code checks, any invalid data that prevents either party processing the message needs to be responded to with a notification.

Non-processing

If THG Ingenuity or the clients systems sends a notification, that means that the MESSAGE IS INVALID AND HAS BEEN IGNORED. The party needs to re-send valid data to initiate the required response.

For instance if you would send THG Ingenuity a shipment message which contains one line where you shipped more quantity then requested or you ship a product that has not been included in the shipment, we will send you a notification and ignore the message completely. So there is no partial processing of faulty messages.

Standard Warehouse API Choreography:

","_postman_id":"045b3af3-df65-4f8b-841b-2ebfc81925f3"}],"variable":[{"key":"url","value":""}]}