Skip to content

Ship-restriction entries for one SKU

GET
/v1/catalog/restrictions/{distributor}/{sku}
curl --request GET \
--url https://api.oldsteelarsenal.com/v1/catalog/restrictions/example/example \
--header 'x-client-id: <x-client-id>' \
--header 'x-signature: <x-signature>' \
--header 'x-timestamp: <x-timestamp>'

Verbatim [municipality, state, territory_type, detail] entries from the distributor’s restrictions feed; empty list when none. The POS keeps its own vocabulary/derivation (blocked states etc.) on top. Scope: catalog:read.

distributor
required
Distributor
string
sku
required
Sku
string
x-client-id
Any of:
string
x-timestamp
Any of:
string
x-signature
Any of:
string

Successful Response

Media typeapplication/json
RestrictionsResponse
object
entries
required
Entries
Array<Array<string>>
entry_count
required
Entry Count
integer
sku
required
Sku
string
Examplegenerated
{
"entries": [
[
"example"
]
],
"entry_count": 1,
"sku": "example"
}

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
"detail": [
{
"ctx": {},
"input": "example",
"loc": [
"example"
],
"msg": "example",
"type": "example"
}
]
}