Zalando Orders API
The Orders API from Zalando — 11 operation(s) for orders.
Zalando Orders API is one of 20 APIs that Zalando publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Orders. The published artifact set on APIs.io includes an OpenAPI specification and an API reference.
This API exposes 15 operations across 11 paths, and defines 51 schemas. It is described by OpenAPI 3.0.2, at version 1.0.0.
Requests are made against the base URL https://api.merchants.zalando.com.
15 operations
11 paths
51 schemas
11 GET3 PATCH1 POST
Metadata
The identity and technical contract details declared by the specification.
Paths & Operations 15
Across 11 paths, the API surfaces 15 operations — 11 GET, 3 PATCH, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Orders 15
GET
/merchants/{merchant-id}/orders
Retrieves the merchant orders. Allows filtering of the orders by creation and modified date.
GET
/merchants/{merchant-id}/orders/{order-id}
Retrieves an order by order-id.
PATCH
/merchants/{merchant-id}/orders/{order-id}
Partially updates the order.
GET
/merchants/{merchant-id}/orders/{order-id}/transitions
Retrieves all state transitions for a given order-id.
GET
/merchants/{merchant-id}/orders/{order-id}/shipments
Get shipments for the order
POST
/merchants/{merchant-id}/orders/{order-id}/shipments
Create a shipment.
GET
/merchants/{merchant-id}/orders/{order-id}/shipments/{shipment-id}
Get an individual shipment
PATCH
/merchants/{merchant-id}/orders/{order-id}/shipments/{shipment-id}
Update a shipment
GET
/merchants/{merchant-id}/orders/{order-id}/items
Retrieves all order items for a given order-id.
GET
/merchants/{merchant-id}/orders/{order-id}/items/{order-item-id}
Retrieves an order item with the given identifier.
GET
/merchants/{merchant-id}/orders/{order-id}/items/{order-item-id}/lines
Retrieves the Order Lines of an order item.
GET
/merchants/{merchant-id}/orders/{order-id}/items/{order-item-id}/lines/{order-line-id}
Retrieves an Order Line with the given identifier.
PATCH
/merchants/{merchant-id}/orders/{order-id}/items/{order-item-id}/lines/{order-line-id}
Updates the Order Line status with the provided status.
GET
/merchants/{merchant-id}/orders/{order-id}/items/{order-item-id}/lines/{order-line-id}/transitions
Retrieves all transitions that happened at the Order Line level.
GET
/merchants/{merchant-id}/orders-deletion-requests
Retrieves the order data belonging to customers who requested data deletion.
Schemas 51
The contract defines 51 schemas that model the data the API accepts and returns. The most detailed are OrderAttributes (29 properties), OrderItemAttributes (14 properties), OrderLineAttributes (12 properties), Shipment (11 properties). Each schema is shown below with its type and property counts.
Cursor
object
The representation of a cursor for fetching paginated list of orders for deletion.
1 property
Errors
object
An array of error objects.
1 property
Shipment
object
A shipment represents the delivery of specific order lines from an order in a single parcel. It includes additional details such as tracking numbers, the stock…
11 properties
1 required
TransitionsTopLevel
object
Representation of a list of transitions according to the JSON API specification.
3 properties
Phone
object
The phone number of the customer who placed the order. It's exposed only with required permissions
1 property
1 required
OrderLineStatus
string
The status of an Order Line.
ShipmentStatus
string
The status of the shipment.
Money
object
2 properties
2 required
OrderAttributes
object
Representation of an order.
29 properties
8 required
TransitionReason
object
The reason for an order or order line transition.
2 properties
2 required
OrderLineRelationships
object
Order Line relationships.
1 property
RateLimitError
object
Error object for rate limit.
1 property
ServicePointDetails
object
3 properties
ItemResourceObject
Relationships
object
Relationship object to represent One-to-Many relationships.
2 properties
OrderLineUpdateAttributes
object
Attribute belonging to an Order Line update.
3 properties
1 required
ShipmentResource
object
Shipment resource object
3 properties
ShipmentOrderLine
object
Shipment related attributes of an order line
2 properties
1 required
OrderResourceObject
Shipments
object
A collection of shipments for this order.
1 property
Order
object
Order Resource Object.
6 properties
TransitionAttributes
object
Details of a state transition for an Order or Order Line
5 properties
4 required
OrderItem
object
Order Item Resource Object.
6 properties
OrderUpdateAttributes
object
Attributes belonging to an order update.
3 properties
OrderItemsTopLevel
object
Representation of a list of order items according to the JSON API specification.
4 properties
Address
object
The representation of an address.
10 properties
6 required
OrdersTopLevel
object
Representation of a list of orders according to the JSON API specification.
4 properties
OrderUpdateTopLevel
object
Representation of an order update according to the JSON API specification.
1 property
Meta
object
Meta
3 properties
1 required
DeletionRequests
object
Representation of a deletion request containing list of orders with details to be deleted
2 properties
TransitionData
object
Transition resource object.
5 properties
OrderStatus
string
The status of an order.
Error
object
Error object
5 properties
OrderUpdateData
object
Data of an order update.
3 properties
3 required
OrderTopLevel
object
Representation of an order according to the JSON API specification.
4 properties
OrderLinesTopLevel
object
Representation of a list of Order Lines according to the JSON API specification.
4 properties
OrderLineUpdateData
object
Data of an Order Line update.
3 properties
3 required
OrderLineTopLevel
object
Representation of an Order Line according to the JSON API specification.
4 properties
OrderItemTopLevel
object
Representation of an order item according to the JSON API specification.
4 properties
OrderItemRelationships
object
Order Item relationships.
1 property
OrderRelationships
object
Order relationships.
2 properties
Weight
object
The weight measurement
2 properties
2 required
OrderLineUpdateTopLevel
object
Representation of an Order Line update according to the JSON API specification.
1 property
OrderItemAttributes
object
An Order Item contains a summarized view with quantities of the underlying Order Lines.
14 properties
6 required
DeletionRequestOrder
object
Representation of an order to be deleted.
7 properties
OrderLineAttributes
object
A detailed view of an Order Item - a single line of possible multiple Order Lines.
12 properties
2 required
ErrorSource
object
Indicate the source of error.
2 properties
Links
object
Links response
6 properties
OrderLine
object
OrderLine resource object
6 properties
ResourceIdentifierObject
object
Resource Identifier Object which uniquely identifies a Resource Object.
2 properties
2 required
LineResourceObject
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Zalando 12
Other APIs Zalando publishes across the network.
Zalando AnnouncedReturns API
Zalando attribute-types API
Zalando attribute-values API
Zalando Attributes API
Zalando Cross Border Movements API
Zalando Discovery API API
Zalando History of Price Update Attempts API
Zalando Liquidated Items API
Zalando Logistic Centers API
Zalando offer-blockers API
Zalando Outlines API
Zalando prices API
#Orders