Create or update a delivery

A delivery is a placeholder entity created by a seller before the order is allocated to a carrier.

A delivery is identified by its unique delivery reference or the combination of its delivery reference and order reference when both are provided.

Before a trackable item exists, a delivery resource can provide a tracking experience.

Note: Each time you update a delivery, you must resubmit the mandatory information of the delivery in addition to any other data that you have added or modified.

SecurityBasicAuth
Request
header Parameters
User-Agent
string

The name of the client that interacts with the API.

Example: REPLACE-WITH-YOUR-USER-AGENT
Shipper-Id
string

The unique identifier of a shipper within Metapack shipping platform.

Note: Reserved for Metapack use only.

Request Body schema: application/json
deliveryRef
required
string

The unique delivery reference. This reference is used to link a delivery for an order with the delivery legs for the parcels within this delivery that are part of the order.

object (Order)

An order contains information about the seller and the customer. It is used to provide the full overview of the deliveries for all the parcels within this order by using the order reference (orderRef).

object (Collection)

Collection information for pickup point or store collection delivery.

object (DeliveryInformation)

Information about the type of delivery.

object (Recipient)

The person receiving the parcel(s) in an order. The recipient is used to provide the destination time zone (Recipient.timeZone), which is used to process tracking events received from carriers when they do not provide time zone information with their events.

object (Sender)

Sender contains the information about the location from where the parcels for a delivery will ship. It contains the source time zone (Sender.timeZone), which is used to process tracking events received from carriers when they do not provide time zone information with their events.

Responses
204

Delivery information for the order has been processed successfully

400

Bad request.

The request failed validation due to missing required information in the parameters or the body of the request.

Error code: PS-0400.

401

Unauthorized.

The request did not provide the credentials required to authorize access to the API.

Error code: PS-0401.

403

Forbidden.

The API user is not authorized to proceed with the processing of the request.

Error code: PS-0403.

415

Unsupported media format.

The request failed due to an unsupported media type in the request.

Error code: PS-0415.

500

Internal Server Error.

The processing of the request failed due to an internal problem. The request needs to be retried.

Error code: PS-0500.

post/deliveries
Request samples
application/json
{
  • "deliveryRef": "REPLACE-WITH-YOUR-DELIVERY-REF",
  • "order": {
    },
  • "collection": {
    },
  • "delivery": {
    },
  • "recipient": {
    },
  • "sender": {
    }
}
Response samples
application/json
{
  • "message": "This is an error message",
  • "errorCode": "PS-XXXX",
  • "systemMessage": "This is a system message related to the error",
  • "traceId": "4d1544c7-1977-4c03-82fa-ecacd1837532",
  • "timestamp": "2019-08-24T14:15:22Z"
}