Acknowledgement API

Outbound | PUT | {Client’s URL}

Summary

Increff can send an Order Acknowledgement when inventory is available and it is allocated to the order

Description

This API will send list of orders and Fulfilment Location Codes that are in fulfillable state in Increff Omni System to External System.

Below Consolidation Type will also be sent to External system which will specify that the inventory allocated to the order was from which type of location.

Consolidation Types:

ALL : Inventory is allocated from Stores and Warehouses.
STORE : Inventory is allocated from Store only
NONE : Inventory is allocated from Warehouse only

Request

{
  "orders": [
    {
      "locationCode": "Wid234",
      "orderCode": "Order-1"
    },
    {
      "locationCode": "Wid234",
      "orderCode": "Order-2"
    }
  ],
  "consolidationType": "STORE"
}

Parameter Name	Data Type	Description	Mandatory
`consolidationType`	String	Enum with possible values `ALL,STORE,NONE;`	No
`orders`	object[]	List of orders	Yes
`locationCode`	String	Location code of warehouse from where this order will get fulfilled(in case of consolidation type ALL, there will be no location code sent)	No
`orderCode`	String	Unique code used by channel to identify the order	Yes

Response

{
  "successOrders": [
    {
      "locationCode": "Wid234",
      "orderCode": "Order-1"
    },
    {
      "locationCode": "Wid234",
      "orderCode": "Order-2"
    }
  ]
}

HttpStatus : 200

Parameter Name	Data Type	Description	Mandatory
`successOrders`	`Object[]`	List of orders which were successfully updated on the channel	Yes