Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Outbound | PUT  | {Client’s URL}

Summary

Assure Increff can send an Order acknowledgement Acknowledgement when inventory is available in Assure 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 AssureIncreff 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:

  1. ALL : Inventory is allocated from Stores and Warehouses.

  2. STORE : Inventory is allocated from Store only

  3. NONE : Inventory is allocated from Warehouse only

Request

Code Block
languagejson
{
  "consolidationType": "STORE",
  "orders": [
    {
      "locationCode": "Wid234",
      "orderCode": "H19304030003Order-1"
    },
    {
      "locationCode": "Wid234",
      "orderCode": "H1930403003Order-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

consolidationType

String

Possible values:

ALL, STORE

yes

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

No

orderCode

String

Unique code used by channel to identify the order

yes

Consolidation type ALL

Payload contains orders from all locations including stores and warehouses.

Consolidation type Store

Payload contains orders from only store locations

Yes

Response

Code Block
languagejson
{
  "successOrders": [
    {
      "locationCode": "Wid234",
      "orderCode": "H19304030003Order-1"
    },
    {
      "locationCode": "Wid234",
      "orderCode": "H1930403003Order-2"
    }
  ]
}

HttpStatus : 200

Parameter Name

Data Type

Description

Mandatory

successOrders

Object[]

List of orders which were successfully updated on the channel

yes

Yes