Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Inbound | POST | /usp/ manifest

Summary

This API will manifest the orders in Increff OMS system and required the respective marketplace passed in channelName.

Description

This API is used to generate the manifest in Increff OMS for the orders passed in request body and the respective marketplace integrated from Increff system and will return the manifest code & manifest document to external fulfillment system.

Request

Code Block
languagejson
{
    "locationCode": "l123",
    "channelName": "Myntra",
    "transporter": "sku123",
    "orderCodes": ["101","102","103"]
}

Parameter Name

Data Type

Description

Mandatory

locationCode

String

Code used by channels to identify a warehouse

Yes

channelName

String

Code used to identify a channel

Yes

transporter

String

Courier partner name

yesYes

orderCodes

String[]

These are the order codes to be added in the manifest.

Yes

Response

Code Block
{
  "manifestCode": "INV123",
  "externalManifestCode": "INV123",
  "manifestUrl": "https://mybrand.com/manifest123.pdf",
  "manifest": "manifestBase64String"
}

...

Parameter Name

Data Type

Description

Mandatory

manifestCode

String

Unique code used by the OMS to identify the manifest

yesYes

externalManifestCode

String

Unique code used by the channel to identify the manifest

yesYes

manifestUrl

String

Downloadable pdf url of  manifest document(either of manifest and manifestUrl is mandatory)

noNo

manifest

String

Base64 encoded manifest PDF String(either of manifest and manifestUrl is mandatory)

noNo