Commerce

Get an order

Changed on

One order with every line item, tax line and refund. Needs orders.read.

get/v1/commerce/orders/{orderId}

Request

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

Path parameters

orderIdstring required

Platform-native order id.

Query parameters

accountIdstring required

Connected store SocialAccount id.

Response

The order

Example response

{
  "order": {
    "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