Force Dispatch Shipping Package

This REST API is used to mark a single shipment dispatched as dispatched from an intermediary stage in Uniware using shipping package code with other details.

The API is able to mark force dispatch on shipping package status:

For NONE traceability: CREATED, PICKING, PICKED, PACKED, READY_TO_SHIP,MANIFESTED
For ITEM_SKU level traceability: CREATED, PICKING, PICKED, PACKED, READY_TO_SHIP, MANIFESTED
ITEM Traceability: PACKED, READY_TO_SHIP, MANIFESTED, as we do not mark dispatched shipment on Item trace if not Packed.

Tip

It is recommended to check out Notes for the reader. You might find this helpful as it contains Guidelines for using API references and Terminologies used here.

Basic Information

NAME	DETAILS
Endpoint:	/services/rest/v1/oms/shippingPackage/forceDispatch
Request Type:	POST
Level:	Facility
Scheme:	HTTPS
Header (Content-Type):	application/json
Header (Authorization):	bearer {access-token}, Eg.: bearer b30f3aea-7978-49bb-9ea7-33eddfc80afa
Header (Facility):	facility code as in Uniware (refer FAQs)

Request Payload

{

"shippingPackageCode":"SP-7671",
"shippingProviderCode":"DTDC",
"trackingNumber":"12345678",
"skipDetailing":true,
"skipChannelInvoicing":false,
"invoiceCode":"Sample_1234"

}

Request Payload Details

PARAMETER	TYPE	DESCRIPTION	MANDATORY	NOTES
shippingPackageCode	string	Shipping package code	Yes	-
shippingProviderCode	string	Shipping provider code	No	-
trackingNumber	string	Tracking number	No	-
skipDetailing	Boolean	Skip detailing	No	(true by default)
skipChannelInvoicing	Boolean	Skip channel invoicing	No	(false by default)
invoiceCode	string	invoice code	No	-
channelProductIdToTax	string	product tax information Mapping	No	-

Response Payload

{
   "successful": true,
   "message": "string",
   "errors": [
      {
         "code": 0,
         "fieldName": "string",
         "description": "string",
         "message": "string",
         "errorParams": {
            "additionalProp1": {},
            "additionalProp2": {},
            "additionalProp3": {}
         }
      }
   ],
   "warnings": [
      {
         "code": 0,
         "message": "string",
         "description": "string"
      }
   ],

}

Response Payload Details

LEVEL	PARAMETER	TYPE	DESCRIPTION	NOTES
1	successful	true	Request success status	-
2	message	string	Response message	-
3	errors	list	List of errors (if any)	-
3.1	code	number	Error code	-
3.2	fieldName	string	Field with error	-
3.3	description	string	Error description	-
3.4	message	string	Error message	-
3.5	errorParams	object	Parameters with error	-
3.5.1	additionalProp1	object	Parameter 1 with error	-
3.5.2	additionalProp2	object	Parameter 2 with error	-
3.5.3	additionalProp3	object	Parameter 3 with error	-
4	warnings	list	List of warnings (if any)	-
4.1	code	number	Warning code	-
4.2	message	string	Warning message	-
4.3	description	string	Warning description	-

Sample Curl

curl —location —request POST ’http://xyzabc.unicommerce.com/services/rest/v1/oms/shippingPackage/forceDispatch’
—header ‘Authorization: bearer ddc96f81-fa83-47e1-bdb5-1b93a64b6762’
—header ‘facility: 06’
—header ‘Content-Type: application/json’
—data-raw ’{ “shippingPackageCode”:“SP7671”, “shippingProviderCode”:“DTDC”, “trackingNumber”:“12345678”, “skipDetailing”:true, “skipChannelInvoicing”:false, “invoiceCode”:“Sample_1234” }’

Error Codes

Refer Response Codes section to know about specific errors codes.