Versions Compared

Key

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

Inbound | PUT  | /usp/inventories/absolute

Summary

This API will be called by any External WMS to update the absolute inventory available in WMS for the Products listed in Increff OMS.

Description

  1. This API will always expect to send the inventory available for sale in external WMS system to Increff OMS system so that the inventory can be exposed to External integrated channels like Marketplaces, Webshops ERP systems etc.

  2. The inventory quantity will always be absolute in nature.

Infowarning

Note: One batch can contain maximum of 500 300 SKUs.

Request

Code Block
languagejson
{
    "locationCode": "wd003",
    "products": [
        {
            "quantity": 40,
            "channelSkuCode":"ITEM302",
        }
    ]
}

 

Parameter Name

Data Type

Description

Mandatory

locationCode

String

Location from which inventory is being pushed

Identifier for the location for which inventory will be synced to channel.

Yes

products

Object[]

List of products for which inventory needs to be updated

Yes

products.channelskuCode

String

Scannable barcode on the product

Yes

products.quantity

int

Aboluste Quantity of inventory available for the product in

eWMS

external WMS.

Yes

Response

Code Block
languagejson
{
  "failureProducts": [],
  "successProducts": [
    "302"
  ]
}

 

HttpStatus : 200

 

Parameter Name

Data Type

Description

failureProducts

String[]

List of channelSkuCode for which inventory update was not successful

successProducts

String[]

List of channelSkuCode for which inventory update was successful 

Expand
titleUpdate Inventory Absolute V0 API Payload (To be deprecated now)

Request

Code Block
languagejson
[
  {
    "clientId": 10000900,
    "clientSkuId": "SKU1",
    "inventoryPoolId": 0,
    "quantity": 10,
    "fulfillmentLocationId": 1000901
  }
]

Parameter Name

Data Type

Description

Mandatory

clientId

Int

ClientId in Assure System

Yes

clientSkuId

String

Scannable code present on physical product that identifies an SKU uniquely

Yes

inventoryPoolId

Int

Multiple inventoryPools can be mainted in Assure. If poolId is provided, update will be done against the specific pool otherwise for the common pool

no

quantity

Int

Absolute saleable quantity

Yes

fulfillmentLocationId

Int

Assure FulfillmentLocationId

yes

Response

Code Block
languagejson
{
  "failureSkus": [
    "SKU1"
  ],
  "successSkus": [
    "SKU2"
  ]
}

HttpStatus : 200

Parameter Name

Data Type

Description

Mandatory

failureSkus

String[]

clientSkus for which inventory update failed

no

successSkus

String[]

clientSkus for which inventory update was successful

no

Expand
titleUpdate Inventory Incremental V0 API Payload (To be deprecated now)

Request

Code Block
[

  {

    "clientId": 10000900,

    "clientSkuId": "SKU1",

    "inventoryPoolId": 0,

    "quantity": 10,

    "fulfillmentLocationId": 1000901

  }

]

Parameter Name

Data Type

Description

Mandatory

clientId

Int

ClientId in Assure System

Yes

clientSkuId

String

Scannable code present on physical product that identifies an SKU uniquely

Yes

inventoryPoolId

Int

Multiple inventoryPools can be mainted in Assure. If poolId is provided, update will be done against the specific pool otherwise for the common pool

no

quantity

Int

Absolute saleable quantity

Yes

fulfillmentLocationId

Int

Assure FulfillmentLocationId

yes

Response

Code Block
languagejson
{
  "failureSkus": [
    "SKU1"
  ],

  "successSkus": [
    "SKU2"
  ]

}

HttpStatus : 200

Parameter Name

Data Type

Description

Mandatory

failureSkus

String[]

clientSkus for which inventory update failed

no

successSkus

String[]

clientSkus for which inventory update was successful

no