Outbound | POST | {Client’s URL}

Summary

This API will call the client’s system to pack the order.

Description

This is a pack notification to the client system. It means the shipment is going to be packed with SKUs mentioned in the payload. In case of repeated calls shipmentId should be considered as a repeated identifier and expected response is successful with the same response body.

Note :

Multiple shipments are allowed in case of B2B orders.
Multiple shipments are not allowed in B2C orders except in cases where Increff OMS is doing splitting and routing of the orders.
When Increff is doing routing splitting for B2C orders, one location will have only one shipment.
Increff shipmentId is unique for every shipment. Client system should be able to consume Increff Shipment Id for uniqueness.

Request

{
    "orderCode": "H19304030001",
    "locationCode": "l123",
    "shipmentId": 120001,
    "packageSku": "sku123",
    "weight": 40,
    "dimensions": {
        "length": 12,
        "breadth": 6,
        "height": 8
    },
    "invoice": {
        "fromAddress": {
            "name": "sellerName",
            "line1": "address line 1",
            "line2": "address line 2",
            "line3": "address line 3",
            "city": "Bengaluru",
            "state": "Karnataka",
            "zip": "560076",
            "country": "INDIA",
            "email": "email.com",
            "phone": "9999999999"
        },
        "shippingAddress": {
            "name": "customerName",
            "line1": "address line 1",
            "line2": "address line 2",
            "line3": "address line 3",
            "city": "Bengaluru",
            "state": "Karnataka",
            "zip": "560076",
            "country": "INDIA",
            "email": "email.com",
            "phone": "9999999999"
        },
        "billingAddress": {
            "name": "customerName",
            "line1": "address line 1",
            "line2": "address line 2",
            "line3": "address line 3",
            "city": "Bengaluru",
            "state": "Karnataka",
            "zip": "560076",
            "country": "INDIA",
            "email": "email.com",
            "phone": "9999999999"
        },
        "orderTime": "2020-10-16T20:22:28.000+00:00",
        "channelName": "flipkart",
        "fromPartyName": "name1",
        "toPartyName": "name2",
        "fromTIN": "tin1",
        "toTIN": "tin2",
        "panNo": "123PV99",
        "invoiceItems": [
            {
                "actualSellingPricePerUnit": 6,
                "actualSellingPriceTotal": 12,
                "channelSkuCode": "sku1",
                "itemName": "item1",
                "quantity": 2,
                "taxRule": "GST",
                "hsnCode": "hsn1",
                "vendorSku": "vendorSku1",
                "mrp": 8,
                "brand": "brand1",
                "styleCode": "style1",
                "color": "white",
                "size": "size1",
                "category": "shirt",
                "imageUrl": "www.imageUrl.com/1234"
            }
        ]
    },
    "packboxDetailsList": [
        {
            "boxId": 1000001020,
            "length": 12,
            "breadth": 6,
            "height": 8,
            "weight": 13
        },
        {
            "boxId": 1000001021,
            "length": 12,
            "breadth": 6,
            "height": 8,
            "weight": 13
        }
    ],
    "shipmentItems": [
        {
            "channelSkuCode": "100000789701",
            "orderItemCode": "item123",
            "quantity": 7,
            "itemCodes": [],
            "externalSerialCodes": []
        },
        {
            "channelSkuCode": "100000789702",
            "orderItemCode": "item124",
            "quantity": 5,
            "itemCodes": [],
            "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
`shipmentId`	Long	Shipment id of Assure system	yes
`packageSku`	String	SKU of the package material used for packing	no
`weight`	Double	Weight of the package in grams	no
`dimensions`	Object	Dimensions of the packed shipment	no
`dimensions.length`	Double	Length of the packing box.	no
`dimensions.breadth`	Double	Breadth of the packing box.	no
`dimensions.height`	Double	Height of the packing box.	no
`invoice`	Object	Invoice details	yes
`invoice.fromAddress`	Object	Address of the Seller	no
`fromAddress.name`	String	Name of Seller	yes
`fromAddress.line1`	String	1st line of Seller’s address	yes
`fromAddress.line2`	String	2nd line of Seller’s address	no
`fromAddress.line3`	String	3rd line of Seller’s address	no
`fromAddress.city`	String	City of Seller	yes
`fromAddress.state`	String	State of Seller	yes
`fromAddress.zip`	String	ZIP/Pin code of Seller	yes
`fromAddress.country`	String	Country of Seller	yes
`fromAddress.email`	String	Email of Seller	yes
`fromAddress.phone`	String	Phone number of Seller	no
`invoice.shippingAddress`	Object	Shipping address of the customer	yes
`shippingAddress.name`	String	Name of customer	yes
`shippingAddress.line1`	String	1st line of customer’s address	yes
`shippingAddress.line2`	String	2nd line of customer’s address	no
`shippingAddress.line3`	String	3rd line of customer’s address	no
`shippingAddress.city`	String	City of customer	yes
`shippingAddress.state`	String	State of customer	yes
`shippingAddress.zip`	String	ZIP/Pin code of customer	yes
`shippingAddress.country`	String	Country of customer	yes
`shippingAddress.email`	String	Email of customer	yes
`shippingAddress.phone`	String	Phone number of customer	no
`invoice.billingAddress`	Object	Billing address of the customer	yes
`billingAddress.name`	String	Name of customer	yes
`billingAddress.line1`	String	1st line of customer’s address	yes
`billingAddress.line2`	String	2nd line of customer’s address	no
`billingAddress.line3`	String	3rd line of customer’s address	no
`billingAddress.city`	String	City of customer	yes
`billingAddress.state`	String	State of customer	yes
`billingAddress.zip`	String	ZIP/Pin code of customer	yes
`billingAddress.country`	String	Country of customer	yes
`billingAddress.email`	String	Email of customer	yes
`billingAddress.phone`	String	Phone number of customer	no
`invoice.orderTime`	Date	Time of the order	no
`invoice.channelName`	String	Name of the channel from which order was placed	no
`invoice.fromPartyName`	String	Name of the seller	no
`invoice.toPartyName`	String	Name of the buyer	no
`invoice.fromTIN`	String	Seller GSTIN	no
`invoice.toTIN`	String	Buyer GSTIN	no
`invoice.panNo`	String	Client’s PAN number	no
`invoice.invoiceItems`	Object [ ]	Invoice Items	no
`invoiceItems.actualSellingPricePerUnit`	Double	Selling price per unit including tax	no
`invoiceItems.actualSellingPriceTotal`	Double	Total selling price including tax	no
`invoiceItems.channelSkuCode`	String	SKU code of order item	no
`invoiceItems.itemName`	String	Name of the product	no
`invoiceItems.quantity`	Long	Quantity of the product	no
`invoiceItems.taxRule`	String	Tax Rule for the product	no
`invoiceItems.hsnCode`	String	HSN code for the product (Used for classifying the item as well as for tax calculation)	no
`invoiceItems.vendorSku`	String	Client SKU code	no
`invoiceItems.mrp`	Double	MRP of the product	no
`invoiceItems.brand`	String	Brand of the product	no
`invoiceItems.styleCode`	String	Style code of the product	no
`invoiceItems.color`	String	Color of the product	no
`invoiceItems.size`	String	Size of the product	no
`invoiceItems.category`	String	Category of the product	no
`invoiceItems.imageUrl`	String	Image URL of the product	no
`shipmentItems`	Object[]	List of items corresponding to shipment	yes
`shipmentItems.channelSkuCode`	String	SKU code of order item	yes
`shipmentItems.quantity`	Integer	Quantity of SKU in shipment	yes
`shipmentItems.orderItemCode`	String	This is provided by the channel to uniquely identify each order item.	yes
`shipmentItems.itemCodes`	String[ ]	These are the external item ids of the item	no
`shipmentItems.externalSerialCodes`	String[]	These are the external serial ids for the item	no

Response

{
  "shipmentCode": "ship1234",
  "shipmentItems": [
    {
      "channelSkuCode": "100000789701",
      "orderItemCode": "item123",
      "quantity": 7
    },
    {
      "channelSkuCode": "100000789702",
      "orderItemCode": "item124",
      "quantity": 5
    }
  ],
  "invoiceMetaData": {
    "key1": "value1",
    "key2": "value2"
  },
  "shippingLabelMetaData": {
    "key1": "value1",
    "key2": "value2"
  }
}

HttpStatus : 200

Increff Omni Standard APIs

Pack Order API deprecated.

Outbound | POST | {Client’s URL}

Summary

Description

Request

Response