Basic information

GET /{shopId}/orders/{orderId}/documents

Returns finalized invoice and credit note order documents by orderId.

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
orderId string
Required: true

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
includePdf boolean

Returns the pdf content via the attribute documentPdf.

Required: false

Response attributes

Name Type Description
results

integer

The number of order documents in total. An order can have zero or more documents.

page

integer

The page number on which the order document appears.

resultsPerPage

integer

The number of order documents returned per page.

items

array of orderDocument

The list of all order documents.

Response

HTTP 200

Media type application/json

{
  "results": 2,
  "page": 1,
  "resultsPerPage": 10,
  "items": [
    {
      "orderId": "59EE0CE3-88F1-B9F4-B42B-AC1732093966",
      "documentType": "CreditNote",
      "documentNumber": "1002",
      "issueDate": "2017-12-11T06:15:00.000Z",
      "creationDate": "2017-12-07T16:08:53.000Z",
      "address": {
        "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,
        "addressExtension": null,
        "bankAccountHolder": null,
        "bankAccountNumber": null,
        "bankName": null,
        "bankSortCode": null,
        "businessEmailAddress": null,
        "businessPhoneNumber": null,
        "department": null,
        "displayName": "Aaron Grady",
        "doorCode": null,
        "faxNumber": null,
        "fiscalCode": null,
        "gender": "MALE",
        "jobTitle": null,
        "middleName": null,
        "mobilePhoneNumber": null,
        "phoneNumber": null,
        "privateEmailAddress": null,
        "privatePhoneNumber": null,
        "websiteUrl": null,
        "emailAddress": "aaron@example.com"
    },
      "lineItemContainer": {
        "grandTotal": {
          "taxType": "GROSS",
          "formatted": "23.95 €",
          "amount": 23.95,
          "currency": "EUR"
        },
        "totalBeforeTax": {
          "taxType": "NET",
          "formatted": "20.13 €",
          "amount": 20.13,
          "currency": "EUR"
        },
        "totalTax": {
          "taxType": "NONE",
          "formatted": "3.82 €",
          "amount": 3.82,
          "currency": "EUR"
        },
        "lineItemsSubTotal": {
          "taxType": "GROSS",
          "formatted": "16.95 €",
          "amount": 16.95,
          "currency": "EUR"
        },
        "productLineItems": [
          {
            "lineItemId": "59EE1415-D3BC-2245-FF05-AC173209A41B",
            "sku": "HP-001-0006",
            "name": "Dr.Boom - Red Bass",
            "productId": "54EAF9A4-37D7-159F-3307-0A0C05E6CFE7",
            "quantity": {
              "amount": 1,
              "unit": "piece(s)"
            },
            "lineItemPrice": {
              "taxType": "GROSS",
              "formatted": "199.99 €",
              "amount": 199.99,
              "currency": "EUR"
            },
            "singleItemPrice": {
              "taxType": "GROSS",
              "formatted": "199.99 €",
              "amount": 199.99,
              "currency": "EUR"
            },
            "lineItemCouponDiscount": {
                    "taxType": "GROSS",
                    "formatted": "1.70 €",
                    "amount": 1.7,
                    "currency": "EUR"
            },
            "images": [
              {
                "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/EE97/FD85/1B66/9962/AC14/145F/A540/001-headphone-blue_h.jpg",
                "classifier": "HotDeal"
              },
              {
                "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/EE97/FD85/1B66/9962/AC14/145F/A540/001-headphone-blue.jpg",
                "classifier": "Large"
              },
              {
                "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/EE97/FD85/1B66/9962/AC14/145F/A540/001-headphone-blue_m.jpg",
                "classifier": "Medium"
              },
              {
                "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/EE97/FD85/1B66/9962/AC14/145F/A540/001-headphone-blue_s.jpg",
                "classifier": "Small"
              },
              {
                "url": "https://pm.epages.com/WebRoot/Store/Shops/apidocu/51E7/EE97/FD85/1B66/9962/AC14/145F/A540/001-headphone-blue_xs.jpg",
                "classifier": "Thumbnail"
              }
            ],
            "links": [
              {
                "rel": "product",
                "href": "https://pm.epages.com/rs/shops/apidocu/products/54EAF9A4-37D7-159F-3307-0A0C05E6CFE7"
              },
              {
                "rel": "taxClass",
                "href": "https://pm.epages.com/rs/shops/apidocu/tax-classes/5446685F-A8AF-0E18-9B4F-D5809AB30FBF"
              }
            ],
            "variationString": "Colour: blue",
            "essentialFeatures": null,
            "taxClass": {
              "taxClassId": "59EE0BE7-E17B-3BE8-FA13-AC1732095858",
              "name": "standard",
              "percentage": 19
            },
            "deliveryWeight": {
              "amount": 250,
              "unit": "g"
            }
          }
        ],
        "couponLineItem": null,
        "shippingPrice": {
          "taxType": "GROSS",
          "formatted": "7.00 €",
          "amount": 7,
          "currency": "EUR"
        },
        "deposits": [],
        "ecoParticipations": [],
        "shippingOptions": [],
        "basketDiscount": {
          "links": []
        }
      },
      "documentPdf": "JVBERi0xLjQKJeLjz9MKNCAxzuTYgMCBSL1NpemUgMTg+PgpzdGFydHhyZWYKMzgwMTIKJSVFT0YK",
      "links": [
        {
          "rel": "order",
          "href": "https://pm.epages.com/rs/shops/apidocu/orders/59EE0CE3-88F1-B9F4-B42B-AC1732093966"
        }
      ]
    },
    {
      "orderId": "59EE0CE3-88F1-B9F4-B42B-AC1732093966",
      "documentType": "Invoice",
      "documentNumber": "1001",
      "issueDate": "2017-12-13T06:15:00.000Z",
      "creationDate": "2017-10-07T16:08:46.000Z",
      "address": {
        "company": null,
        "salutation": null,
        "firstName": "Doris",
        "lastName": "Daisy",
        "street": "Daisy Road 2",
        "streetDetails": null,
        "zipCode": "87956",
        "city": "Daisyland",
        "state": null,
        "country": "DE",
        "title": null,
        "vatId": null,
        "birthday": null,
        "addressExtension": "1.Floor",
        "bankAccountHolder": "Doris Daisy",
        "bankAccountNumber": "UA1567379838510",
        "bankName": "Daisyland Bank",
        "bankSortCode": "XXDAISBB",
        "businessEmailAddress": "daisy@land.com",
        "businessPhoneNumber": "0065099906543",
        "department": null,
        "displayName": null,
        "doorCode": null,
        "faxNumber": "0065099906545",
        "fiscalCode": null,
        "gender": "FEMALE",
        "jobTitle": "Business Manager",
        "middleName": null,
        "mobilePhoneNumber": "0012066876500",
        "phoneNumber": "0012066876500",
        "privateEmailAddress": null,
        "privatePhoneNumber": null,
        "websiteUrl": "http://example.com",
        "emailAddress": "daisy@example.com"
      },
      "lineItemContainer": {
        "grandTotal": {
          "taxType": "GROSS",
          "formatted": "96.90 €",
          "amount": 96.9,
          "currency": "EUR"
        },
        "totalBeforeTax": {
          "taxType": "NET",
          "formatted": "81.43 €",
          "amount": 81.43,
          "currency": "EUR"
        },
        "totalTax": {
          "taxType": "NONE",
          "formatted": "15.47 €",
          "amount": 15.47,
          "currency": "EUR"
        },
        "lineItemsSubTotal": {
          "taxType": "GROSS",
          "formatted": "89.90 €",
          "amount": 89.9,
          "currency": "EUR"
        },
        "productLineItems": [
          {
            "lineItemId": "59EE140E-3264-F898-CD74-AC173209A4B8",
            "sku": "HP-002-0003",
            "name": "Dr.Boom Silver Ed.",
            "productId": "59EE0CDE-6C9F-13F4-A92B-AC173209394E",
            "quantity": {
              "amount": 1,
              "unit": "piece(s)"
            },
            "lineItemPrice": {
              "taxType": "GROSS",
              "formatted": "72.95 €",
              "amount": 72.95,
              "currency": "EUR"
            },
            "singleItemPrice": {
              "taxType": "GROSS",
              "formatted": "72.95 €",
              "amount": 72.95,
              "currency": "EUR"
            },
            "lineItemCouponDiscount": null,
            "images": [
              {
                "url": "https://pm.epages.com/rs/shops/apidocu/Products/lt_0401107001/lt_0401107001_h.jpg",
                "classifier": "HotDeal"
              },
              {
                "url": "https://pm.epages.com/rs/shops/apidocu/Products/lt_0401107001/lt_0401107001_1.jpg",
                "classifier": "Large"
              },
              {
                "url": "https://pm.epages.com/rs/shops/apidocu/Products/lt_0401107001/lt_0401107001_1_m.jpg",
                "classifier": "Medium"
              },
              {
                "url": "https://pm.epages.com/rs/shops/apidocu/Products/lt_0401107001/lt_0401107001_1_s.jpg",
                "classifier": "Small"
              },
              {
                "url": "https://pm.epages.com/rs/shops/apidocu/Products/lt_0401107001/lt_0401107001_1_xs.jpg",
                "classifier": "Thumbnail"
              }
            ],
            "links": [
              {
                "rel": "product",
                "href": "https://pm.epages.com/rs/shops/apidocu/products/59EE0CDE-6C9F-13F4-A92B-AC173209394E"
              },
              {
                "rel": "taxClass",
                "href": "https://pm.epages.com/rs/shops/apidocu/tax-classes/59EE0BE7-E17B-3BE8-FA13-AC1732095858"
              }
            ],
            "variationString": null,
            "essentialFeatures": null,
            "taxClass": {
              "taxClassId": "59EE0BE7-E17B-3BE8-FA13-AC1732095858",
              "name": "standard",
              "percentage": 19
            },
            "deliveryWeight": null
          },
          {
            "lineItemId": "59EE140F-9445-AAE7-1018-AC173209A486",
            "sku": "hm_0100401001",
            "name": "Mag-Lite Mini",
            "productId": "59EE0CDE-8B1B-6466-4EB8-AC1732093959",
            "quantity": {
              "amount": 1,
              "unit": "piece(s)"
            },
            "lineItemPrice": {
              "taxType": "GROSS",
              "formatted": "16.95 €",
              "amount": 16.95,
              "currency": "EUR"
            },
            "singleItemPrice": {
              "taxType": "GROSS",
              "formatted": "16.95 €",
              "amount": 16.95,
              "currency": "EUR"
            },
            "lineItemCouponDiscount": null,
            "images": [
              {
                "url": "https://pm.epages.com/rs/shops/apidocu/Products/hm_0100401001/hm_0100401001_h.jpg",
                "classifier": "HotDeal"
              },
              {
                "url": "https://pm.epages.com/rs/shops/apidocu/Products/hm_0100401001/hm_0100401001.jpg",
                "classifier": "Large"
              },
              {
                "url": "https://pm.epages.com/rs/shops/apidocu/Products/hm_0100401001/hm_0100401001_m.jpg",
                "classifier": "Medium"
              },
              {
                "url": "https://pm.epages.com/rs/shops/apidocu/Products/hm_0100401001/hm_0100401001_s.jpg",
                "classifier": "Small"
              },
              {
                "url": "https://pm.epages.com/rs/shops/apidocu/Products/hm_0100401001/hm_0100401001_xs.jpg",
                "classifier": "Thumbnail"
              }
            ],
            "links": [
              {
                "rel": "product",
                "href": "https://pm.epages.com/rs/shops/apidocu/products/59EE0CDE-8B1B-6466-4EB8-AC1732093959"
              },
              {
                "rel": "taxClass",
                "href": "https://pm.epages.com/rs/shops/apidocu/tax-classes/59EE0BE7-E17B-3BE8-FA13-AC1732095858"
              }
            ],
            "variationString": null,
            "essentialFeatures": null,
            "taxClass": {
              "taxClassId": "59EE0BE7-E17B-3BE8-FA13-AC1732095858",
              "name": "standard",
              "percentage": 19
            },
            "deliveryWeight": null
          }
        ],
        "couponLineItem": null,
        "shippingPrice": {
          "taxType": "GROSS",
          "formatted": "7.00 €",
          "amount": 7,
          "currency": "EUR"
        },
        "deposits": [],
        "ecoParticipations": [],
        "shippingOptions": [],
        "basketDiscount": {
          "links": []
        }
      },
      "documentPdf": "ABERIXi0xLjQKJeLjz9MKNCAxzuTYgMCBSL1NpemUgMTg+PgpzdGFydHhyYKMzgwMTIKJSVFT1ZL",
      "links": [
        {
          "rel": "order",
          "href": "https://pm.epages.com/rs/shops/apidocu/orders/59EE0CE3-88F1-B9F4-B42B-AC1732093966"
        }
      ]
    }
  ]
}