Query parameters

Responses

GET /external/api/orders
curl \
 -X GET https://demo.api.fygi.store/external/api/orders \
 -H "authorization: $API_KEY"
Response examples (200)
# Headers

# Payload
[
  {
    "id": "string",
    "number": "string",
    "externalId": "string",
    "orderReference": "string",
    "createdAt": "2024-05-04T09:42:00+00:00",
    "receiptSentAt": "2024-05-04T09:42:00+00:00",
    "sum": 42,
    "taxSum": 42,
    "currencyCode": "string",
    "storeId": "string",
    "customerId": "string",
    "vendingCode": "string",
    "externalStoreId": "string",
    "orderLines": [
      {
        "id": "string",
        "type": "product",
        "name": "string",
        "quantity": 42,
        "unitPrice": 42,
        "unitTaxPaid": 42,
        "totalPrice": 42,
        "totalTaxPaid": 42,
        "taxPercent": 42
      }
    ],
    "orderLineRelations": [
      {
        "orderLineId": "string",
        "relatedOrderLineId": "string",
        "type": "product",
        "sortIndex": 42
      }
    ],
    "transactions": [
      {
        "id": "string",
        "orderId": "string",
        "type": "payment",
        "status": "success",
        "createdAt": "2024-05-04T09:42:00+00:00"
      }
    ],
    "shipments": [
      {
        "id": "string",
        "fullName": "string",
        "addressLine1": "string",
        "addressLine2": "string",
        "postalCode": "string",
        "city": "string",
        "countryName": "string",
        "countryCode": "string",
        "emailAddress": "string",
        "shipmentTrackingNumber": "string",
        "shipmentTrackingLink": "string"
      }
    ],
    "adjustmentType": {
      "id": 42,
      "publicId": "string",
      "name": "string"
    }
  }
]
Response examples (200)
# Headers

# Payload
[
  {
    "id": "string",
    "number": "string",
    "externalId": "string",
    "orderReference": "string",
    "createdAt": "2024-05-04T09:42:00+00:00",
    "receiptSentAt": "2024-05-04T09:42:00+00:00",
    "sum": 42,
    "taxSum": 42,
    "currencyCode": "string",
    "storeId": "string",
    "customerId": "string",
    "vendingCode": "string",
    "externalStoreId": "string",
    "orderLines": [
      {
        "id": "string",
        "type": "product",
        "name": "string",
        "quantity": 42,
        "unitPrice": 42,
        "unitTaxPaid": 42,
        "totalPrice": 42,
        "totalTaxPaid": 42,
        "taxPercent": 42
      }
    ],
    "orderLineRelations": [
      {
        "orderLineId": "string",
        "relatedOrderLineId": "string",
        "type": "product",
        "sortIndex": 42
      }
    ],
    "transactions": [
      {
        "id": "string",
        "orderId": "string",
        "type": "payment",
        "status": "success",
        "createdAt": "2024-05-04T09:42:00+00:00"
      }
    ],
    "shipments": [
      {
        "id": "string",
        "fullName": "string",
        "addressLine1": "string",
        "addressLine2": "string",
        "postalCode": "string",
        "city": "string",
        "countryName": "string",
        "countryCode": "string",
        "emailAddress": "string",
        "shipmentTrackingNumber": "string",
        "shipmentTrackingLink": "string"
      }
    ],
    "adjustmentType": {
      "id": 42,
      "publicId": "string",
      "name": "string"
    }
  }
]