Saltar al contenido principal
GET
/
v1
/
warehouse
/
shipments
/
{shipmentReference}
Get one shipment by its reference
curl --request GET \
  --url https://api.bold-factory.com/v1/warehouse/shipments/{shipmentReference} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "externalReference": "<string>",
  "destination": "<string>",
  "destinationId": "<string>",
  "date": "2023-12-25",
  "code": "<string>",
  "locationId": "<string>",
  "location": {
    "id": "<string>",
    "externalReference": "<string>",
    "name": "<string>",
    "createdAt": "2023-11-07T05:31:56Z",
    "createdBy": "<string>",
    "lastModifiedAt": "2023-11-07T05:31:56Z",
    "lastModifiedBy": "<string>"
  },
  "shipped": true,
  "shippedAt": "2023-11-07T05:31:56Z",
  "createdAt": "2023-11-07T05:31:56Z",
  "createdBy": "<string>",
  "lastModifiedAt": "2023-11-07T05:31:56Z",
  "lastModifiedBy": "<string>"
}

Autorizaciones

Authorization
string
header
requerido

Use a valid JWT token in the Authorization header with the format 'Bearer {token}'

Parámetros de ruta

shipmentReference
string
requerido

Respuesta

OK

id
string
requerido
externalReference
null | string
requerido
destination
string
requerido
destinationId
string
requerido
type
enum<string>
requerido
Opciones disponibles:
Customer,
Supplier
status
enum<string>
requerido
Opciones disponibles:
Pending,
Shipped
date
string<date>
requerido
code
string
requerido
locationId
null | string
requerido
location
object
requerido
shipped
boolean
requerido
shippedAt
null | string<date-time>
requerido
createdAt
string<date-time>
requerido
createdBy
string
requerido
lastModifiedAt
string<date-time>
requerido
lastModifiedBy
string
requerido