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

When a customer adds the desired products in the cart page, Shopfront platforms can seemlessly call this API to fetch the information of Probable split of the order and Estimate delivery date of the products.
Shopfront platform needs to provide the Cart level information like Order item details (channelSKU , Qty and orderLineItemId ), Payment type and Destination address details (city, state, country, areaCode)
Shopfront will receive the probable split of the order from Increff OMS system as per the Splitting-Routing algorithm set at that point of time.
Shopfront will also receive the Estimate delivery date at sub-order level as what is received from Courier management systems (Like Clickpost or Shiprocket)

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",ee
    "areaCode": "indore-453"
  }
}

Field Name	Data Type	Meaning	Mandatory?

Field Name	Data Type	Meaning	Mandatory?
`cartId`	String	Unique Cart identifuer to Identify the cart. 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 Identifier for respective webshop channel created in Increff system	No
`order_items.channelSKU`	String	SKU identifier of the respective channel	Yes
`order_item.qty`	Integer	Quantity or Stock customer has added in cart	Yes
`order_items`.`orderLineItemId`	String	Line item identifier for each SKU line in the probable order	no
`isPriority`	Boolean	If the user has selected a priority delivery If is priority is changed, then Shopfront will need to send a new request with a new`cart_id`	No Default as false
`paymentType`	String	Payment type can be COD or NCOD	Yes
`destinationAddress`.`city`	String	City name of destination address	No
`destinationAddress.state`	String	State of destination address	No
`destinationAddress.country`	String	Country of destination address	No
`destinationAddress`.`areaCode`	String	Area code of destination address	Yes `areaCode` will be `zipCode` for domestic orders (India geography)

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?

Field Name	Data Type	Meaning	Mandatory?
`cartId`	String	Unique Cart identifuer to Identify the cart. Later we will also receive this in Order as a field.	Yes
`subOrder`	Object	Probable SubOrder details object	Yes
`subOrder`.`id`	Integer	unique identifier for probable sub order	Yes
`subOrder`.`location`	String	Assigned location for fulfilling probable sub order	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 level idenitifer	Yes
`subOrder`.`orderItems.qty`	Integer	Stock or Quantity for each item	Yes
`destinationAddress`.`city`	String	City name of destination address	No
`destinationAddress.state`	String	State of destination address	No
`destinationAddress.country`	String	Country of destination address	No
`destinationAddress`.`areaCode`	String	Area code of destination address	Yes `areaCode` will be `zipCode` for domestic orders (India geography)
`location_address`.`city`	String	City name of destination address	No
`location_address.state`	String	State of destination address	No
`location_address.country`	String	Country of destination address	No
`location_address`.`areaCode`	String	Area code of destination address	Yes `areaCode` will be `zipCode` for domestic orders (India geography)

HTTP status

200