Patch a buffer location by ID

PATCH 
/buffer-locations/:id

Partially update information about a specific buffer location.

Request

Path Parameters

id stringrequired

The ID of the buffer location to retrieve, update or delete

application/json

Body

required

name string
location string
type string

Possible values: [pickup, dropoff]

properties object
loads uuid[]
storeId uuid

Responses

200

Buffer location patched

application/json

Schema

Schema

_id uuid
name string
location string
type string

Possible values: [pickup, dropoff]

properties object
loads object[]
Array [
_id uuid
name string
setName string
loadType string
maxWeight number
loadPositions string[]
properties object
createdAt date-time
updatedAt date-time
]
storeId uuid
createdAt date-time
updatedAt date-time

Example (from schema)

{
  "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "name": "string",
  "location": "string",
  "type": "pickup",
  "properties": {},
  "loads": [
    {
      "_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "name": "string",
      "setName": "string",
      "loadType": "string",
      "maxWeight": 0,
      "loadPositions": [
        "string"
      ],
      "properties": {},
      "createdAt": "2025-06-05T13:40:40.699Z",
      "updatedAt": "2025-06-05T13:40:40.699Z"
    }
  ],
  "storeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2025-06-05T13:40:40.699Z",
  "updatedAt": "2025-06-05T13:40:40.699Z"
}

400

Bad Request due to validation errors in the request body

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Validation failed.",
  "errors": [
    {
      "field": "name",
      "message": "Name is required."
    },
    {
      "field": "location",
      "message": "Location is required."
    },
    {
      "field": "storeId",
      "message": "Invalid ObjectId"
    }
  ]
}

Example

{
  "message": "Validation failed.",
  "errors": [
    {
      "field": "name",
      "message": "Name is required."
    },
    {
      "field": "location",
      "message": "Location is required."
    },
    {
      "field": "storeId",
      "message": "Invalid ObjectId"
    }
  ]
}

401

Unauthorized.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Authentication token not provided."
}

Example

{
  "message": "Authentication token not provided."
}

403

Forbidden.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Access to this resource is forbidden."
}

Example

{
  "message": "Access to this resource is forbidden."
}

404

Resource not found.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Resource not found."
}

Example

{
  "message": "Resource not found."
}

500

Internal Server Error

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "Internal Server Error. Please try again later."
}

Example

{
  "message": "Internal Server Error. Please try again later."
}

Loading...