Cart Split Shipment and Estimate Delivery Date API

Inbound | POST | /shipment/cart-split

Summary

This API can be used by Shopfront platforms like Shopfiy, Magento, WooCommerce or any custom website to retrieve information of probable order split and estimated delivery date of each shipment of order from Increff OMS system.

Description

Shopfront platforms can seemlessly call this API when

Request

{
  "cartId": "ABCDEFG-234234-s-3513-4",
  "cartTimer": 600 
  "channelId": "AYX",
  "order_items": [
    {
      "channelSKU": "ABCD",
      "qty": 2,
      "orderLineItemId": "25"
    },
    {
      "channelSKU": "ABCD1",
      "qty": 3,
      "orderLineItemId": "24"
    }
  ],
  "isPriority": false,
  "paymentType": "NCOD",
  "destinationAddress": {
    "city": "Indore",
    "state": "MP",
    "country": "India",
    "areaCode": "indore-453"
  }
}

Field Name	Data Type	Meaning	Mandatory?
`cartId`	String	Unique cart Id to Identify the cart value. Later we will also receive this in Order as a field.	yes
`cartTimer`	Integer	Cart timer value in seconds. We should be able to reserve the inventory till this time.	no
`channelId`	String	channel Id	no
`order_items.channelSKU`	String	channel Sku code	yes
`order_item.qty`	Integer	qty to be ordered	yes
`order_items`.`orderLineItemId`	String	order line item	no
`isPriority`	Boolean	if the user has selected is priority or not. if is priority is changed, then front end will sent a new request with a new cart id	no, default as false
`paymentType`	String	payment type as COD/NCOD	Yes
`destinationAddress`.`city`	String	city	no
`destinationAddress.state`	String	state	no
`destinationAddress.country`	String	country	no
`destinationAddress`.`areaCode`	String	areaCode	yes, `areaCode` = `zipCode` for now.

Response

{
  "cartId": "ABCDEFG-234234-s-3513-4",
  "subOrder": [
    {
      "id": 1,
      "location": "fulfilment-location-code",
      "location_address": {
        "city": "Indore",
        "state": "MP",
        "country": "India",
        "areaCode": "indore-453"
      },
      "destinationAddress": {
        "city": "Indore",
        "state": "MP",
        "country": "India",
        "areaCode": "indore-453"
      },
      "maxExpectedDeliveryDate": "2024-07-12T06:34:43",
      "minExpectedDeliveryDate": "2024-07-10T06:34:43",
      "orderItems": [
        {
          "channelSKU": "ABCD1",
          "qty": 1
        },
        {
          "channelSKU": "ABCD",
          "qty": 1
        }
      ]
    },
    {
      "id": 2,
      "location": "fulfilment-location-cod",
      "location_address": {
        "city": "Indore",
        "state": "MP",
        "country": "India",
        "areaCode": "indore-453"
      },
      "destinationAddress": {
        "city": "Indore",
        "state": "MP",
        "country": "India",
        "areaCode": "indore-453"
      },
      "maxExpectedDeliveryDate": "2024-07-12T06:34:43",
      "minExpectedDeliveryDate": "2024-07-10T06:34:43",
      "orderItems": [
        {
          "channelSKU": "ABCD1",
          "qty": 2
        },
        {
          "channelSKU": "ABCD",
          "qty": 2
        }
      ]
    }
  ]
}

Field Name	Data Type	Meaning	Mandatory?
`cartId`	String	unique cart Id to Identify the cart value. Later we will also receive this in Order as a field.	yes
`subOrder`	Object	probable subOrder	yes
`subOrder`.`id`	Integer	unique Id	yes
`subOrder`.`location`	String	assigned location	yes
`subOrder`.`maxExpectedDeliveryDate`	ZoneDateTime	minimum expected delivery date from logistic partner	no
`subOrder`.`minExpectedDeliveryDate`	ZoneDateTime	maximum expected delivery date from logistic partner	no
`subOrder`.`orderItems.channelSKU`	String	item’s sku code	yes
`subOrder`.`orderItems.qty`	Integer	item’s qnty	yes
`destinationAddress`.`city`	String	city	no
`destinationAddress.state`	String	state	no
`destinationAddress.country`	String	country	no
`destinationAddress`.`areaCode`	String	areaCode	yes, `areaCode` = `zipCode` for now.
`location_address`.`city`	String	city	no
`location_address.state`	String	state	no
`location_address.country`	String	country	no
`location_address`.`areaCode`	String	areaCode	yes, `areaCode` = `zipCode` for now.

HTTP status