Create an Inward Consignment

Create inward consignment

POST https://{{workspace}}.myeshopbox.com/api/v1/createConsignmentApi

This endpoint allows you to create an inward consignment using the following JSON request

Headers

Name	Type	Description
Authentication	string	The Bearer token which allows to grant access to the API
proxyHost*	String	Account Slug

Request Body

Name	Type	Description
documentNumber*	String	Invoice number of the consignment created in your ERP.
referenceNumber	String	Purchase order number of the consignment created in your ERP.
toLocationCode*	String	Location or plant code created in your ERP for the location to which you are sending the inventory.
fromLocationCode*	String	Location or plant code created in your ERP for the location from which you are sending the inventory. Please ensure that the location from where are sending the inventory in added in your Eshopbox workspace.
productId*	String	Any scannable identifier of the product created in your Eshopbox workspace. (ESIN/SKU)
documentDate*	DateTime	Date when document was created.
manufacturing_date	String	The manufacturing date of the product id batch tracking is enabled, and the method is the manufacturing date.
quantity*	String	Total count of the product that you are sending.
batch_code	String	The batch code of the product id batch tracking is enabled, and the method is batch code.
expiry_date	String	The expiry date of the product id whose batch tracking is enabled and the method is the expiry date.

200 Inward consignment successfully created.

{
 "id": "7633",
 "accountId": "28",
 "consignmentNumber": "CON/45/873",
 "documentNumber": "INV/001",
 "referenceNumber": "PO/24/A001",
 "consignmentType": "INWARD",
 "fromPartyID": "8",
 "toPartyID": "72",
 "itemsFileUrl": "https://storage.cloud.google.com/fileItems.appspot.com/items.pdf",
 "status": "CREATING",
 "totalBoxes": 0,
 "processedBoxes": 0,
 "pendingBoxes": 0
}

cURL

curl --location -g --request POST 'https://{{workspace}}.myeshopbox.com/api/v1/createConsignmentApi' \
--header 'ProxyHost: <<accountSlug>>' \
--header 'Authorization: Bearer XXXX' \
--header 'Content-Type: application/json' \
--data-raw '{
    "documentNumber": "INV/001",
    "referenceNumber": "PO/24/A001",
    "documentDate": "2022-12-18 00:00:00",
    "fromLocationCode": "XXLG",
    "toLocationCode": "ERAY",
    "productDetails": [
        {
            "productId": "testing5",
            "quantity": 3,
            "manufacturing_date": "",
            "expiry_date": "",
            "batch_code": ""
        },
        {
            "productId": "testing1",
            "quantity": 9,
            "manufacturing_date": "02-Jun-22",
            "expiry_date": "",
            "batch_code": ""
        },
        {
            "productId": "testing",
            "quantity": 9,
            "manufacturing_date": "",
            "expiry_date": "02-Jun-23",
            "batch_code": ""
        },
        {
            "productId": "testing2",
            "quantity": 9,
            "manufacturing_date": "",
            "expiry_date": "",
            "batch_code": "batch11"
        }
    ]
}'