Create shipment

post https://api.mollie.com/v2/orders/{orderId}/shipments

⚠️ We no longer recommend implementing the Shipments API. Please refer to the Captures API instead. We are actively working on adding support for line-specific captures to the Captures API.

Create a shipment for specific order lines of an order.

When using Klarna, using this endpoint is mandatory for the order amount to be captured. A capture will automatically be created for the shipment.

The word 'shipment' is used in the figurative sense here. It can also mean that a service was provided or digital content was delivered.

🔑
Access with
API key
Access token with shipments.write

Responses

Response body

object

resource

string

Defaults to shipment

Indicates the response contains a shipment object. Will always contain the string shipment for this endpoint.

string

The identifier uniquely referring to this shipment. Example: shp_gNapNy9qQTUFZYnCrCF7J.

mode

string

Whether this entity was created in live mode or in test mode.

Possible values: live test

orderId

string

The unique identifier of the order this shipment was created for. For example: ord_8wmqcHMN4U.

createdAt

string

The entity's date and time of creation, in ISO 8601 format.

tracking

object

Shipment tracking details. Can be omitted if tracking details are not available or not applicable.

carrier

string

The name of the postal carrier.

code

string

The track-and-trace code for the shipment.

url

string

The URL where your customer can track the shipment.

routing

array of objects

routing

object

string

The identifier uniquely referring to this route. Mollie will always refer to the route by this ID. Example: rt_5B8cwPMGnU6qLbRvo7qEZo.

amount

object

The portion of the total payment amount being routed.

destination

object

The destination of this portion of the payment.

lines

array of objects

The order lines that are being fulfilled with this shipment. If left blank, all open order lines will be considered fulfilled.

lines

object

resource

string

Defaults to orderline

string

The ID of the order line you wish to refund. For example: odl_jp31y97yjz.

orderId

string

name

string

sku

string | null

type

string

physical digital discount shipping_fee store_credit gift_card surcharge

status

string

created authorized paid canceled shipping completed

metadata

Provide any data you like, for example a string or a JSON object. We will save the data alongside the entity. Whenever you fetch the entity with our API, we will also include the metadata. You can use up to approximately 1kB.

isCancelable

boolean

quantity

integer

The number of items that should be refunded for this order line. When this parameter is omitted, the whole order line will be refunded.

Must be less than the number of items already refunded for this order line.

quantityShipped

integer

amountShipped

object

In v2 endpoints, monetary amounts are represented as objects with a currency and value field.

quantityRefunded

integer

amountRefunded

object

In v2 endpoints, monetary amounts are represented as objects with a currency and value field.

quantityCanceled

integer

amountCanceled

object

In v2 endpoints, monetary amounts are represented as objects with a currency and value field.

shippableQuantity

integer

refundableQuantity

integer

cancelableQuantity

integer

unitPrice

object

In v2 endpoints, monetary amounts are represented as objects with a currency and value field.

totalAmount

object

In v2 endpoints, monetary amounts are represented as objects with a currency and value field.

vatRate

string

vatAmount

object

In v2 endpoints, monetary amounts are represented as objects with a currency and value field.

createdAt

string

discountedAmount

object

In v2 endpoints, monetary amounts are represented as objects with a currency and value field.

_links

object

An object with several relevant URLs. Every URL object will contain an href and a type field.

self

object

In v2 endpoints, URLs are commonly represented as objects with an href and type field.

order

object

The API resource URL of the order that this shipment belongs to.

documentation

object

In v2 endpoints, URLs are commonly represented as objects with an href and type field.

Language

Credentials

Request


xxxxxxxxxx
1
curl -X POST https://api.mollie.com/v2/payments/ord_pbjz8x/shipments \
2
    -H "Authorization: Bearer live_dHar4XY7LxsDOtmnkVtjNVWXLSlXsM" \
3
    -d "lines[0][id]=odl_dgtxyl" \
4
    -d "lines[0][quantity]=1" \
5
    -d "lines[1][id]=odl_jp31jz" \
6
    -d "tracking[carrier]=PostNL" \
7
    -d "tracking[code]=3SKABA000000000" \
8
    -d "tracking[url]=http://postnl.nl/tracktrace/?B=3SKABA000000000&P=1015CW&D=NL&T=C"


xxxxxxxxxx
76
}
1
{
2
  "resource": "shipment",
3
  "id": "shp_gNapNy9qQTUFZYnCrCF7J",
4
  "mode": "live",
5
  "orderId": "ord_pbjz8x",
6
  "tracking": {
7
    "carrier": "PostNL",
8
    "code": "3SKABA000000000",
9
    "url": "http://postnl.nl/tracktrace/?B=3SKABA000000000&P=1015CW&D=NL&T=C"
10
  },
11
  "createdAt": "2023-08-09T14:33:54.0Z",
12
  "lines": [
13
    {
14
      "resource": "orderline",
15
      "id": "odl_dgtxyl",
16
      "type": "physical",
17
      "name": "LEGO 42083 Bugatti Chiron",
18
      "quantity": 1,
19
      "unitPrice": {
20
        "currency": "EUR",
21
        "value": "399.00"
22
      },
23
      "totalAmount": {
24
        "currency": "EUR",
25
        "value": "399.00"

201The newly created shipment object.

404No entity with this ID exists.

422The request contains issues. For example, if an order line ID is missing.