Update allocation attributes

curl --request POST \
  --url https://api.fabric.inc/v3/allocations/{allocationId}/actions/update-attributes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-channel-id: <x-fabric-channel-id>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '
{
  "attributes": {
    "attr1": "value"
  },
  "keysToRemove": [
    "<string>"
  ]
}
'

import requests

url = "https://api.fabric.inc/v3/allocations/{allocationId}/actions/update-attributes"

payload = {
    "attributes": { "attr1": "value" },
    "keysToRemove": ["<string>"]
}
headers = {
    "x-fabric-tenant-id": "<x-fabric-tenant-id>",
    "x-fabric-channel-id": "<x-fabric-channel-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-fabric-tenant-id': '<x-fabric-tenant-id>',
    'x-fabric-channel-id': '<x-fabric-channel-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({attributes: {attr1: 'value'}, keysToRemove: ['<string>']})
};

fetch('https://api.fabric.inc/v3/allocations/{allocationId}/actions/update-attributes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fabric.inc/v3/allocations/{allocationId}/actions/update-attributes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'attributes' => [
        'attr1' => 'value'
    ],
    'keysToRemove' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-fabric-channel-id: <x-fabric-channel-id>",
    "x-fabric-tenant-id: <x-fabric-tenant-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fabric.inc/v3/allocations/{allocationId}/actions/update-attributes"

	payload := strings.NewReader("{\n  \"attributes\": {\n    \"attr1\": \"value\"\n  },\n  \"keysToRemove\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-fabric-tenant-id", "<x-fabric-tenant-id>")
	req.Header.Add("x-fabric-channel-id", "<x-fabric-channel-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.fabric.inc/v3/allocations/{allocationId}/actions/update-attributes")
  .header("x-fabric-tenant-id", "<x-fabric-tenant-id>")
  .header("x-fabric-channel-id", "<x-fabric-channel-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"attributes\": {\n    \"attr1\": \"value\"\n  },\n  \"keysToRemove\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fabric.inc/v3/allocations/{allocationId}/actions/update-attributes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-fabric-tenant-id"] = '<x-fabric-tenant-id>'
request["x-fabric-channel-id"] = '<x-fabric-channel-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"attributes\": {\n    \"attr1\": \"value\"\n  },\n  \"keysToRemove\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "allocationId": "62ff5c0bec0aed3c86202c32",
  "allocationRequestId": "62ff5c0bec0aed3c86202c32",
  "createdAt": "2022-08-01T18:03:28.483971941Z",
  "locationNumber": "1234B",
  "version": 2,
  "allocationNumber": 13000004,
  "allocationExternalId": "123k4h123k",
  "auditLogs": [
    {
      "amount": 2.4,
      "auditId": "a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111",
      "auditType": "CANCEL",
      "auditedAt": "2023-03-12T09:24:54.804Z",
      "employeeId": "6227",
      "isSuccess": true,
      "lineItemId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
      "lineItemNumber": 1,
      "note": "Note",
      "paymentToken": {
        "paymentType": "VISA",
        "token": "pi_34tr6787rt"
      },
      "policyCode": "POS",
      "quantity": 1,
      "reasonCode": "Scratched item",
      "sku": "SKU0023",
      "source": "POS",
      "subReasonCode": "Scratched item",
      "updatedFields": [
        {
          "fieldName": "UOM",
          "fieldOriginalValue": "PK"
        }
      ]
    }
  ],
  "currency": "USD",
  "decisionContexts": [
    {
      "allocatedOrderLineIds": [
        "<string>"
      ],
      "methodConfigs": {},
      "methodName": "<string>",
      "ruleName": "<string>",
      "ruleSetId": "<string>",
      "ruleSetVersion": "<string>"
    }
  ],
  "items": [
    {
      "allocationLineNumber": 3,
      "itemId": 100064,
      "quantity": 3,
      "sku": "123k4h123k",
      "uom": "EA",
      "channelId": "4a35cc1b-4e15-46df-96c9-38a697d88dfe",
      "cost": 150.6,
      "estimatedDeliveryDate": "2022-08-01T18:03:28.483971941Z",
      "itemStatus": "PARTIALLY_ALLOCATED",
      "notes": [
        {
          "createdAt": "2022-05-12T09:30:31.198Z",
          "notes": "Fragile - handle with care",
          "user": "62272e917b12209e68751d94"
        }
      ],
      "orderId": "62f3982438bcab1951be0a19",
      "orderLineId": "134fqfaa532qrf",
      "orderLineNumber": 1,
      "orderNumber": "123k4h123k",
      "orderExternalId": "123k4h123k",
      "orderedAt": "2022-08-01T18:03:28.483971941Z",
      "parentAllocationLineNumber": 3,
      "price": 50.2,
      "reallocationReasonCode": "Reallocating due to unavailability of location number",
      "reallocationRequestId": "123k4h123k",
      "reshipReasonCode": "Stock refilled",
      "scratchQuantity": 1,
      "scratchedReasonCode": "Out of stock",
      "shippedQuantity": 1,
      "weight": 5.5
    }
  ],
  "itemsType": "WEB_SHIP",
  "locationType": "DC",
  "notifiedToPPSAt": "2022-08-01T18:03:28.483971941Z",
  "orderSubType": "ANDROID",
  "parentAllocationId": "62ff5c0bec0aed3c86202c32",
  "previousAllocatedLocationNums": [
    "410"
  ],
  "recipients": [
    {
      "email": "test@example.com",
      "name": {
        "firstName": "Alex",
        "lastName": "Doe",
        "middleName": "E"
      },
      "phone": {
        "number": "123-456-7890",
        "type": "MOBILE"
      },
      "pickupType": "PRIMARY"
    }
  ],
  "shipToAddress": {
    "addressLine1": "123 Main St.",
    "city": "Seattle",
    "countryCode": "US",
    "latitude": 47.6205,
    "longitude": -122.3493,
    "postalCode": "98121",
    "region": "WA",
    "type": "Home",
    "addressLine2": "Suite 100",
    "addressLine3": "Seventh floor",
    "addressLine4": "Attention: Pat E. Kake",
    "email": "test@example.com",
    "name": {
      "firstName": "Alex",
      "lastName": "Doe",
      "middleName": "E"
    },
    "phone": {
      "number": "123-456-7890",
      "type": "MOBILE"
    }
  },
  "shipFromAddress": {
    "addressLine1": "123 Main St.",
    "city": "Seattle",
    "countryCode": "US",
    "latitude": 47.6205,
    "longitude": -122.3493,
    "postalCode": "98121",
    "region": "WA",
    "type": "Home",
    "addressLine2": "Suite 100",
    "addressLine3": "Seventh floor",
    "addressLine4": "Attention: Pat E. Kake",
    "email": "test@example.com",
    "name": {
      "firstName": "Alex",
      "lastName": "Doe",
      "middleName": "E"
    },
    "phone": {
      "number": "123-456-7890",
      "type": "MOBILE"
    }
  },
  "shipToId": "98ff5c0bec0aed3c86202c32",
  "shipmentMethod": "Parcel Post Delivery",
  "shipmentType": "SHIP_TO_ADDRESS",
  "shippedAt": "2022-08-01T20:03:28.483971941Z",
  "statusCode": "ALLOCATED",
  "type": "ALLOCATED",
  "updatedAt": "2022-08-01T20:03:28.483971941Z"
}

{
  "type": "CLIENT_ERROR",
  "errorCode": "SERVICE-4003",
  "message": "Mandatory or invalid request parameters",
  "errors": [
    {
      "type": "CLIENT_ERROR",
      "errorCode": "SERVICE-4002",
      "message": "Invalid value specified for one or more attributes",
      "errors": []
    }
  ],
  "context": {
    "service": "allocations",
    "endpoint": "POST /v3/allocations/{allocationId}/actions/update-attributes"
  }
}

{
  "type": "CLIENT_ERROR",
  "errorCode": "SERVICE-4001",
  "message": "Unauthorized request",
  "errors": [],
  "context": {
    "service": "allocations",
    "endpoint": "POST /v3/allocations/{allocationId}/actions/update-attributes"
  }
}

{
  "type": "CLIENT_ERROR",
  "message": "Allocation not found",
  "errorCode": "SERVICE-4040",
  "errors": [],
  "context": {
    "service": "allocations",
    "endpoint": "POST /v3/allocations/{allocationId}/actions/update-attributes"
  }
}

{
  "type": "SERVER_ERROR",
  "errorCode": "SERVICE-5000",
  "message": "Internal server error",
  "errors": [],
  "context": {
    "service": "allocations",
    "endpoint": "POST /v3/allocations/{allocationId}/actions/update-attributes"
  }
}

POST

allocations

{allocationId}

actions

update-attributes

Update allocation attributes

curl --request POST \
  --url https://api.fabric.inc/v3/allocations/{allocationId}/actions/update-attributes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-fabric-channel-id: <x-fabric-channel-id>' \
  --header 'x-fabric-tenant-id: <x-fabric-tenant-id>' \
  --data '
{
  "attributes": {
    "attr1": "value"
  },
  "keysToRemove": [
    "<string>"
  ]
}
'

import requests

url = "https://api.fabric.inc/v3/allocations/{allocationId}/actions/update-attributes"

payload = {
    "attributes": { "attr1": "value" },
    "keysToRemove": ["<string>"]
}
headers = {
    "x-fabric-tenant-id": "<x-fabric-tenant-id>",
    "x-fabric-channel-id": "<x-fabric-channel-id>",
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {
    'x-fabric-tenant-id': '<x-fabric-tenant-id>',
    'x-fabric-channel-id': '<x-fabric-channel-id>',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({attributes: {attr1: 'value'}, keysToRemove: ['<string>']})
};

fetch('https://api.fabric.inc/v3/allocations/{allocationId}/actions/update-attributes', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fabric.inc/v3/allocations/{allocationId}/actions/update-attributes",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'attributes' => [
        'attr1' => 'value'
    ],
    'keysToRemove' => [
        '<string>'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "x-fabric-channel-id: <x-fabric-channel-id>",
    "x-fabric-tenant-id: <x-fabric-tenant-id>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fabric.inc/v3/allocations/{allocationId}/actions/update-attributes"

	payload := strings.NewReader("{\n  \"attributes\": {\n    \"attr1\": \"value\"\n  },\n  \"keysToRemove\": [\n    \"<string>\"\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-fabric-tenant-id", "<x-fabric-tenant-id>")
	req.Header.Add("x-fabric-channel-id", "<x-fabric-channel-id>")
	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.fabric.inc/v3/allocations/{allocationId}/actions/update-attributes")
  .header("x-fabric-tenant-id", "<x-fabric-tenant-id>")
  .header("x-fabric-channel-id", "<x-fabric-channel-id>")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"attributes\": {\n    \"attr1\": \"value\"\n  },\n  \"keysToRemove\": [\n    \"<string>\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.fabric.inc/v3/allocations/{allocationId}/actions/update-attributes")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-fabric-tenant-id"] = '<x-fabric-tenant-id>'
request["x-fabric-channel-id"] = '<x-fabric-channel-id>'
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"attributes\": {\n    \"attr1\": \"value\"\n  },\n  \"keysToRemove\": [\n    \"<string>\"\n  ]\n}"

response = http.request(request)
puts response.read_body

{
  "allocationId": "62ff5c0bec0aed3c86202c32",
  "allocationRequestId": "62ff5c0bec0aed3c86202c32",
  "createdAt": "2022-08-01T18:03:28.483971941Z",
  "locationNumber": "1234B",
  "version": 2,
  "allocationNumber": 13000004,
  "allocationExternalId": "123k4h123k",
  "auditLogs": [
    {
      "amount": 2.4,
      "auditId": "a05b72dc-78d8-4ea4-90fc-2fe6a1fe1111",
      "auditType": "CANCEL",
      "auditedAt": "2023-03-12T09:24:54.804Z",
      "employeeId": "6227",
      "isSuccess": true,
      "lineItemId": "b03b72dc-78d8-4ea4-90fc-2fe6a1fe6569",
      "lineItemNumber": 1,
      "note": "Note",
      "paymentToken": {
        "paymentType": "VISA",
        "token": "pi_34tr6787rt"
      },
      "policyCode": "POS",
      "quantity": 1,
      "reasonCode": "Scratched item",
      "sku": "SKU0023",
      "source": "POS",
      "subReasonCode": "Scratched item",
      "updatedFields": [
        {
          "fieldName": "UOM",
          "fieldOriginalValue": "PK"
        }
      ]
    }
  ],
  "currency": "USD",
  "decisionContexts": [
    {
      "allocatedOrderLineIds": [
        "<string>"
      ],
      "methodConfigs": {},
      "methodName": "<string>",
      "ruleName": "<string>",
      "ruleSetId": "<string>",
      "ruleSetVersion": "<string>"
    }
  ],
  "items": [
    {
      "allocationLineNumber": 3,
      "itemId": 100064,
      "quantity": 3,
      "sku": "123k4h123k",
      "uom": "EA",
      "channelId": "4a35cc1b-4e15-46df-96c9-38a697d88dfe",
      "cost": 150.6,
      "estimatedDeliveryDate": "2022-08-01T18:03:28.483971941Z",
      "itemStatus": "PARTIALLY_ALLOCATED",
      "notes": [
        {
          "createdAt": "2022-05-12T09:30:31.198Z",
          "notes": "Fragile - handle with care",
          "user": "62272e917b12209e68751d94"
        }
      ],
      "orderId": "62f3982438bcab1951be0a19",
      "orderLineId": "134fqfaa532qrf",
      "orderLineNumber": 1,
      "orderNumber": "123k4h123k",
      "orderExternalId": "123k4h123k",
      "orderedAt": "2022-08-01T18:03:28.483971941Z",
      "parentAllocationLineNumber": 3,
      "price": 50.2,
      "reallocationReasonCode": "Reallocating due to unavailability of location number",
      "reallocationRequestId": "123k4h123k",
      "reshipReasonCode": "Stock refilled",
      "scratchQuantity": 1,
      "scratchedReasonCode": "Out of stock",
      "shippedQuantity": 1,
      "weight": 5.5
    }
  ],
  "itemsType": "WEB_SHIP",
  "locationType": "DC",
  "notifiedToPPSAt": "2022-08-01T18:03:28.483971941Z",
  "orderSubType": "ANDROID",
  "parentAllocationId": "62ff5c0bec0aed3c86202c32",
  "previousAllocatedLocationNums": [
    "410"
  ],
  "recipients": [
    {
      "email": "test@example.com",
      "name": {
        "firstName": "Alex",
        "lastName": "Doe",
        "middleName": "E"
      },
      "phone": {
        "number": "123-456-7890",
        "type": "MOBILE"
      },
      "pickupType": "PRIMARY"
    }
  ],
  "shipToAddress": {
    "addressLine1": "123 Main St.",
    "city": "Seattle",
    "countryCode": "US",
    "latitude": 47.6205,
    "longitude": -122.3493,
    "postalCode": "98121",
    "region": "WA",
    "type": "Home",
    "addressLine2": "Suite 100",
    "addressLine3": "Seventh floor",
    "addressLine4": "Attention: Pat E. Kake",
    "email": "test@example.com",
    "name": {
      "firstName": "Alex",
      "lastName": "Doe",
      "middleName": "E"
    },
    "phone": {
      "number": "123-456-7890",
      "type": "MOBILE"
    }
  },
  "shipFromAddress": {
    "addressLine1": "123 Main St.",
    "city": "Seattle",
    "countryCode": "US",
    "latitude": 47.6205,
    "longitude": -122.3493,
    "postalCode": "98121",
    "region": "WA",
    "type": "Home",
    "addressLine2": "Suite 100",
    "addressLine3": "Seventh floor",
    "addressLine4": "Attention: Pat E. Kake",
    "email": "test@example.com",
    "name": {
      "firstName": "Alex",
      "lastName": "Doe",
      "middleName": "E"
    },
    "phone": {
      "number": "123-456-7890",
      "type": "MOBILE"
    }
  },
  "shipToId": "98ff5c0bec0aed3c86202c32",
  "shipmentMethod": "Parcel Post Delivery",
  "shipmentType": "SHIP_TO_ADDRESS",
  "shippedAt": "2022-08-01T20:03:28.483971941Z",
  "statusCode": "ALLOCATED",
  "type": "ALLOCATED",
  "updatedAt": "2022-08-01T20:03:28.483971941Z"
}

{
  "type": "CLIENT_ERROR",
  "errorCode": "SERVICE-4003",
  "message": "Mandatory or invalid request parameters",
  "errors": [
    {
      "type": "CLIENT_ERROR",
      "errorCode": "SERVICE-4002",
      "message": "Invalid value specified for one or more attributes",
      "errors": []
    }
  ],
  "context": {
    "service": "allocations",
    "endpoint": "POST /v3/allocations/{allocationId}/actions/update-attributes"
  }
}

{
  "type": "CLIENT_ERROR",
  "errorCode": "SERVICE-4001",
  "message": "Unauthorized request",
  "errors": [],
  "context": {
    "service": "allocations",
    "endpoint": "POST /v3/allocations/{allocationId}/actions/update-attributes"
  }
}

{
  "type": "CLIENT_ERROR",
  "message": "Allocation not found",
  "errorCode": "SERVICE-4040",
  "errors": [],
  "context": {
    "service": "allocations",
    "endpoint": "POST /v3/allocations/{allocationId}/actions/update-attributes"
  }
}

{
  "type": "SERVER_ERROR",
  "errorCode": "SERVICE-5000",
  "message": "Internal server error",
  "errors": [],
  "context": {
    "service": "allocations",
    "endpoint": "POST /v3/allocations/{allocationId}/actions/update-attributes"
  }
}

Authorizations

Authorization

string

header

required

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

Headers

x-fabric-tenant-id

string

required

A header used by fabric to identify the tenant making the request. You must include tenant id in the authentication header for an API request to access any of fabric’s endpoints. You can retrieve the tenant id , which is also called account id, from Copilot. This header is required.

x-fabric-channel-id

string

required

x-fabric-channel-id identifies the sales channel where the API request is being made; primarily for multichannel use cases. The channel ids are 12 corresponding to US and 13 corresponding to Canada. The default channel id is 12. This field is required.

x-fabric-request-id

string

Unique request ID

Path Parameters

allocationId

string

required

The allocation ID is a fabric system-generated unique identifier created when the allocation is initially created.

Body

application/json

Allocation attributes update request details

attributes

object

required

User defined custom attributes. This is a placeholder for additional info in key value pairs.

Show child attributes

Example:

{ "attr1": "value" }

keysToRemove

string[]

A list of keys to be removed.

Response

Allocation response details

allocationId

string

required

24-character system-generated allocation ID

Example:

"62ff5c0bec0aed3c86202c32"

allocationRequestId

string

required

Merchant-specified unique ID. If omitted, this is generated by fabric’s sequence generator using Configuration service.

Example:

"62ff5c0bec0aed3c86202c32"

createdAt

string<date-time>

required

System-generated time of allocation record creation

Example:

"2022-08-01T18:03:28.483971941Z"

locationNumber

string

required

Inventory location number to identify ship-from location or Buy Online Pickup from Store (BOPIS) location. This must be the locationNumber stored in the fabric Location service.

Example:

"1234B"

version

integer<int64>

required

Allocation document version. The version number is incremented each time the allocation document undergoes an update. Update to an allocation document happens automatically when the status changes from one state to another based on the statusCode.

Example:

2

allocationNumber

integer<int32>

Merchant-specified unique number assigned to each allocation. If omitted, is this generated by fabric’s sequence generator using Configuration service

Example:

13000004

allocationExternalId

string

This is an optional identifier assigned to the invoice by the merchant.

Example:

"123k4h123k"

auditLogs

object[]

Change history details

Show child attributes

currency

string

Currency

Example:

"USD"

decisionContexts

object[]

A list of decision contexts.

Show child attributes

items

object[]

List of items to be shipped

Show child attributes

itemsType

string

This is an inherited attribute from Orders that pertains to item types such as WEB_SHIP, WEB_PICKUP, WEB_SDD INTERNATIONAL, POS, POS_SHIP, and POS_PICKUP.

Example:

"WEB_SHIP"

locationType

string

Inventory location type such as, DC or Store from where the order is picked up

Example:

"DC"

notifiedToPPSAt

string<date-time>

fabric system-generated time when allocation service sent event notification to package tracking service.

Example:

"2022-08-01T18:03:28.483971941Z"

orderSubType

string

During allocation creation, this attribute is inherited from fabric Orders and includes subtypes such as IOS, ANDROID, INTERNATIONAL, among others.

Example:

"ANDROID"

parentAllocationId

string

Allocation ID that's generated while creating the allocation for the first time. Initially this will be the same as allocationRequestId. If there is a reallocation, the parentAllocationId will be assigned the same value as the initial allocationRequestId, and will serve as a means of monitoring all subsequent child allocations.

Example:

"62ff5c0bec0aed3c86202c32"

previousAllocatedLocationNums

string[]

In case of reallocation, it keeps track of previously allocated location numbers.

Previously allocated location numbers

recipients

object[]

Recipient details like name, email address, and phone number

Show child attributes

shipToAddress

object

Address details

Show child attributes

shipFromAddress

object

Address details

Show child attributes

shipToId

string

System-generated UUID associated with shipInfo, generated from CnC service.

Note: An order can have multiple ship-to (delivery) locations and items going to the same location have one shipToId.

Example:

"98ff5c0bec0aed3c86202c32"

shipmentMethod

string

Shipping method. This attribute is inherited from order.shipInfo during allocation creation.

Example:

"Parcel Post Delivery"

shipmentType

string

This attribute is inherited from order.shipInfo during allocation creation. Acceptable value: SHIP_TO_ADDRESS, CUSTOMER_PICKUP, PICKUP, SDD, SHIP_TO_STORE

Example:

"SHIP_TO_ADDRESS"

shippedAt

string<date-time>

Time of order shipment, generated by allocation service when shipment service calls allocation after shipment is created.

Example:

"2022-08-01T20:03:28.483971941Z"

statusCode

enum<string>

Allocation status

Available options:

ALLOCATE,

ALLOCATION_HOLD_EXTERNAL,

PENDING_DROP,

PENDING_ALLOCATION,

PENDING_PICK,

SHIPPED,

PARTIALLY_SHIPPED,

REALLOCATED,

CANCELLED,

PARTIALLY_CANCELLED,

PENDING_REALLOCATION,

PARTIAL_PENDING_REALLOCATION

Example:

"ALLOCATED"

type

enum<string>

Allocation type ALLOCATED: Order is allocated for fulfillment SCRATCHED: Order is canceled during allocation due to unavailability of inventory RETURNED: Allocation created for the return items

Available options:

ALLOCATED,

SCRATCHED,

RETURNED

Example:

"ALLOCATED"

updatedAt

string<date-time>

System-generated time when allocation record was last modified

Example:

"2022-08-01T20:03:28.483971941Z"

Orders & Inventory

Order User Guides

Inventory User Guides

Error Codes

Orders API Endpoints

Inventory API Endpoints

Update allocation attributes

Authorizations

Headers

Path Parameters

Body

Response