Overview

This document provides an overview of the structure of the data that will be sent to the client's ASN (Advanced Shipment Notice) API from our side.

API Details

The ASN data will be sent via a POST API endpoint. The API will require authentication using a username and password.

Authentication

The API should authenticate the request using a username and password provided in the request headers.

Response Codes

The API should return the following HTTP response codes:

Status Code	Description
200 OK	The request was successful, and the data was processed correctly.
400 Bad Request	The request body contained invalid or malformed data.
401 Unauthorised	The provided authentication credentials were invalid or missing.
500 Internal Server Error	An unexpected error occurred on the server-side. In case of this error, the API will automatically retry the request.

Data Structure

The data will be sent in JSON format, and the structure will be as follows:

{
  "shipmentCode": "ABC123",
  "shipmentId": 12345,
  "orderCode": "ORD456",
  "boxItemSkuMapping": [
    {
      "boxId": 789,
      "skuSerialCodeMapping": [
      {
        "sku": "SKU001",
        "serialCodes": ["922203DED6B", "922201B7D25", "922201B7D20"],
        "quantity": 3
      }
      ]
    },
    {
      "boxId": 890,
      "skuSerialCodeMapping": [
      {
        "sku": "SKU002",
        "serialCodes": ["922201B7D34", "922201B7D87"],
        "quantity": 2
      }
      ]
    }
  ],
  "vendorCode": "VEND123"
}

Field	Description	Data Type	Mandatory
`shipmentCode`	A string representing the code of the shipment.	String	Yes
`shipmentId`	A number representing the ID of the shipment.	Number	Yes
`orderCode`	A string representing the code of the order.	String	No
`boxItemSkuMapping`	An array of objects containing box ID, SKU to serial code mapping, and quantity.	Array[Object]	Yes
`boxItemSkuMapping.boxId`	A number representing the ID of the box.	Number	Yes
`boxItemSkuMapping.skuSerialCodeMapping`	An array of object containing SKU code, serial codes, and quantity mapping.	Array[Object]	Yes
`boxItemSkuMapping.skuSerialCodeMapping.sku`	A string representing the SKU code.	String	Yes
`boxItemSkuMapping.skuSerialCodeMapping.serialCodes`	An array of strings representing the serial codes.	Array[String]	Yes
`boxItemSkuMapping.skuSerialCodeMapping.quantity`	A string representing the quantity of the SKU.	Number	Yes
`vendorCode`	A string representing the vendor code.	String	Yes