Proforma invoice detail

Request

Additional information about one proforma invoice.

This endpoint has several sections, which are only sent when requested in the include parameter (see Section on demand).

Value	Section
`surchargeParameters`	Item surcharge parameters

Security

shoptetAccessToken or shoptetPrivateApiToken

Path

codestringrequired

Example:2018000035

Query

includestring

Sections to include

Example:include=surchargeParameters

Headers

Content-Typestringrequired

Default:"application/json"

curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/proforma-invoices/2018000035?include=surchargeParameters' \
  -H 'Content-Type: application/json' \
  -H 'Shoptet-Access-Token: YOUR_API_KEY_HERE'

Responses

OK

Bodyapplication/json

dataobjectrequired

errorsArray of objects or null(Errors)required

metadataobject(Metadata)required

Response

{
  "data": {
    "proformaInvoice": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}