Summary

This API will call the Shopfront system notifying that the order is packed in the warehouse/store.

Description

• This is a pack notification to the Shopfront 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.

<aside> 🗒️ Note :

1. Multiple shipments are allowed in case of B2B orders.
2. Multiple shipments are not allowed in B2C orders except in cases where Increff OMS is doing splitting and routing of the orders.
3. Single shipment can have multiple pack boxes.
4. When Increff is doing routing splitting for B2C orders, one location will have only one shipment.
5. Increff shipmentId is unique for every shipment. Client system should be able to consume Increff Shipment Id for uniqueness.
6. There should be idempotency handled at client’s end for the pack call of a single shipment, ie: if packing in OMS is not complete although the pack call is successful, on retry, the pack call will be re-triggered. In such cases, a success response is expected. </aside>

Request

{
	"orderCode": "H19304030001",
	"locationCode": "l123",
	"shipmentId": 120001,
	"packageSku": "sku123",
	"weight": 40,
	"fulfillmentType": "BLOCK_COMPLETE",
	"partnerCode": "partnerCode",
    "partnerLocationCode": "partnerLocationCode",
	"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.0,
			"actualSellingPriceTotal": 12.0,
			"channelSkuCode": "sku1",
			"itemName": "item1",
			"quantity": 2,
			"taxRule": "GST",
			"hsnCode": "hsn1",
			"vendorSku": "vendorSku1",
			"mrp": 15.0,
			"brand": "brand1",
			"styleCode": "style1",
			"color": "white",
			"size": "size1",
			"category": "shirt",
			"imageUrl": "www.imageUrl.com/1234"
		}]
	},
	"packboxDetailsList": [{
			"boxId": 1000001020,
			"boxCode": "1000001020",
			"length": 12.0,
			"breadth": 6.0,
			"height": 8.0,
			"weight": 13.2,
			"volWeight": 235.5,
			"boxSkuId": "bsku_1",
			"skuQuantityDataList": [{
			    "globalSkuId": 1000004230,
			    "clientSkuId": "clientSku",
			    "count": 1
			}]
		},
		{
			"boxId": 1000001021,
			"boxCode": "1000001021",
			"length": 12,
			"breadth": 6,
			"height": 8,
			"weight": 13,
			"volWeight": 285.5,
			"boxSkuId": "bsku_2",
			"skuQuantityDataList": [{
			    "globalSkuId": 1000004230,
			    "clientSkuId": "clientSku",
			    "count": 1
			}]
		}
	],
	"shipmentItems": [{
			"channelSkuCode": "100000789701",
			"orderItemCode": "item123",
			"quantity": 7,
			"itemCodes": [
				"it1", "it2"
			],
			"externalSerialCodes": [
				"ser1", "ser2"
			],
			"skuDimension": {
				"length": 12,
				"breadth": 6,
				"height": 8,
				"weight": 13
			},
			"orderItemCustomAttributes": {
				"attribute1": "Value1",
				"attribute2": "Value2",
				"attribute3": "Value3",
				"attribute4": "Value4",
				"attribute5": "Value5",
				"attribute6": "Value6",
				"attribute7": "Value7",
				"attribute8": "Value8",
				"attribute9": "Value9",
				"attribute10": "Value10",
				"channelMetadata": {
					"totalCashOnDeliveryFee": 0.0,
					"department": "HR",
					"paymentMethod": "ccavenue",
					"status": "processing"
                }
			}
		},
		{
			"channelSkuCode": "100000789702",
			"orderItemCode": "item124",
			"quantity": 5,
			"itemCodes": [
				"it3", "it4"
			],
			"externalSerialCodes": [
				"ser3", "ser4"
			],
			"skuDimension": {
				"length": 12,
				"breadth": 6,
				"height": 8,
				"weight": 13
			},
			"orderItemCustomAttributes": {
				"attribute1": "Value12",
				"attribute2": "Value22",
				"attribute3": "Value32",
				"attribute4": "Value42",
				"attribute5": "Value52",
				"attribute6": "Value62",
				"attribute7": "Value72",
				"attribute8": "Value82",
				"attribute9": "Value92",
				"attribute10": "Value102",
                "channelMetadata": {
					"totalCashOnDeliveryFee": 0.0,
					"department": "HR",
					"paymentMethod": "ccavenue",
					"status": "processing"
                }
			}
		}
	],
	"orderCustomAttributes": {
		"attribute1": "Value1",
		"attribute2": "Value2",
		"attribute3": "Value3",
		"attribute4": "Value4",
		"attribute5": "Value5",
		"attribute6": "Value6",
		"attribute7": "Value7",
		"attribute8": "Value8",
		"attribute9": "Value9",
		"attribute10": "Value10",
		"channelMetadata": {
			"totalCashOnDeliveryFee": 0.0,
			"department": "HR",
			"paymentMethod": "ccavenue",
			"status": "processing"
        },
		"currency": "INR"
	}
}

Response

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

HttpStatus : 200

| --- | --- | --- | --- |