GET /external/api/orders

GET /external/api/orders
Authorization key

Query parameters

  • after string(date-time)
  • storeId string(uuid)
  • before string(date-time)
  • PageNumber integer(int32)

    Minimum value is 1, maximum value is 2147483647.

  • PageSize integer(int32)

    Minimum value is 1, maximum value is 250.

Responses

  • 200

    Success

    Hide headers attribute Show headers attribute
    • X-Pagination

      meta-data

    Hide response attributes Show response attributes object
    • id string(uuid)
    • number string | null
    • externalId string | null
    • orderReference string | null
    • createdAt string(date-time) | null
    • receiptSentAt string(date-time) | null
    • sum integer(int32)
    • taxSum integer(int32)
    • currencyCode string | null
    • storeId string(uuid)
    • customerId string(uuid)
    • vendingCode string | null
    • externalStoreId string | null
    • orderLines array[object] | null
      Hide orderLines attributes Show orderLines attributes object
      • id string(uuid)
      • type string

        Values are product, campaign, egProduct, or egCampaign.

      • name string | null
      • quantity integer(int32)
      • unitPrice integer(int32)
      • unitTaxPaid integer(int32)
      • totalPrice integer(int32)
      • totalTaxPaid integer(int32)
      • taxPercent integer(int32)
      • Additional properties are NOT allowed
    • orderLineRelations array[object] | null
      Hide orderLineRelations attributes Show orderLineRelations attributes object
      • orderLineId string(uuid)
      • relatedOrderLineId string(uuid)
      • type string

        Values are product, campaign, egProduct, or egCampaign.

      • sortIndex integer(int32)
      • Additional properties are NOT allowed
    • transactions array[object] | null
      Hide transactions attributes Show transactions attributes object
      • id string(uuid)
      • orderId string(uuid)
      • type string

        Values are payment, refund, remoteTaxControl, shipment, or delivery.

      • status string

        Values are success, failed, or pending.

      • createdAt string(date-time)
      • Additional properties are NOT allowed
    • shipments array[object] | null
      Hide shipments attributes Show shipments attributes object
      • id string(uuid)
      • fullName string | null
      • addressLine1 string | null
      • addressLine2 string | null
      • postalCode string | null
      • city string | null
      • countryName string | null
      • countryCode string | null
      • emailAddress string | null
      • shipmentTrackingNumber string | null
      • shipmentTrackingLink string | null
      • Additional properties are NOT allowed
    • adjustmentType object
      Hide adjustmentType attributes Show adjustmentType attributes object
      • id integer(int32)
      • publicId string(uuid)
      • name string | null
      • Additional properties are NOT allowed
    • Additional properties are NOT allowed
    Hide response attributes Show response attributes object
    • id string(uuid)
    • number string | null
    • externalId string | null
    • orderReference string | null
    • createdAt string(date-time) | null
    • receiptSentAt string(date-time) | null
    • sum integer(int32)
    • taxSum integer(int32)
    • currencyCode string | null
    • storeId string(uuid)
    • customerId string(uuid)
    • vendingCode string | null
    • externalStoreId string | null
    • orderLines array[object] | null
      Hide orderLines attributes Show orderLines attributes object
      • id string(uuid)
      • type string

        Values are product, campaign, egProduct, or egCampaign.

      • name string | null
      • quantity integer(int32)
      • unitPrice integer(int32)
      • unitTaxPaid integer(int32)
      • totalPrice integer(int32)
      • totalTaxPaid integer(int32)
      • taxPercent integer(int32)
      • Additional properties are NOT allowed
    • orderLineRelations array[object] | null
      Hide orderLineRelations attributes Show orderLineRelations attributes object
      • orderLineId string(uuid)
      • relatedOrderLineId string(uuid)
      • type string

        Values are product, campaign, egProduct, or egCampaign.

      • sortIndex integer(int32)
      • Additional properties are NOT allowed
    • transactions array[object] | null
      Hide transactions attributes Show transactions attributes object
      • id string(uuid)
      • orderId string(uuid)
      • type string

        Values are payment, refund, remoteTaxControl, shipment, or delivery.

      • status string

        Values are success, failed, or pending.

      • createdAt string(date-time)
      • Additional properties are NOT allowed
    • shipments array[object] | null
      Hide shipments attributes Show shipments attributes object
      • id string(uuid)
      • fullName string | null
      • addressLine1 string | null
      • addressLine2 string | null
      • postalCode string | null
      • city string | null
      • countryName string | null
      • countryCode string | null
      • emailAddress string | null
      • shipmentTrackingNumber string | null
      • shipmentTrackingLink string | null
      • Additional properties are NOT allowed
    • adjustmentType object
      Hide adjustmentType attributes Show adjustmentType attributes object
      • id integer(int32)
      • publicId string(uuid)
      • name string | null
      • Additional properties are NOT allowed
    • Additional properties are NOT allowed
    Hide response attributes Show response attributes object
    • id string(uuid)
    • number string | null
    • externalId string | null
    • orderReference string | null
    • createdAt string(date-time) | null
    • receiptSentAt string(date-time) | null
    • sum integer(int32)
    • taxSum integer(int32)
    • currencyCode string | null
    • storeId string(uuid)
    • customerId string(uuid)
    • vendingCode string | null
    • externalStoreId string | null
    • orderLines array[object] | null
      Hide orderLines attributes Show orderLines attributes object
      • id string(uuid)
      • type string

        Values are product, campaign, egProduct, or egCampaign.

      • name string | null
      • quantity integer(int32)
      • unitPrice integer(int32)
      • unitTaxPaid integer(int32)
      • totalPrice integer(int32)
      • totalTaxPaid integer(int32)
      • taxPercent integer(int32)
      • Additional properties are NOT allowed
    • orderLineRelations array[object] | null
      Hide orderLineRelations attributes Show orderLineRelations attributes object
      • orderLineId string(uuid)
      • relatedOrderLineId string(uuid)
      • type string

        Values are product, campaign, egProduct, or egCampaign.

      • sortIndex integer(int32)
      • Additional properties are NOT allowed
    • transactions array[object] | null
      Hide transactions attributes Show transactions attributes object
      • id string(uuid)
      • orderId string(uuid)
      • type string

        Values are payment, refund, remoteTaxControl, shipment, or delivery.

      • status string

        Values are success, failed, or pending.

      • createdAt string(date-time)
      • Additional properties are NOT allowed
    • shipments array[object] | null
      Hide shipments attributes Show shipments attributes object
      • id string(uuid)
      • fullName string | null
      • addressLine1 string | null
      • addressLine2 string | null
      • postalCode string | null
      • city string | null
      • countryName string | null
      • countryCode string | null
      • emailAddress string | null
      • shipmentTrackingNumber string | null
      • shipmentTrackingLink string | null
      • Additional properties are NOT allowed
    • adjustmentType object
      Hide adjustmentType attributes Show adjustmentType attributes object
      • id integer(int32)
      • publicId string(uuid)
      • name string | null
      • Additional properties are NOT allowed
    • Additional properties are NOT allowed
GET /external/api/orders 
curl \
 --request GET 'http://test.api.fygi.store/external/api/orders' \
 --header "authorization: $API_KEY"
Response examples (200) 
# Headers

# Payload
[
  {
    "id": "string",
    "number": "string",
    "externalId": "string",
    "orderReference": "string",
    "createdAt": "2025-05-04T09:42:00Z",
    "receiptSentAt": "2025-05-04T09:42:00Z",
    "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": "2025-05-04T09:42:00Z"
      }
    ],
    "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": "2025-05-04T09:42:00Z",
    "receiptSentAt": "2025-05-04T09:42:00Z",
    "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": "2025-05-04T09:42:00Z"
      }
    ],
    "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"
    }
  }
]