ReDoc documentation

Pickup Orders

Pickup orders represent an order where the executor needs to pick up cargo at a certain stop.

Find out more

Get a Pickup by business id for a given TransportRequest

This endpoint allows you to get the information about a given pickup that is contained in a TransportRequest.

Note: It is not possible to retrieve pickups within TransportRequests directly through the Get a Pickup by business Id endpoint.

Securitykeycloak
Request
path Parameters
business_id
required
string

The identifier of the TransportRequest within which this pickup exists.

order_id
required
string

The identifier of a Pickup instance

Responses
200

OK

404

The entity is not found

default

General error payload

get/transport-requests/{business_id}/orders/pickups/{order_id}
Response samples
application/json
{
  • "order": {
    },
  • "pickup": {
    }
}

Upsert a Pickup by business id for a given TransportRequest

Upsert pickup information. When if-match is not specified, then no optimistic protection is applied, ie: the last update wins.

Note: It is not possible to update pickups within TransportRequests directly through the Upsert a Pickup by business Id endpoint.

Securitykeycloak
Request
path Parameters
business_id
required
string

The identifier of the TransportRequest within which this pickup must be added/edited.

order_id
required
string

The identifier of a Pickup instance

header Parameters
If-Match
string

weak Etag as optimistic locking check

Prefer
Array of strings

The RFC7240 Prefer header indicates that a particular server behavior is preferred by the client but is not required for successful completion of the request (see RFC 7240).

The following behavior is supported by this API:

  • return=<minimal|representation> is used to suggest the server to return using status code 204 without a resource in the response body (minimal) or using status codes 200 or 201 with the resource in the response body on success (representation).
Request Body schema: application/json
required
object (OrderInformation)
required
object (TransportInformation)

Properties specific to the activity that needs to be executed for fulfilling this order. In case of a PickupDelivery Order, these are two separate activities with their own settings.

Responses
201

Order updated

Response body contains updated Order

204

No Content

404

The entity is not found

409

Response status code indicates a request conflict with current state of the server.

412

Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET or HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the entity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed and this error response is sent back.

default

General error payload

put/transport-requests/{business_id}/orders/pickups/{order_id}
Request samples
application/json
{
  • "order": {
    },
  • "pickup": {
    }
}
Response samples
application/json
{
  • "order": {
    },
  • "pickup": {
    }
}

Delete a Pickup by business id for a given TransportRequest

This endpoint allows you to delete a given pickup within a transport request.

Note: It is not possible to delete pickups within TransportRequests directly through the Delete a Pickup by business Id endpoint.

Securitykeycloak
Request
path Parameters
business_id
required
string

The identifier of the TransportRequest from which this pickup must be removed.

order_id
required
string

The identifier of a Pickup instance

header Parameters
If-Match
string

weak Etag as optimistic locking check

Responses
204

No Content

404

The entity is not found

412

Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET or HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the entity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed and this error response is sent back.

default

General error payload

delete/transport-requests/{business_id}/orders/pickups/{order_id}
Response samples
application/problem+json
{}

Get a Pickup by business Id

Retrieve a single Pickup order by its business id.

Securitykeycloak
Request
path Parameters
business_id
required
string

The business identifier of an entity instance

Responses
200

OK

404

The entity is not found

default

General error payload

get/orders/pickups/{business_id}
Response samples
application/json
{
  • "order": {
    },
  • "pickup": {
    }
}

Upsert a Pickup by business Id

Create or update a Pickup Order.

This endpoint allows you to update (default behaviour) or insert a Pickup Order. The caller is responsible for providing a unique business identifier for each Order, regardless of order type. If this business identifier can't be found, a new order will be created. If a Pickup order with the given business identifier can be found then it will be updated.

Securitykeycloak
Request
path Parameters
business_id
required
string

The business identifier of an entity instance

header Parameters
Prefer
Array of strings

The RFC7240 Prefer header indicates that a particular server behavior is preferred by the client but is not required for successful completion of the request (see RFC 7240).

The following behavior is supported by this API:

  • return=<minimal|representation> is used to suggest the server to return using status code 204 without a resource in the response body (minimal) or using status codes 200 or 201 with the resource in the response body on success (representation).
Request Body schema: application/json
required
object (OrderInformation)
required
object (TransportInformation)

Properties specific to the activity that needs to be executed for fulfilling this order. In case of a PickupDelivery Order, these are two separate activities with their own settings.

Responses
201

Order created or updated.

204

No Content

404

The entity is not found

409

Response status code indicates a request conflict with current state of the server.

412

Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET or HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the entity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed and this error response is sent back.

default

General error payload

put/orders/pickups/{business_id}
Request samples
application/json
{
  • "order": {
    },
  • "pickup": {
    }
}
Response samples
application/json
{
  • "order": {
    },
  • "pickup": {
    }
}

Delete a Pickup by business Id

This endpoint allows you to delete the information about a given pickup.

Securitykeycloak
Request
path Parameters
business_id
required
string

The business identifier of an entity instance

Responses
204

No Content

404

The entity is not found

412

Client error response code indicates that access to the target resource has been denied. This happens with conditional requests on methods other than GET or HEAD when the condition defined by the If-Unmodified-Since, If-Match or If-None-Match headers is not fulfilled. This is typically the case when the entity was updated by someone else before you commit your request. In that case, the request, usually a modification of a resource, cannot be executed and this error response is sent back.

default

General error payload

delete/orders/pickups/{business_id}
Response samples
application/problem+json
{}
➔ Next to Delivery Orders