Page Comparison

...

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 when 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

Code Block

language	json

{
  "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

Cart identifuer to Identify the cart

value

.
Later we will also receive this in Order as a field.

yes

Yes

cartTimer

Integer

Cart timer value in seconds.

We should be able to reserve the inventory till this time.

nono

No
`channelId`	String

channel Id

Channel Identifier for respective webshop channel created in Increff system	No
`order_items.channelSKU`	String	SKU identifier of the respective channel

Sku code

yesyes

Yes
`order_item.qty`	Integer

qty to be ordered

Quantity or Stock customer has added in cart	Yes
`order_items`.`orderLineItemId`	String

order line item

Line item identifier for each SKU line in the probable order	no
`isPriority`	Boolean

if

If the user has selected

is

a priority

or not.

delivery

if

If is priority is changed, then

front end will sent

Shopfront will need to send a new request with a newcart_id

no, default

No

Default as false

paymentType

String

payment

Payment type

as

can be COD

/no

or NCOD	Yes
`destinationAddress`.`city`	String

city

no

City name of destination address	No
`destinationAddress.state`	String

state

no

State of destination address	No
`destinationAddress.country`	String

country

yes,

Country of destination address	No
`destinationAddress`.`areaCode`	String

areaCode

Area code of destination address

Yes

areaCode

=

will be zipCode for

now.

domestic orders (India geography)

Response

Code Block

language	json

{
  "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`	Stringunique cart Id	Unique Cart identifuer to Identify the cart value . Later we will also receive this in Order as a field.	yesYes
`subOrder`	Object	probable subOrder	yesProbable SubOrder details object	Yes
`subOrder`.`id`	Integer	unique Id yesidentifier for probable sub order	Yes
`subOrder`.`location`	String	assigned Assigned location for fulfilling probable sub order	yesYes
`subOrder`.`maxExpectedDeliveryDate`	ZoneDateTime	minimum Minimum expected delivery date from logistic partner	noNo
`subOrder`.`minExpectedDeliveryDate`	ZoneDateTime	maximum Maximum expected delivery date from logistic partner	noNo
`subOrder`.`orderItems.channelSKU`	String	item’s sku code	yesItem level idenitifer	Yes
`subOrder`.`orderItems.qty`	Integer	item’s qnty	yesStock or Quantity for each item	Yes
`destinationAddress`.`city`	String	city	noCity name of destination address	No
`destinationAddress.state`	String	state	noState of destination address	No
`destinationAddress.country`	String	country	noCountry of destination address	No
`destinationAddress`.`areaCode`	String	areaCode	yes, Area code of destination address	Yes `areaCode` = will be `zipCode` for now. domestic orders (India geography)
`location_address`.`city`	String	city	noCity name of destination address	No
`location_address.state`	String	state	noState of destination address	No
`location_address.country`	String	country	noCountry of destination address	No
`location_address`.`areaCode`	String	areaCode	yes, Area code of destination address	Yes `areaCode` = will be `zipCode` for now. domestic orders (India geography)

HTTP status

Code Block
200

...

Versions Compared

Old Version 1

New Version Current

Key

Description

Request

Response