Skip to main content
PATCH
/
api
/
goods_out_pick_lists
/
{id}
Update a pick list
curl --request PATCH \
  --url https://clarus-api.com/api/goods_out_pick_lists/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Clarus-Subdomain: <api-key>' \
  --data '
{
  "data": {
    "type": "goods_out_pick_lists",
    "attributes": {
      "reference": "<string>",
      "string1": "<string>",
      "string2": "<string>",
      "string3": "<string>",
      "string4": "<string>",
      "string5": "<string>"
    }
  }
}
'
{
  "data": {
    "id": 123,
    "type": "goods_out_pick_lists",
    "attributes": {
      "reference": "<string>",
      "warehouse_id": 123,
      "goods_out_ids": [
        123
      ],
      "string1": "<string>",
      "string2": "<string>",
      "string3": "<string>",
      "string4": "<string>",
      "string5": "<string>"
    }
  }
}

​
Request Structure

{
  "data": {
    "type": "goods_out_pick_lists",
    "attributes": {
      "reference": "PL-2024-001-REV"
    }
  }
}

​
Key Fields

FieldRequiredDescription
referenceNoUpdated pick list reference

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.

Path Parameters

​
id
integer
required

The unique identifier of the pick list to update

Body

application/json
​
data
object
required

Response

Pick list updated successfully

​
data
object