PUT
/
allocation
/
reallocate
curl --request PUT \
  --url https://prod01.oms.fabric.inc/api/v2/allocation/reallocate \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '{
  "orderNumber": "ship1233234555g",
  "channel": "ship1233234555g",
  "tenant": "ship1233234555g",
  "id": "98ff5c0bec0aed3c86202c32",
  "documentType": "ALLOCATION",
  "items": [
    {
      "lineItemId": "134fqfaa532qrf",
      "allocationLineNumber": 1,
      "quantity": 3
    }
  ]
}'
{
  "message": "Reallocation process completed Successfully with !! allocation Ids [6315dec507025b003f20ed3c]"
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Body

application/json
​
channel
string
required

Channel

Example:

"ship1233234555g"

​
tenant
string
required

Tenant ID

Example:

"ship1233234555g"

​
id
string[]
required

Unique ID of the document

Unique ID of the document

Example:

"98ff5c0bec0aed3c86202c32"

​
documentType
enum<string>
required

Document type

Available options:
ALLOCATION,
ORDER,
SHIPMENT,
ALLOCATION ORDER
​
orderNumber
string

Id of the given document

Example:

"ship1233234555g"

​
items
object[]

Optional item list needs to be allocated

Optional item List needs to be allocated

Response

200
application/json
Location reallocated

The response is of type string.

Was this page helpful?