Shipment Packed

This REST API is used to notify the Partner when the shipment has been packed in Uniware.

Tip

The access token received in response is required in Header (apikey) in all subsequent API requests.

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
BaseUrl:	https://{PartnerBaseUrl}
Endpoint:	/invoiced
Request Type:	POST
Scheme:	HTTPS
Header (Content-Type):	application/json
Header (Authorization):	token value(got from Authentication

Request Payload

{
  "invoiceCode": "string",
  "invoiceDisplayCode": "string",
  "saleOrderCode": "string",
  "displayOrderCode": "string",
  "shippingPackageCode": "string",
  "channelCreated": "2020-07-17T09:36:53.662Z",
  "created": "2020-07-17T09:36:53.662Z",
  "URL": "String",
  "customFieldValues": [
    {
      "name": "string",
      "value": "string"
    }
  ],
  "invoiceItems": [
    {
      "soiCode": "commaseperatedsoicodes",
      "cashOnDeliveryCharges": 0,
      "channelProductId": "string",
      "discount": 0,
      "giftWrapCharges": 0,
      "integratedGst": 0,
      "integratedGstPercentage": 0,
      "itemSku": "string",
      "prepaidAmount": 0,
      "quantity": 0,
      "skuCode": "string",
      "sellingPrice": 0,
      "shippingCharges": 0,
      "shippingMethodCharges": 0,
      "stateGst": 0,
      "stateGstPercentage": 0,
      "unionTerritoryGst": 0,
      "storeCredit": 0,
      "subtotal": 0,
      "taxPercentage": 0,
      "total": 0,
      "totalTax": 0,
      "compensationCess": 0,
      "compensationCessPercentage": 0,
      "cst": 0,
      "cstPercentage": 0,
      "centralGst": 0,
      "centralGstPercentage": 0,
      "unionTerritoryGstPercentage": 0,
      "additionalTax": 0,
      "additionalTaxPercentage": 0,
      "vat": 0,
      "vatPercentage": 0,
      "unitPrice": 0,
      "voucherValue": 0,
      "unionTerritoryGst": 0,
      
    }
  ],
  "paymentDetail": {
    "amountPaid": 1000,
    "paymentMode": null,
    "transactionId": null
  },
  
}

Request Payload Details

LEVEL	PARAMETER	TYPE	DESCRIPTION	MANDATORY	NOTES
1	invoiceCode	string	Invoice code	Yes	-
2	invoiceDisplayCode	string	Invoice Display code	Yes	-
3	saleOrderCode	string	Sale Order code	Yes	-
4	displayOrderCode	string	Display Order code	Yes	-
5	shippingPackageCode	string	Shipping package code	Yes	-
6	channelCreated	string	Channel creation timestamp	Yes	-
7	created	string	Invoice creation timestamp	Yes	-
8	URL	string	URL associated with the invoice	Yes	-
9	customFieldValues	Object	Custom field details	Yes	-
9.1	name	string	Custom field name	Yes	-
9.2	value	string	Custom field value	Yes	-
10	invoiceItems	Object	Invoice items details	Yes	-
10.1	soiCode	string	Comma-separated codes of associated sale order items	Yes	-
10.2	cashOnDeliveryCharges	number	Cash On Delivery Charges	Yes	-
10.3	channelProductId	string	Channel Product Id	Yes	-
10.4	discount	number	Discount Value	Yes	-
10.5	giftWrapCharges	number	Charges for gift wrapping	Yes	-
10.6	integratedGst	number	Integrated GST	Yes	-
10.7	integratedGstPercentage	number	Percentage of integrated GST	Yes	-
10.8	itemSku	string	Item SKU	Yes	-
10.9	prepaidAmount	number	Prepaid amount	Yes	-
10.1	quantity	number	Quantity of the item	Yes	-
10.11	skuCode	string	SKU code	Yes	-
10.12	sellingPrice	number	Selling price	Yes	-
10.13	shippingCharges	number	Shipping charges	Yes	-
10.14	shippingMethodCharges	number	Shipping Method Charges	Yes	-
10.15	stateGst	number	State GST value	Yes	-
10.16	stateGstPercentage	number	Percentage of state GST	Yes	-
10.17	unionTerritoryGst	number	Union Territory GST value	Yes	-
10.18	storeCredit	number	Store credit	Yes	-
10.19	subtotal	number	Subtotal amount	Yes	-
10.2	taxPercentage	number	Tax percentage in case of VAT tax	Yes	-
10.21	total	number	Total amount	Yes	-
10.22	totalTax	number	Total tax amount	Yes	-
10.23	compensationCess	number	Compensation cess value	Yes	-
10.24	compensationCessPercentage	number	Percentage of compensation cess	Yes	-
10.25	cst	number	CST (Central Sales Tax) value	Yes	-
10.26	cstPercentage	number	Percentage of CST	Yes	-
10.27	centralGst	number	Central GST value	Yes	-
10.28	centralGstPercentage	number	Percentage of central GST	Yes	-
10.29	unionTerritoryGstPercentage	number	Percentage of Union Territory GST	Yes	-
10.3	additionalTax	number	Additional tax value	Yes	-
10.31	additionalTaxPercentage	number	Percentage of additional tax	Yes	-
10.32	vat	number	VAT (Value Added Tax) value	Yes	-
10.33	vatPercentage	number	Percentage of VAT	Yes	-
10.34	unitPrice	number	Unit price of the item	Yes	-
10.35	voucherValue	number	Value of vouchers	Yes	-
11	paymentDetail	Object	Details of the payment	Yes	-
11.1	amountPaid	number	Amount paid	Yes	-
11.2	paymentMode	string	Payment mode used	Yes	Null
11.3	transactionId	string	Transaction ID	Yes	Null

Response Payload

{
    "status": "Success",
    "message": "Detail is updated successfully"    
}

Response Payload Details

LEVEL	PARAMETER	TYPE	DESCRIPTION	MANDATORY	NOTES
1	status	string	Success after notification is acknowledged	Yes	Success/Failed
2	message	string	Readable response message	Yes	-

Error Codes

Refer Response Codes section to know about specific errors codes.

FAQs/Notes

Q1. What would be that frequency of Notification push to partner?
Ans. Real-time or nearly real-time.