List of proof payments

Request

The list of proof payments supports Paging.

Security

shoptetAccessToken or shoptetPrivateApiToken

Query

codestring

filtering according to proof payments code. Optional.

Example:code=P--2015000170-1

orderCodestring

filtering according to order code. Optional.

Example:orderCode=2015000001

proformaInvoiceCodestring

filtering according to proforma invoice code. Optional.

Example:proformaInvoiceCode=2015000170

invoiceCodestring

filtering by invoice code

Example:invoiceCode=2017100013

issueDatestring

filtering according to date on which was proof payment issued. In ISO 8601 format. Optional.

Example:issueDate=2024-12-24T15:22:02+0200

isValidboolean

filtering according to proof payments validity. Optional.

Example:isValid=true

closedboolean

filtering by proof payment closed/open

Example:closed=true

itemsPerPageinteger

Returned items per page. Default value is 20. Max value is 100.

Example:itemsPerPage=50

pageinteger

Page number to return. Default value is 1.

Example:page=3

Content-Typestringrequired

Default:"application/json"

curl -i -X GET \
  'https://api.docs.shoptet.com/_mock/shoptet-api/openapi/api/proof-payments?code=P--2015000170-1&orderCode=2015000001&proformaInvoiceCode=2015000170&invoiceCode=2017100013&issueDate=2024-12-24T15%3A22%3A02%2B0200&isValid=true&closed=true&itemsPerPage=50&page=3' \
  -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": {
    "items": [ … ],
    "paginator": { … }
  },
  "errors": [
    { … }
  ],
  "metadata": {
    "requestId": "019c8c34-64f3-7328-af43-bf1e34fa39d7"
  }
}