--- title: "List shipments" method: GET path: "/orders/{orderId}/shipments" tags: ["Shipments API"] deprecated: true --- # List shipments `GET /orders/{orderId}/shipments` ## Request - Base URL: `https://api.mollie.com/v2` - URL: `https://api.mollie.com/v2/orders/{orderId}/shipments` - Auth: one of: - HTTP bearer - HTTP bearer - OAuth 2 - Authorization code: `https://my.mollie.com/oauth2/authorize` - Token URL: `https://api.mollie.com/oauth2/tokens` scopes: `shipments.read` > **Deprecated.** Retrieve a list of all shipments created for a specific order. The results are paginated. > 🔑 Access with > > [API key](/reference/authentication) > > [Advanced access token with **shipments.read**](/reference/authentication) > > [OAuth access with **shipments.read**](/reference/authentication) ## Query parameters - `from` string - `limit` integer, nullable - `sort` string - `testmode` boolean ## Response `200` A list of shipment objects. - object - `count` integer: The number of items in this result set. If more items are available, a `_links.next` URL will be present in the result as well. The maximum number of items per result set is controlled by the `limit` property provided in the request. The default limit is 50 items. - `_embedded` object - `shipments` object[]: An array of shipment objects. - `resource` string: Indicates the response contains a shipment object. Will always contain the string `shipment` for this endpoint. - `id` 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](https://en.wikipedia.org/wiki/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` object[] - `id` 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. - `currency` string, required: A three-character ISO 4217 currency code. - `value` string, required: A string containing an exact monetary amount in the given currency. - `destination` object: The destination of this portion of the payment. - `type` string: The type of destination. Currently only the destination type `organization` is supported. Possible values: `organization` - `organizationId` string: Required for destination type `organization`. The ID of the connected organization the funds should be routed to. - `lines` object[]: The order lines that are being fulfilled with this shipment. If left blank, all open order lines will be considered fulfilled. - `resource` string, required - `id` string, required: The ID of the order line you wish to refund. For example: `odl_jp31y97yjz`. - `orderId` string, required - `name` string, required - `sku` string, nullable, required - `type` 'physical' | 'digital' | 'discount' | 'shipping_fee' | 'store_credit' | 'gift_card' | 'surcharge', required - `status` 'created' | 'authorized' | 'paid' | 'canceled' | 'shipping' | 'completed', required - `metadata` union, required: 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. - string - number - object - string[] - `isCancelable` boolean, required - `quantity` integer, required: 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. - `currency` string, required: A three-character ISO 4217 currency code. - `value` string, required: A string containing an exact monetary amount in the given currency. - `quantityRefunded` integer - `amountRefunded` object: In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field. - `currency` string, required: A three-character ISO 4217 currency code. - `value` string, required: A string containing an exact monetary amount in the given currency. - `quantityCanceled` integer - `amountCanceled` object: In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field. - `currency` string, required: A three-character ISO 4217 currency code. - `value` string, required: A string containing an exact monetary amount in the given currency. - `amount` object: The amount that you want to refund. In almost all cases, Mollie can determine the amount automatically. The amount is required only if you are partially refunding an order line which has a non-zero `discountAmount`. The amount you can refund depends on various properties of the order line and the create order refund request. The maximum that can be refunded is `unit price x quantity to ship`. The minimum amount depends on the discount applied to the line, the quantity already refunded or shipped, the amounts already refunded or shipped and the quantity you want to refund. If you do not send an amount, Mollie will determine the amount automatically or respond with an error if the amount cannot be determined automatically. The error will contain the `extra.minimumAmount` and `extra.maximumAmount` properties that allow you pick the right amount. - `currency` string, required: A three-character ISO 4217 currency code. - `value` string, required: A string containing an exact monetary amount in the given currency. - `shippableQuantity` integer - `refundableQuantity` integer - `cancelableQuantity` integer - `unitPrice` object, required: In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field. - `currency` string, required: A three-character ISO 4217 currency code. - `value` string, required: A string containing an exact monetary amount in the given currency. - `totalAmount` object, required: In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field. - `currency` string, required: A three-character ISO 4217 currency code. - `value` string, required: A string containing an exact monetary amount in the given currency. - `vatRate` string, required - `vatAmount` object, required: In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field. - `currency` string, required: A three-character ISO 4217 currency code. - `value` string, required: A string containing an exact monetary amount in the given currency. - `createdAt` string, required - `discountedAmount` object: In v2 endpoints, monetary amounts are represented as objects with a `currency` and `value` field. - `currency` string, required: A three-character ISO 4217 currency code. - `value` string, required: A string containing an exact monetary amount in the given currency. - `_links` object, required: An object with several relevant URLs. Every URL object will contain an `href` and a `type` field. - `productUr` object: In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field. - `href` string, required: The actual URL string. - `type` string, required: The content type of the page or endpoint the URL points to. - `imageUrl` object: In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field. - `href` string, required: The actual URL string. - `type` string, required: The content type of the page or endpoint the URL points to. - `_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. - `href` string, required: The actual URL string. - `type` string, required: The content type of the page or endpoint the URL points to. - `order` object: The API resource URL of the [order](get-order) that this shipment belongs to. - `href` string, required: The actual URL string. - `type` string, required: The content type of the page or endpoint the URL points to. - `_links` object: Links to help navigate through the lists of items. Every URL object will contain an `href` and a `type` field. - `self` object, required: The URL to the current set of items. - `href` string, required: The actual URL string. - `type` string, required: The content type of the page or endpoint the URL points to. - `previous` object, nullable, required: The previous set of items, if available. - `href` string: The actual URL string. - `type` string: The content type of the page or endpoint the URL points to. - `next` object, nullable, required: The next set of items, if available. - `href` string: The actual URL string. - `type` string: The content type of the page or endpoint the URL points to. - `documentation` object, required: In v2 endpoints, URLs are commonly represented as objects with an `href` and `type` field. - `href` string, required: The actual URL string. - `type` string, required: The content type of the page or endpoint the URL points to. ## Other responses - `400`: The request contains issues. For example, if the specified `from` value is not a valid ID. - `404`: No entity with this ID exists. - `429`: Rate Limit has been reached. --- [API](https://skmtc.dev/mollie/apis/receiving-orders.md) - [All operations](https://skmtc.dev/mollie/apis/receiving-orders/llms.txt) - [OpenAPI document](https://skmtc.dev/mollie/apis/receiving-orders/revisions/b5cd7a3629e9?raw)