Skip to main content
GET
/
stores
/
{storeId}
/
orders
/
{orderId}
Get order by ID
curl --request GET \
  --url https://api.komerza.com/stores/{storeId}/orders/{orderId} \
  --header 'Authorization: Bearer <token>'
{
  "success": true,
  "message": "<string>",
  "code": "<string>",
  "data": {
    "order": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "items": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "dateCreated": "2023-11-07T05:31:56Z",
          "productName": "<string>",
          "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "variantName": "<string>",
          "amount": 123,
          "lineTotal": 123,
          "additionalFeePercentage": 123,
          "additionalFeeAmount": 123,
          "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "quantity": 123
        }
      ],
      "gatewayMetadata": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "transactionId": "<string>",
        "clientSecret": "<string>",
        "note": "<string>",
        "cryptocurrencyAddress": "<string>",
        "cryptocurrencyAmount": 123,
        "cryptocurrencyExpiration": "2023-11-07T05:31:56Z"
      },
      "customer": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "countryCode": "<string>",
        "emailAddress": "<string>",
        "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "externalLogins": [
          {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "dateCreated": "2023-11-07T05:31:56Z",
            "application": "<string>",
            "userId": "<string>",
            "displayName": "<string>",
            "emailAddress": "<string>"
          }
        ]
      },
      "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "userId": "<string>",
      "deliveredItems": [
        {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "dateCreated": "2023-11-07T05:31:56Z",
          "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "type": "<string>",
          "source": "<string>",
          "textContent": "<string>",
          "fileId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "webhookExecutionLogId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "file": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "dateCreated": "2023-11-07T05:31:56Z",
            "friendlyName": "<string>",
            "ipAddress": "<string>",
            "userId": "<string>"
          },
          "webhookExecutionLog": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "dateCreated": "2023-11-07T05:31:56Z",
            "url": "<string>",
            "signature": "<string>",
            "requestBody": "<string>",
            "responseCode": 123,
            "responseBody": "<string>",
            "webhookId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
          },
          "variant": {
            "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "dateCreated": "2023-11-07T05:31:56Z",
            "name": "<string>",
            "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
            "cost": 50000,
            "deliveryTypes": [
              "<string>"
            ],
            "files": [
              {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "dateCreated": "2023-11-07T05:31:56Z",
                "friendlyName": "<string>",
                "ipAddress": "<string>",
                "userId": "<string>"
              }
            ],
            "minimumQuantity": 123,
            "maximumQuantity": 123,
            "order": 123,
            "imageNames": [
              "<string>"
            ],
            "stock": 123,
            "stockMode": 0,
            "customFields": [
              {
                "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "dateCreated": "2023-11-07T05:31:56Z",
                "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                "label": "<string>",
                "identifier": "<string>",
                "type": "<string>",
                "isRequired": true,
                "options": [
                  {
                    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                    "dateCreated": "2023-11-07T05:31:56Z",
                    "customFieldId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
                    "label": "<string>",
                    "value": "<string>",
                    "order": 1073741823
                  }
                ],
                "placeholder": "<string>",
                "hint": "<string>"
              }
            ],
            "dynamicUrl": "<string>",
            "deliveryMessage": "<string>",
            "metadata": "<string>"
          }
        }
      ],
      "status": "<string>",
      "gateway": "<string>",
      "amount": 123,
      "platformFee": 123,
      "realCustomerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "currencyCode": "<string>",
      "userAgent": "<string>",
      "ipAddress": "<string>",
      "isDeliveredManually": true,
      "isDeliveryItemsLocked": true,
      "isCustomerAuthenticated": true,
      "isMigrated": true,
      "sendReceipt": true,
      "source": "<string>",
      "coupon": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "netDecrease": 123,
        "code": "<string>",
        "couponId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "percentageDecrease": 123
      },
      "affiliateDiscount": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "netDecrease": 123,
        "percentageDecrease": 123
      },
      "refund": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "userId": "<string>",
        "ipAddress": "<string>",
        "reason": 0,
        "amount": 123,
        "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "chargeback": {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "status": "<string>",
        "reason": "<string>",
        "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      },
      "amountPaid": 123,
      "gatewayFee": 123,
      "affiliateId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "customFieldAnswers": {},
      "deliveredByUserId": "<string>",
      "returnUrl": "<string>",
      "metadata": {}
    },
    "logs": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "dateCreated": "2023-11-07T05:31:56Z",
        "url": "<string>",
        "signature": "<string>",
        "requestBody": "<string>",
        "responseCode": 123,
        "responseBody": "<string>",
        "webhookId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "orderId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
      }
    ],
    "ipInfo": {
      "status": "<string>",
      "proxy": true,
      "hosting": true,
      "mobile": true,
      "regionName": "<string>",
      "country": "<string>",
      "city": "<string>",
      "isp": "<string>"
    },
    "storeId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "storeName": "<string>",
    "billingInformation": {
      "countryCode": "<string>",
      "legalEntityType": "<string>",
      "taxId": "<string>",
      "fullName": "<string>",
      "addressLine1": "<string>",
      "addressLine2": "<string>",
      "city": "<string>",
      "region": "<string>",
      "postalCode": "<string>"
    }
  }
}

Order Statuses

View all possible order status values and their meanings

Payment Methods

See supported payment gateways and cryptocurrencies

Authorizations

​
Authorization
string
header
required

Your API key goes here

Path Parameters

​
storeId
string<uuid>
required

The ID of the store the order belongs to.

​
orderId
string<uuid>
required

The ID of the order to retrieve.

Response

The object was successfully returned.

Represents a default generic response for API endpoints.

​
success
boolean
required

Indicates whether the operation or response was successful.

​
message
string | null

A descriptive message providing additional context or information about the response.

​
code
string | null

The error code (if there was an error) to use when referencing the error

​
data
object

Represents the response details for an order.