Create a new buffer location

POST 
/buffer-locations

Create a new buffer location.

Request

application/json

Body

required

name stringrequired
location stringrequired
type string

Possible values: [pickup, dropoff]

properties object
loads uuid[]
storeId uuidrequired

Responses

201

Buffer location created

application/json

Schema

Schema

_id uuid
name string
location string
type string

Possible values: [pickup, dropoff]

properties object
loads uuid[]
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": [
    "3fa85f64-5717-4562-b3fc-2c963f66afa6"
  ],
  "storeId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "createdAt": "2024-12-03T13:25:44.956Z",
  "updatedAt": "2024-12-03T13:25:44.956Z"
}

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": "email",
      "message": "Email must be a valid email address."
    }
  ]
}

Example

{
  "message": "Validation failed.",
  "errors": [
    {
      "field": "name",
      "message": "Name is required."
    },
    {
      "field": "email",
      "message": "Email must be a valid email address."
    }
  ]
}

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."
}

409

A buffer location with the given details already exists.

application/json

Schema

Schema

any

Example (from schema)

{
  "message": "A buffer location with the given details already exists."
}

Example

{
  "message": "A buffer location with the given details already exists."
}

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...