Inbound | POST | /shipment/cart-split-edd

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 (channelSkuCode , quantity 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 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",
  "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](<https://docs.increff.com/Cart-Split-Shipment-API-New-API-Beta-1ddf31dc4968816aa2fefec28cb7c487>)"
  }
}

Note: Relevant for future implementation of API at cart level | No | | 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.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 newcart_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.zipCode | String | Area code of destination address | Yes |

Response

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

Note: Relevant for future implementation of API at cart level | No (Optional) | | subOrder | Object | Probable Sub Order details JSON object | Yes | | subOrder.id | Integer | Unique identifier for probable sub order | Yes | | subOrder.locationAddress | 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.channelSkuCode | String | Item level idenitifer | Yes | | subOrder.orderItems.quantity | 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.zipCode | String | Area code of destination address | Yes | | 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.quantity | String | Area code of destination address | Yes |

HTTP status

200