Basic information

GET /{shopId}/orders

Returns a list of orders. By default the results for orders are sorted by creationDate.

Authorisation

OAuth 2.0 Token required with scopes:

orders_read

URI parameters

Name Type Description
shopId string

The unique identifier of the shop.

Required: true
Example: DemoShop

Query parameters

Name Type Description
locale string

Represents the language code according to ISO 639-1 and the country code according to ISO 3166-1. If not provided, the shop’s default language is used. We recommend to always send this parameter with your request. If the default language had been changed in the administration, it might take up to 1 day until this change affects the shop.

Required: false
Example: en_US
page integer

Represents the current page.

Required: false
Default: 1
Minimum: 1
resultsPerPage integer

Specifies the maximum number of results per page.

Required: false
Default: 10
Maximum: 100
viewedOn boolean

Returns orders where the status Viewed is set.

Required: false
pendingOn boolean

Returns orders where the status Pending is set.

Required: false
archivedOn boolean

Returns orders where the status Archived is set.

Required: false
rejectedOn boolean

Returns orders where the status Rejected is set.

Required: false
closedOn boolean

Returns orders where the status Closed is set.

Required: false
dispatchedOn boolean

Returns orders where the status Dispatched is set.

Required: false
paidOn boolean

Returns orders where the status Paid is set.

Required: false
returnedOn boolean

Returns orders where the status Returned is set.

Required: false
deliveredOn boolean

Returns orders where the status Delivered is set.

Required: false
invoicedOn boolean

Returns orders where the status Invoiced is set.

Required: false
lastUpdated boolean

Sort by last updated orders.

Required: false
customerId string

The unique identifier of the customer.

Required: false
productId string

The unique identifier of the product.

Required: false
updatedFrom string

Filters updated orders from this timestamp (format according to ISO 8601).

Orders with edited product line items (quantity or price), added or removed product line items, changed shipping or payment method, changed billing address, finalized order documents as well as changed, added or removed shipping address are also included when using this query parameter.

Required: false
createdBefore string

Filters orders created before this timestamp (format according to ISO 8601). The maximum time frame for displaying orders is 1 year. If no filter is set, all orders will be displayed.

Required: false
createdAfter string

Filters orders created after this timestamp (format according to ISO 8601). The maximum time frame for displaying orders is 1 year. If no filter is set, all orders will be displayed.

Required: false
currency string

Represents the currency code for the order according to ISO 4217.

Required: false

Response attributes

Name Type Description
results

integer

The number of orders in total.

page

integer

The page number on which the order appears.

resultsPerPage

integer

The number of orders returned per page.

items

array of order

The list of all orders.

Response

HTTP 200

Media type application/json

{
  "results": 3,
  "page": 1,
  "resultsPerPage": 10,
  "items": [
    {
      "orderId": "5639C509-092F-7704-77D3-D5809AB321D8",
      "orderNumber": "ORD151104/1033",
      "creationDate": "2015-11-04T08:42:49.000Z",
      "billingAddress": {
        "company": "Boehm-Jacobs",
        "salutation": null,
        "firstName": "Walter",
        "lastName": "Ankunding",
        "street": "Barrows Mountain 8",
        "streetDetails": null,
        "zipCode": "W11 1ET",
        "city": "London",
        "state": null,
        "country": "GB",
        "title": null,
        "vatId": null,
        "birthday": "1975-11-08",
        "emailAddress": "Ankunding@bj.com",
        "addressExtension": "1.Floor",
        "bankAccountHolder": "Walter Ankunding",
        "bankAccountNumber": "UK2677379838510",
        "bankName": "Lunaview Bank",
        "bankSortCode": "XXLUNBB",
        "businessEmailAddress": "Ankunding@bj.com",
        "businessPhoneNumber": "0045099906567",
        "department": null,
        "displayName": null,
        "doorCode": null,
        "faxNumber": "0045099906568",
        "fiscalCode": null,
        "gender": "MALE",
        "jobTitle": "Manager",
        "middleName": null,
        "mobilePhoneNumber": "0045099906567",
        "phoneNumber": "0045099906567",
        "privateEmailAddress": null,
        "privatePhoneNumber": null,
        "websiteUrl": "http://bj.com"
      },
      "shippingAddress": null,
      "shippingData": {
        "shippingMethod": {
          "id": "5171DD86-C077-0726-C448-AC14145F9026",
          "name": "Standard delivery"
        },
        "price": {
          "taxType": "GROSS",
          "formatted": "7.63 €",
          "amount": 7.63,
          "currency": "EUR"
        },
        "taxes": [
          {
            "taxClass": {
              "taxClassId": "5446685F-A8AF-0E18-9B4F-D5809AB30FBF",
              "name": "standard",
              "percentage": 0
            },
            "price": {
              "taxType": "NONE",
              "formatted": "0.00 €",
              "amount": 0,
              "currency": "EUR"
            }
          }
        ]
      },
      "paymentData": {
        "paymentMethod": {
          "id": "5171DD86-0714-8E9B-B079-AC14145F900F",
          "name": "Payment in advance",
          "providerName": "null"          
        },
        "transactionId": "null",
        "price": {
          "taxType": "GROSS",
          "formatted": "0.00 €",
          "amount": 0,
          "currency": "EUR"
        },
        "status": null,
        "taxes": null
      },
      "invoicedOn": null,
      "partiallyPaidOn": null,
      "deliveredOn": null,
      "partiallyInvoicedOn": null,
      "pendingOn": null,
      "readyForDispatchOn": null,
      "partiallyDispatchedOn": null,
      "archivedOn": null,
      "dispatchedOn": null,
      "viewedOn": "2015-11-04T11:45:07.000Z",
      "customerNumber": "1031",
      "customerId": "56389403-55BC-176C-5343-D5809AB3A579",
      "locale": null,
      "currencyId": "EUR",
      "taxModel": "GROSS",
      "grandTotal": "250.94",
      "totalBeforeTax": "250.94",
      "totalTax": "0",
      "customerComment": null,
      "internalNote": null,
      "rejectedOn": null,
      "inProcessOn": null,
      "closedOn": null,
      "paidOn": "2016-01-20T07:23:47.000Z",
      "returnedOn": null,
      "links": [
        {
          "rel": "self",
          "href": "https://pm.epages.com/rs/shops/apidocu/orders/5639C509-092F-7704-77D3-D5809AB321D8"
        },
        {
          "rel": "customer",
          "href": "https://pm.epages.com/rs/shops/apidocu/customers/56389403-55BC-176C-5343-D5809AB3A579"
        },
        {
          "rel": "shipping-method",
          "href": "https://pm.epages.com/rs/shops/apidocu/shipping-methods/5171DD86-C077-0726-C448-AC14145F9026"
        }
      ]
    },
    {
      "orderId": "5639C473-4265-5299-FDE2-D5809AB36284",
      "orderNumber": "ORD151104/1032",
      "creationDate": "2015-11-04T08:40:17.000Z",
      "customerId": "563874DA-7AE7-9876-9E59-D5809AB38A25",
      "customerNumber": "1027",
      "locale": "de_DE",
      "currencyId": "EUR",
      "taxModel": "GROSS",
      "grandTotal": "9.99",
      "totalBeforeTax": "8.39",
      "totalTax": "1.6",
      "customerComment": "I need the product asap",
      "internalNote": "Tracking code:YAZUN7989",
      "billingAddress": {
        "company": "Schneiderei",
        "salutation": "Mrs",
        "firstName": "Tanja",
        "lastName": "Schneider",
        "street": "Schneiderstraße 10",
        "streetDetails": null,
        "zipCode": "12345",
        "city": "Berlin",
        "state": null,
        "country": "DE",
        "title": null,
        "vatId": null,
        "birthday": null,
        "emailAddress": "schneider@schneiderei.de",
        "addressExtension": "1.Etage",
        "bankAccountHolder": "Tanja Schneider",
        "bankAccountNumber": "DE1567379838510",
        "bankName": "Nadel Bank",
        "bankSortCode": "XXSCSBB",
        "businessEmailAddress": "schneider@schneiderei.de",
        "businessPhoneNumber": "0049099906543",
        "department": null,
        "displayName": null,
        "doorCode": null,
        "faxNumber": "0049099906542",
        "fiscalCode": null,
        "gender": "female",
        "jobTitle": "Schneiderin",
        "middleName": null,
        "mobilePhoneNumber": "0049099906543",
        "phoneNumber": "0049099906543",
        "privateEmailAddress": null,
        "privatePhoneNumber": null,
        "websiteUrl": "http://schneiderei.de"
      },
      "shippingAddress": null,
      "shippingData": null,
      "paymentData": {
        "paymentMethod": {
          "id": "5171DD86-0714-8E9B-B079-AC14145F900F",
          "name": "Payment in advance"
        },
        "price": {
          "taxType": "GROSS",
          "formatted": "0.00 €",
          "amount": 0,
          "currency": "EUR"
        },
        "status": null,
        "taxes": null
      },
      "viewedOn": "2015-11-04T08:41:35.000Z",
      "rejectedOn": null,
      "inProcessOn": null,
      "pendingOn": null,
      "readyForDispatchOn": null,
      "partiallyDispatchedOn": null,
      "dispatchedOn": "2015-11-04T08:41:35.000Z",
      "deliveredOn": "2015-11-04T08:41:35.000Z",
      "partiallyInvoicedOn": null,
      "invoicedOn": null,
      "partiallyPaidOn": null,
      "paidOn": "2015-11-04T08:41:35.000Z",
      "returnedOn": null,
      "closedOn": null,
      "archivedOn": null,
      "links": [
        {
          "rel": "self",
          "href": "https://pm.epages.com/rs/shops/apidocu/orders/5639C473-4265-5299-FDE2-D5809AB36284"
        },
        {
          "rel": "customer",
          "href": "https://pm.epages.com/rs/shops/apidocu/customers/563874DA-7AE7-9876-9E59-D5809AB38A25"
        }
      ]
    },
    {
      "orderId": "5638C3E4-03B6-9023-DE5B-D5809AB3777D",
      "orderNumber": "ORD151103/1031",
      "creationDate": "2015-11-03T14:25:40.000Z",
      "customerId": "5638A1B2-0580-CA34-5DB3-D5809AB3A51C",
      "customerNumber": "1029",
      "locale": "de_DE",
      "currencyId": "EUR",
      "taxModel": "GROSS",
      "grandTotal": "196.05",
      "totalBeforeTax": "196.05",
      "totalTax": "0",
      "customerComment": "Please deliver asap.",
      "internalNote": null,
      "billingAddress": {
        "company": "Ryan and Sons",
        "salutation": "Mr",
        "firstName": "Aaron",
        "lastName": "Grady",
        "street": "Ardith Route 2",
        "streetDetails": null,
        "zipCode": "16772-2059",
        "city": "Buckborough",
        "state": "GA",
        "country": "US",
        "title": "PhD",
        "vatId": null,
        "birthday": null,
        "emailAddress": "aaron@RyanandSons.com",
        "addressExtension": "Backyard",
        "bankAccountHolder": "Aaron Grady",
        "bankAccountNumber": "US2677379838510",
        "bankName": "Buckborough Bank",
        "bankSortCode": "XXBUBB",
        "businessEmailAddress": "aaron@RyanandSons.com",
        "businessPhoneNumber": "0045099977567",
        "department": null,
        "displayName": null,
        "doorCode": null,
        "faxNumber": "0045099977568",
        "fiscalCode": null,
        "gender": "male",
        "jobTitle": "Manager",
        "middleName": null,
        "mobilePhoneNumber": "0045099977567",
        "phoneNumber": "0045099977567",
        "privateEmailAddress": null,
        "privatePhoneNumber": null,
        "websiteUrl": "http://RyanandSons.com"
      },
      "shippingAddress": null,
      "shippingData": {
        "shippingMethod": {
          "id": "5171DD86-C077-0726-C448-AC14145F9026",
          "name": "Standard delivery"
        },
        "price": {
          "taxType": "GROSS",
          "formatted": "7.32 €",
          "amount": 7.32,
          "currency": "EUR"
        },
        "taxes": [
          {
            "taxClass": {
              "taxClassId": "5446685F-A8AF-0E18-9B4F-D5809AB30FBF",
              "name": "standard",
              "percentage": 0
            },
            "price": {
              "taxType": "NONE",
              "formatted": "0.00 €",
              "amount": 0,
              "currency": "EUR"
            }
          }
        ]
      },
      "paymentData": {
        "paymentMethod": {
          "id": "5171DD86-0714-8E9B-B079-AC14145F900F",
          "name": "Payment in advance"
        },
        "price": {
          "taxType": "GROSS",
          "formatted": "0.00 €",
          "amount": 0,
          "currency": "EUR"
        },
        "status": null,
        "taxes": null
      },
      "viewedOn": "2015-11-03T14:48:50.000Z",
      "rejectedOn": null,
      "inProcessOn": null,
      "pendingOn": null,
      "readyForDispatchOn": null,
      "partiallyDispatchedOn": null,
      "dispatchedOn": null,
      "deliveredOn": null,
      "partiallyInvoicedOn": null,
      "invoicedOn": null,
      "partiallyPaidOn": null,
      "paidOn": null,
      "returnedOn": null,
      "closedOn": null,
      "archivedOn": null,
      "links": [
        {
          "rel": "self",
          "href": "https://pm.epages.com/rs/shops/apidocu/orders/5638C3E4-03B6-9023-DE5B-D5809AB3777D"
        },
        {
          "rel": "customer",
          "href": "https://pm.epages.com/rs/shops/apidocu/customers/5638A1B2-0580-CA34-5DB3-D5809AB3A51C"
        },
        {
          "rel": "shipping-method",
          "href": "https://pm.epages.com/rs/shops/apidocu/shipping-methods/5171DD86-C077-0726-C448-AC14145F9026"
        }
      ]
    }
  ]
}