Cart Split Shipment API (Beta)

Inbound | POST | /shipment/cart-split

Summary

This API can be used by Shopfront platforms or External system (Logistics management system, ERP, External fulfillment systems) to retrieve information of probable order split from Increff OMS system.

Description

When a customer adds the desired products in the cart page, Shopfront platforms can seamlessly call this API to fetch the information of Probable split of the order.
Shopfront platform needs to provide the Cart level information like Order item details (channelSkuCode , Qty and orderLineItemId ), Payment type and Destination address details (city, state, country, zipCode)
Shopfront will receive the probable split of the order from Increff OMS system as per the Splitting-Routing algorithm configured at that point of time.

Request

{
  "cartId": "ABCDEFG-234234-s-3513-4",
  "cartTimer": 600,
  "channelId": "AYX",
  "orderItems": [
    {
      "channelSkuCode": "ABCD",
      "quantity": 2,
      "orderLineItemId": "25"
    },
    {
      "channelSkuCode": "ABCD1",
      "quantity": 3,
      "orderLineItemId": "24"
    }
  ],
  "isPriority": false,
  "paymentType": "NCOD",
  "destinationAddress": {
    "city": "Indore",
    "state": "MP",
    "country": "India",
    "zipCode": "indore-453",
    "longitude": 75.8577,
    "latitude": 22.7196,
    "openLocationCode": "7JMJ2GCH+QV"
  }
}

Field Name	Data Type	Meaning	Mandatory?
`cartId`	String	Unique Cart identifier to Identify the cart. Later we will also receive this in Order as a field. Note: Relevant for future implementation of API at cart level	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
`orderItems`	Object[]	List of order items in the cart	Yes
`orderItems.channelSkuCode`	String	SKU identifier of the respective channel	Yes
`orderItems.quantity`	Integer	Quantity or Stock customer has added in cart	Yes
`orderItems.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 `cartId`. Default as false	No
`paymentType`	String	Payment type can be COD or NCOD	Yes
`destinationAddress`	Object	Destination address details	No
`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.zipCode`	String	Area code of destination address	Yes
`destinationAddress.longitude`	Double	Longitude of the destination address	No
`destinationAddress.latitude`	Double	Latitude of the destination address	No
`destinationAddress.openLocationCode`	String	Open Location Code (Plus Code) of the destination address	No

Response

{
  "cartId": "ABCDEFG-234234-s-3513-4",
  "subOrder": [
    {
      "id": 1,
      "location": "fulfilment-location-code",
      "locationAddress": {
        "city": "Indore",
        "state": "MP",
        "country": "India",
        "zipCode": "indore-453",
        "longitude": 75.8577,
        "latitude": 22.7196,
        "openLocationCode": "7JMJ2GCH+QV"
      },
      "destinationAddress": {
        "city": "Indore",
        "state": "MP",
        "country": "India",
        "zipCode": "indore-453",
        "longitude": 75.8577,
        "latitude": 22.7196,
        "openLocationCode": "7JMJ2GCH+QV"
      },
      "maxExpectedDeliveryDate": null,
      "minExpectedDeliveryDate": null,
      "orderItems": [
        {
          "channelSkuCode": "ABCD1",
          "quantity": 1
        },
        {
          "channelSkuCode": "ABCD",
          "quantity": 1
        }
      ]
    },
    {
      "id": 2,
      "location": "fulfilment-location-code",
      "locationAddress": {
        "city": "Indore",
        "state": "MP",
        "country": "India",
        "zipCode": "indore-453",
        "longitude": 75.8577,
        "latitude": 22.7196,
        "openLocationCode": "7JMJ2GCH+QV"
      },
      "destinationAddress": {
        "city": "Indore",
        "state": "MP",
        "country": "India",
        "zipCode": "indore-453",
        "longitude": 75.8577,
        "latitude": 22.7196,
        "openLocationCode": "7JMJ2GCH+QV"
      },
      "maxExpectedDeliveryDate": null,
      "minExpectedDeliveryDate": null,
      "orderItems": [
        {
          "channelSkuCode": "ABCD1",
          "quantity": 2
        },
        {
          "channelSkuCode": "ABCD",
          "quantity": 2
        }
      ]
    }
  ]
}

HTTP status

Field Name	Data Type	Meaning	Mandatory?
`cartId`	String	Unique Cart identifier to Identify the cart. Note: Relevant for future implementation of API at cart level	No
`subOrder`	Object[]	Probable Sub Order details	Yes
`subOrder.id`	Long	Unique identifier for probable sub order	Yes
`subOrder.location`	String	Assigned location code for fulfilling probable sub order	Yes
`subOrder.locationAddress`	Object	Address of the assigned fulfilment location	Yes
`subOrder.locationAddress.city`	String	City name of location address	No
`subOrder.locationAddress.state`	String	State of location address	No
`subOrder.locationAddress.country`	String	Country of location address	No
`subOrder.locationAddress.zipCode`	String	Area code of location address	Yes
`subOrder.locationAddress.longitude`	Double	Longitude of the location address	No
`subOrder.locationAddress.latitude`	Double	Latitude of the location address	No
`subOrder.locationAddress.openLocationCode`	String	Open Location Code (Plus Code) of the location address	No
`subOrder.destinationAddress`	Object	Destination address for the sub order	Yes
`subOrder.destinationAddress.city`	String	City name of destination address	No
`subOrder.destinationAddress.state`	String	State of destination address	No
`subOrder.destinationAddress.country`	String	Country of destination address	No
`subOrder.destinationAddress.zipCode`	String	Area code of destination address	Yes
`subOrder.destinationAddress.longitude`	Double	Longitude of the destination address	No
`subOrder.destinationAddress.latitude`	Double	Latitude of the destination address	No
`subOrder.destinationAddress.openLocationCode`	String	Open Location Code (Plus Code) of the destination address	No
`subOrder.maxExpectedDeliveryDate`	ZonedDateTime	Maximum expected delivery date from logistic partner (will be null for this API since EDD is not requested)	No
`subOrder.minExpectedDeliveryDate`	ZonedDateTime	Minimum expected delivery date from logistic partner (will be null for this API since EDD is not requested)	No
`subOrder.orderItems`	Object[]	List of order items in the sub order	Yes
`subOrder.orderItems.channelSkuCode`	String	Item level identifier	Yes
`subOrder.orderItems.quantity`	Integer	Stock or Quantity for each item	Yes