Skip to main content
POST
/
api
/
warehouse_routes
Create a warehouse route
curl --request POST \
  --url https://clarus-api.com/api/warehouse_routes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "warehouse_routes",
    "attributes": {
      "product_id": 5567,
      "warehouse_id": 12,
      "account_id": 44,
      "customer_id": 318
    }
  }
}
'
{
  "data": {
    "id": "1",
    "type": "warehouse_routes",
    "attributes": {
      "position": 1
    }
  }
}

​
Request Structure

{
  "data": {
    "type": "warehouse_routes",
    "attributes": {
      "product_id": 5567,
      "warehouse_id": 12,
      "account_id": 44,
      "customer_id": 318
    }
  }
}
FieldRequiredDescription
product_idYesProduct
warehouse_id / account_id / customer_idNoScope of the route
Requires a user with access to all warehouses and accounts. Reorder with PATCH /api/warehouse_routes/{id}/position.

Authorizations

​
Authorization
string
header
required

OAuth 2.0 authentication. Use the client credentials or authorization code flow to obtain an access token.

​
X-Clarus-Subdomain
string
header
required

The subdomain/tenant name identifying which tenant's data to access. Required for all API requests.

Body

application/json
​
data
object
required

Response

Created successfully

The response is of type object.