Inbound | GET | /orders/inward/strategies/{locationCode}

Summary

This API is used to get the inward orders distribution strategies configured in Increff OMS.

Description

This API will get inward orders distribution strategies configured in Increff OMS.

External system can pass a locationCode for the warehouse/store location in the URL and it will get a list of order distribution strategy data in reponse of API.

Request

EmptyBody

Response

[
  {
    "clientId": 98765,
    "locationCode": "BLR_WH1",
    "channelId": "ONLINE",
    "name": "Default Distribution Strategy",
    "distributionList": [
      {
        "poolId": 101,
        "percentage": 40,
        "poolName": "Primary Warehouse"
      },
      {
        "poolId": 102,
        "percentage": 35,
        "poolName": "Secondary Warehouse"
      }
    ]
  },
  {
    "clientId": 12345,
    "locationCode": "MUM_WH2",
    "channelId": "OFFLINE",
    "name": "Regional Distribution Strategy",
    "distributionList": [
      {
        "poolId": 201,
        "percentage": 50,
        "poolName": "Main Storage"
      },
      {
        "poolId": 202,
        "percentage": 30,
        "poolName": "Backup Storage"
      }
    ]
  }
]
Parameter Name Data Type Description
clientId Long Unique identifier for the client.
locationCode String Code representing the location.
channelId String Identifier for the channel
name String Name of the distribution strategy.
distributionList Array List of distribution strategy details.
distributionList.poolId Long Unique identifier for the distribution pool.
distributionList.percentage Integer Allocation percentage for the pool.
distributionList.poolName String Name of the distribution pool.

Http Status Code

200