Orders
Introduction
Through the endpoints included in the Orders section, you will be able to:
Retrieve all the orders
Retrieve details about a specific order
Create orders
Accept orders
Update orders' shipping address
Endpoints
This API endpoint retrieves a list of all orders
Authorizations
Responses
200
OK
application/json
401
Unauthorized
get
GET /api/v1/orders HTTP/1.1
Host: api.merchone.com
Authorization: Basic username:password
Accept: */*
{
"data": [
{
"order_id": "PPO12345678",
"external_id": null,
"country": "DE",
"shipping_type": "Tracked",
"is_test": false,
"total_amount": 100,
"created_at": "2025-01-01T00:00:00+00:00",
"updated_at": "2025-01-01T00:00:00+00:00",
"fulfilled_at": null,
"status": "Draft"
}
]
}This API endpoint retrieves information about the order
Authorizations
Path parameters
orderstringRequired
The ID of the order.
Responses
200
OK
application/json
401
Unauthorized
get
GET /api/v1/orders/{order} HTTP/1.1
Host: api.merchone.com
Authorization: Basic username:password
Accept: */*
{
"data": {
"order_id": "PPO12345678",
"external_id": null,
"status": "Draft",
"shipping": {
"email": null,
"firstname": "John",
"lastname": "Doe",
"company": null,
"street_primary": "275 Wyman St.",
"street_secondary": null,
"city": "BE",
"postcode": "01234",
"country": "DE",
"telephone": "+1234567890"
},
"shipping_type": "Tracked",
"is_test": true,
"total_amount": {
"amount": 100,
"currency": "EUR"
},
"sub_total": {
"amount": 90,
"currency": "EUR"
},
"shipping_total": {
"amount": 10,
"currency": "EUR"
},
"customs_shipping": {
"amount": 0,
"currency": "EUR"
},
"customs_costs": {
"amount": 0,
"currency": "EUR"
},
"created_at": "2023-01-01T00:00:00+00:00",
"updated_at": "2023-01-01T11:00:00+00:00",
"fulfilled_at": null,
"packages": [],
"items": [
{
"external_id": "1",
"sku": "CVS0200201LWF2",
"article": {
"id": 1,
"sku": "CVS0200201LWF2-APO12345678"
},
"description": "20x20 cm - White - 2 cm",
"quantity": 1,
"unit_cost": {
"amount": 7,
"currency": "EUR"
},
"taxes": {
"amount": 10,
"currency": "EUR"
},
"total_item": {
"amount": 10,
"currency": "EUR"
},
"metadata": null
}
]
}
}Authorizations
Body
one ofOptional
or
or
Responses
200
OK
application/json
401
Unauthorized
422
Unprocessable Entity
post
POST /api/v1/orders HTTP/1.1
Host: api.merchone.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 351
{
"external_id": "",
"shipping_type": "tracked",
"is_test": true,
"shipping": {
"firstname": "Sophie",
"lastname": "Muller",
"email": "[email protected]",
"street_primary": "101 Elm Road",
"country": "DE",
"city": "Berlin",
"postcode": "10115"
},
"items": [
{
"quantity": 1,
"product_sku": "CVS0200201LWF2",
"file": {
"front": {
"url": "https://example.com/images/image.png"
}
}
}
]
}{
"order_id": "PPO12345678"
}Authorizations
Path parameters
orderstringRequired
The ID of the order.
Body
emailstring · emailOptional
telephonestringOptional
firstnamestringRequired
lastnamestringRequired
companystringOptional
street_primarystringRequired
street_secondarystringOptional
Responses
200
OK
application/json
401
Unauthorized
403
Forbidden
put
PUT /api/v1/orders/{order}/update-address HTTP/1.1
Host: api.merchone.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 193
{
"email": "[email protected]",
"telephone": "+1234567890",
"firstname": "Sophie",
"lastname": "Muller",
"company": "Example Company",
"street_primary": "101 Elm Road",
"street_secondary": "Apt 123"
}{
"message": "Address has been updated"
}Last updated