Commerce

List orders

Changed on

The store's orders in one format for every platform, with what an invoice needs: line items with unit prices, discounts and tax per line, shipping and fee lines, billing details, payment status and refunds. Newest order first; with updatedAfter, oldest change first, so a sync can page forward from its last seen updatedAt. Start each sync a few minutes before the last updatedAt you saw and drop duplicates by id, since an order edited while you page can shift the list. Shopify returns at most 25 orders per page and, unless the store was granted access to all orders, only the last 60 days. Buyer fields (customer and addresses) are null when the store's approval does not cover buyer data. Needs orders.read.

get/v1/commerce/orders

Request

  • Base URL: https://zernio.com/api
  • URL: https://zernio.com/api/v1/commerce/orders
  • Auth: HTTP bearer

Query parameters

accountIdstring required

Connected store SocialAccount id.

limitinteger
cursorstring
createdAfterstring date-time
createdBeforestring date-time
updatedAfterstring date-time

Only orders changed after this time, oldest change first.

Response

Orders listed

nextCursorstring nullable

Example response

{
  "orders": [
    {
      "number": "#1001",
      "currency": "EUR",
      "subtotal": {
        "amount": "19.90",
        "currency": "USD"
      },
      "discountTotal": {
        "amount": "19.90",
        "currency": "USD"
      },
      "shippingTotal": {
        "amount": "19.90",
        "currency": "USD"
      },
      "taxTotal": {
        "amount": "19.90",
        "currency": "USD"
      },
      "total": {
        "amount": "19.90",
        "currency": "USD"
      },
      "refundedTotal": {
        "amount": "19.90",
        "currency": "USD"
      },
      "lineItems": [
        {
          "unitPrice": {
            "amount": "19.90",
            "currency": "USD"
          },
          "subtotal": {
            "amount": "19.90",
            "currency": "USD"
          },
          "discountTotal": {
            "amount": "19.90",
            "currency": "USD"
          },
          "total": {
            "amount": "19.90",
            "currency": "USD"
          },
          "taxLines": [
            {
              "title": "TVA 20%",
              "amount": {
                "amount": "19.90",
                "currency": "USD"
              }
            }
          ]
        }
      ],
      "shippingLines": [
        {
          "amount": {
            "amount": "19.90",
            "currency": "USD"
          },
          "discountTotal": {
            "amount": "19.90",
            "currency": "USD"
          },
          "taxLines": [
            {
              "title": "TVA 20%",
              "amount": {
                "amount": "19.90",
                "currency": "USD"
              }
            }
          ]
        }
      ],
      "feeLines": [
        {
          "amount": {
            "amount": "19.90",
            "currency": "USD"
          },
          "discountTotal": {
            "amount": "19.90",
            "currency": "USD"
          },
          "taxLines": [
            {
              "title": "TVA 20%",
              "amount": {
                "amount": "19.90",
                "currency": "USD"
              }
            }
          ]
        }
      ],
      "taxLines": [
        {
          "title": "TVA 20%",
          "amount": {
            "amount": "19.90",
            "currency": "USD"
          }
        }
      ],
      "refunds": [
        {
          "amount": {
            "amount": "19.90",
            "currency": "USD"
          },
          "lineItems": [
            {
              "amount": {
                "amount": "19.90",
                "currency": "USD"
              }
            }
          ]
        }
      ]
    }
  ]
}

Changes