Inbound | POST | /usp/order/pack

Summary

This API will pack the order in the OMS & the respective Integrated Marketplace to Increff system and then return the Invoice & Shipping Label documents in the response.

Description

This API will be used to pack the shipment for an Order having the SKUs passed in the request payload.

Request

{
    "orderCode": "H19304030001",
    "locationCode": "l123",
    "channelName": "Myntra",
    "weight": 40,
    "packageSku": "P1",
    "fulfillmentType": "BLOCK_COMPLETE",
    "packageDetails": {
        "length": 12,
        "breadth": 6,
        "height": 1
    },
    "shipmentItems": [
        {
            "channelSkuCode": "100000789702",
            "quantityToPack": 5,
            "externalSerialCodes": []
        }
    ]
}
Parameter Name Data Type Description Mandatory
orderCode String Unique code used by the channel to identify the order. Yes
locationCode String Code used by channels to identify a warehouse Yes
channelName String Code used to identify a channel Yes
packageSku String SKU of the package material used for packing No
weight Double Weight of the package in grams No
fulfillmentType String Enum with possible values:
BLOCK_COMPLETE
SINGLE_SHIPMENT_PARTIAL
MULTI_SHIPMENT_PARTIAL No
packageDetails Object Dimensions of the packed shipment No
packageDetails.length Double length of shipment box No
packageDetails.breadth Double breadth of shipment box No
packageDetails.height Double height of shipment box No
shipmentItems Object[] List of items corresponding to shipment Yes
shipmentItems.channelSkuCode String SKU code of order item Yes
shipmentItems.quantityToPack Integer Quantity of SKU in shipment Yes
shipmentItems.externalSerialCodes String[] These are the external serial ids for the item No

Response

{
  "orderCode": "H19304030001",
  "locationCode": "l123",
  "channelId": "l123",
  "shipmentCode": "l123",
  "shipmentId": "l123",
  "shippingLabel": {
    "transporter": "INV123",
    "awbNumber": "INV123",
    "shippingLabelUrl": "<https://mybrand.com/shipping-Label123.pdf>",
    "shippingLabel": "invoiceBase64String"
  },
  "invoiceUrl": "<https://mybrand.com/shipping-Label123.pdf>",
  "invoice": "invoiceBase64String",
  "invoiceCode": "INV-1",
  "invoiceDate": "2020-10-16T20:22:28.000+05:30",
  "invoiceDetails": [
    {
      "channelSkuCode": "100000789702",
      "netTaxAmountPerUnit": 60,
      "netTaxAmountTotal": 120,
      "baseSellingPricePerUnit": 500,
      "baseSellingPriceTotal": 1000,
      "actualSellingPricePerUnit": 560,
      "actualSellingPriceTotal": 1120,
      "quantity": 2,
      "taxItems": [
        {
          "type": "SGST",
          "rate": 6,
          "taxPerUnit": 30,
          "taxTotal": 60
        },
        {
          "type": "CGST",
          "rate": 6,
          "taxPerUnit": 30,
          "taxTotal": 60
        }
      ]
    }
  ]
}
Parameter Name Data Type Description Mandatory
orderCode String Unique code used by the channel to identify the order. Yes
locationCode String Code used by channels to identify a warehouse Yes
channelName String Code used to identify a channel Yes
shipmentId Long Shipment id of Increff Omni system Yes
shipmentCode String Unique code used by the channel to identify the shipment Yes
shippingLabel Object Shipping Label Details No
shippingLabel.shippingLabelUrl String Downloadable pdf url of the shipping label document(either of shippingLabel and shippingLabelUrl is mandatory) No
shippingLabel.awbNumber String Tracking number provided by the courier partner Yes
shippingLabel.shippingLabel String Base64 encoded string of the shipping label(either of shippingLabel and shippingLabelUrl is mandatory) No
shippingLabel.transporter String Courier partner name Yes
invoiceCode String Invoice Number that is printed on the invoice PDF Yes
invoiceUrl String Downloadable pdf url of the invoice document(either of invoice and invoice Url is mandatory) No
invoiceDetails Object[] Tax Details of the invoice.
• If invoice details are being sent, then taxItems are mandatory. No
invoiceDate String Date of invoice generated by Increff Omni Yes
invoice String Base64 encoded string of invoice PDF(either of invoice and invoice Url is mandatory) No
invoiceDetails.channelSkuCode String SKU code of order item Yes
invoiceDetails.netTaxAmountPerUnit Double Per unit tax applicable for the SKU Yes
invoiceDetails.netTaxAmountTotal Double Total tax applicable for the SKU Yes
invoiceDetails.baseSellingPricePerUnit Double Per unit base selling price of the SKU Yes
invoiceDetails.baseSellingPriceTotal Double Total base selling price of the SKU Yes
invoiceDetails.actualSellingPricePerUnit Double Per unit actual selling price of the SKU Yes
invoiceDetails.actualSellingPriceTotal Double Total actual selling price of the SKU Yes
invoiceDetails.quantity Integer Total quantity of a sku for a line item Yes
invoiceDetails.taxItems Object[] Distribution of tax with tax type
• If invoice details are being sent, then taxItems are mandatory. Yes
invoiceDetails.taxItems.type String Type of tax applicable Yes
invoiceDetails.taxItems.rate Double Tax rate for this tax type Yes
invoiceDetails.taxItems.taxPerUnit Double Per unit tax applicable for this type of tax Yes
invoiceDetails.taxItems.taxTotal Double Total tax applicable for this type of tax Yes

HttpStatus : 200