Get orders

Get all orders

SecurityBearer

Request

query Parameters

offset	integer <int32>
limit	integer <int32>
payment_id	string
reference	string
cart_reference	string
date_from	string <date-time>
date_to	string <date-time>
status	Array of strings (OrderStatus) Items Enum: "checkout" "processing" "accepted" "completed" "declined" "removed"
order_by	string Enum: "created" "billingEmail" "billingName" "cartTotal"
order_by_direction	string Enum: "asc" "desc"
countries	Array of strings
billing_countries	Array of strings
shipping_countries	Array of strings
billing_emails	Array of strings
shipping_emails	Array of strings
billing_phones	Array of strings
shipping_phones	Array of strings
billing_names	Array of strings
shipping_names	Array of strings

header Parameters

x-merchant required	string non-empty Merchant identifier. Example: norce
x-channel required	string non-empty Channel identifier Example: 1

Responses

200

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Server Error

get/api/v0/checkout/orders

Request samples

curl

Response samples

application/json

{"data": [{"id": "o_yClTSySjyAuuBjmiBlHCjuEcTf",
"merchant": "string",
"channel": "string",
"reference": "string",
"created": "2019-08-24T14:15:22Z",
"lastModified": "2019-08-24T14:15:22Z",
"state": {"currentStatus": "checkout",
"transitions": [{"status": "checkout",
"timeStamp": "2019-08-24T14:15:22Z"
}
]
},
"culture": "string",
"currency": "string",
"country": "string",
"cart": {"reference": "string",
"items": [{"id": "ci_FpEzyBvBBUyKxkeNriFUxZOCje",
"reference": "string",
"name": "T-Shirt XL",
"sku": "A000123",
"productType": "physical",
"items": [{ }
],
"url": "https://example.com/products/A000123",
"imageUrl": "https://example.com/products/A000123/images/1",
"quantity": 2,
"unit": "st",
"price": {"includingVat": 1234,
"excludingVat": 987.2
},
"total": {"includingVat": 1234,
"excludingVat": 987.2
},
"originalTotal": {"includingVat": 1234,
"excludingVat": 987.2
},
"vatRate": 0.25,
"discounts": [{"type": null,
"name": null,
"code": null,
"value": null,
"attributes": { }
}
],
"logistics": {"weight": 2500,
"height": 100,
"width": 50,
"length": 200
},
"attributes": {"property1": null,
"property2": null
}
}
],
"discounts": [{"type": "item",
"name": "string",
"code": "string",
"value": {"includingVat": 1234,
"excludingVat": 987.2
},
"attributes": {"property1": null,
"property2": null
}
}
],
"total": {"includingVat": 1234,
"excludingVat": 987.2
},
"attributes": {"property1": null,
"property2": null
}
},
"shippings": [{"id": "s_pmHreuEBboeezpixrHMDPQlazU",
"merchant": "norce",
"channel": "1",
"state": "intent",
"reference": "e8ed2091-c34c-4837-a3a8-bc827b0dc183",
"tmsReference": "a935a628-f70c-47a4-a9f6-98c6d08c2ba3",
"orderId": "o_DhZSbDfVzNzuxOzHyCFskzGzaJ",
"adapterId": "ingrid-shipping-adapter",
"name": "PostNord MyPack Home",
"total": {"includingVat": 1234,
"excludingVat": 987.2
},
"vatRate": 0.25,
"deliveryDetails": {"carrier": "string",
"class": "string",
"product": {"reference": "string",
"name": "string"
},
"pickupLocation": {"reference": "string",
"name": "string",
"address": {"streetAddress": null,
"city": null,
"postalCode": null,
"country": null
}
}
},
"addons": [{"reference": "string",
"price": 0
}
],
"attributes": {"property1": null,
"property2": null
}
}
],
"payments": [{"id": "p_KBiXuYjvYxsezKCQAMuuSKGDaT",
"adapterId": "klarna-checkout",
"name": "string",
"merchant": "norce",
"channel": "string",
"currency": "SEK",
"type": "default",
"orderId": "o_DhZSbDfVzNzuxOzHyCFskzGzaJ",
"amount": 10,
"upperLimitAmount": 100,
"state": "Intent",
"reference": "7d31e2cf-2d46-4db0-b87d-d65dfaae298f",
"attributes": {"property1": null,
"property2": null
},
"actions": [{"id": "string",
"adapterId": "string",
"type": "string",
"url": "string"
}
],
"recurring": {"token": "string",
"description": "string",
"attributes": {"property1": null,
"property2": null
}
}
}
],
"customer": {"billing": {"type": "Person",
"givenName": "Rosalinainho",
"familyName": "Undulatsson",
"careOf": "Olleinho Jyckesson",
"reference": "string",
"organizationName": "Storm",
"streetAddress": "Adaptivevägen 18",
"streetAddress2": "Lgh 1203",
"postalCode": "955 60",
"city": "Boden",
"region": "Norrbotten",
"country": "SE",
"phone": "0753892233",
"email": "rosalinainho.undulatsson@example.com",
"nationalIdentificationNumber": "890201-3286",
"organizationIdentificationNumber": "212000-1355",
"attributes": {"property1": null,
"property2": null
}
},
"shipping": {"type": "Person",
"givenName": "Rosalinainho",
"familyName": "Undulatsson",
"careOf": "Olleinho Jyckesson",
"reference": "string",
"organizationName": "Storm",
"streetAddress": "Adaptivevägen 18",
"streetAddress2": "Lgh 1203",
"postalCode": "955 60",
"city": "Boden",
"region": "Norrbotten",
"country": "SE",
"phone": "0753892233",
"email": "rosalinainho.undulatsson@example.com",
"nationalIdentificationNumber": "890201-3286",
"organizationIdentificationNumber": "212000-1355",
"attributes": {"property1": null,
"property2": null
}
},
"type": "Person",
"attributes": {"property1": null,
"property2": null
}
},
"consents": [{"id": "ci_newsleter",
"checked": true,
"text": "string",
"required": true
}
],
"validations": [{"id": "oc_BaDIudFOjBEuFmLlmDExePUFTh",
"adapterId": "jetshop_adapter",
"url": "http://specific-feature-adapter.norce.io/api/v1/callbacks/orders/{order_id}/specific-callback"
}
],
"hooks": [{"id": "oc_BaDIudFOjBEuFmLlmDExePUFTh",
"adapterId": "jetshop_adapter",
"subscribeTo": "string",
"target": "string",
"invoke": "http://specific-feature-adapter.norce.io/api/v1/callbacks/orders/{order_id}/specific-callback",
"version": "v0"
}
],
"notifications": [{"id": "ocGooDddTOjKOuFmNnkEozEpfuTh",
"adapterId": "jetshop_adapter",
"reference": "PuXCudQEiWTOHvquGGolFUVOuy",
"description": "Export payment information to Jetshop when order has been completed.",
"scope": "/state/currentStatus",
"schema": {"const": "completed"
},
"invoke": "{configuration.adapter.internalUrl}/api/v1/callbacks/orders/{order.id}/specific-callback",
"version": "v0"
}
],
"total": {"includingVat": 1234,
"excludingVat": 987.2
},
"attributes": {"property1": null,
"property2": null
}
}
],
"pagination": {"offset": 0,
"limit": 0,
"size": 0,
"valueSum": 0,
"totalSize": 0
}
}