API Documentation
User
Products
Categories
Variants
- GETGet Variant
- GETGet License Keys
- POSTCreate Variant
- POSTCreate Field
- POSTCreate Field Option
- PUTAdd License Keys
- PUTUpdate Variant
- PUTUpdate Delivery Settings
- PUTUpdate Field
- PUTUpdate Field Option
- PATCHOrder Variant Images
- DELDelete License Keys
- DELClear License Keys
- DELDelete Variant
- DELDelete Field
- DELDelete Field Option
Coupons
Customers
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,
"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>"
},
"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>"
}
}Get Order
Retrieve order details by ID in the given store.
Requires the stores.orders.view permission.
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,
"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>"
},
"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>"
}
}Order Statuses
Payment Methods
Authorizations
Your API key goes here
Path Parameters
The ID of the store the order belongs to.
The ID of the order to retrieve.
Response
The object was successfully returned.
Represents a default generic response for API endpoints.
Indicates whether the operation or response was successful.
A descriptive message providing additional context or information about the response.
The error code (if there was an error) to use when referencing the error
Represents the response details for an order.
Show child attributes
Show child attributes
Represents an order entity with details about the customer, products, payment, and optional features like warranty and discounts
Show child attributes
Show child attributes
The unique identifier of the entity
The date the entity was created in the database
The list of items the customer has ordered
Show child attributes
Show child attributes
The unique identifier of the entity
The date the entity was created in the database
The name of the product
3 - 128The ID of the product
The ID of the variant they purchased
The name of the variant they purchased
3 - 128The unit cost, how much one unit of the product costs
The total cost for the line item (Amount * Quantity)
An additional fee percentage applied to the line item, if any.
The total amount of any additional fees applied to the line item.
The ID of the store the product belongs to
The ID of the order associated with the item
The amount of product that was purchased
The metadata for a specific payment gateway
Show child attributes
Show child attributes
The unique identifier of the entity
The date the entity was created in the database
The transaction ID associated with the gateway
128The client secret used by card gateways to facilitate payments down to the browser
256The note for PayPal Friends and Family or Cash App payments
64The address for a cryptocurrency payment
256The amount of cryptocurrency converted at the time for a cryptocurrency payment
The date the cryptocurrency payment expires
Represents a snapshot of the customer details at the time of the order
Show child attributes
Show child attributes
The unique identifier of the entity
The date the entity was created in the database
The country code of the customer
1 - 2The email address of the customer
1 - 256The ID of the customer profile in the database
The list of external logins the customer used to sign in with
Show child attributes
Show child attributes
The unique identifier of the entity
The date the entity was created in the database
The name of the application the customer authorized with
1 - 32The ID of the customer on the respective application
36The display name of the customer on the respective application
128The email address of the customer on the respective application
256The ID of the store the order was created for
The ID of the user who owns the store the order was created for
1 - 36The collection of items that have been delivered as part of an order.
Show child attributes
Show child attributes
The unique identifier of the entity
The date the entity was created in the database
The unique identifier for the order associated with the delivered item.
The unique identifier for the store associated with the delivered item.
The identifier of the related product, if applicable.
The identifier for the variant of the delivered item, if applicable.
The optional identifier for the customer associated with the delivered item (and order)
The type that categorizes the delivered item.
128The source of the delivered item, indicates its origin or context.
128The text content associated with the delivered item. Used for LicenseKey, Plaintext, or Dynamic types.
10000The identifier of the file associated with the delivered item, if applicable.
The ID of the webhook/dynamic delivery request associated with this delivered item.
A file stored on a product for delivery
Show child attributes
Show child attributes
The unique identifier of the entity
The date the entity was created in the database
The friendly name of the file
1 - 128The IP address which uploaded the file
1 - 45The ID of the user who uploaded the file
1 - 36A log for a webhook execution.
Show child attributes
Show child attributes
The unique identifier of the entity
The date the entity was created in the database
The URL associated with the webhook execution log.
2048The signature of the webhook execution, used for validation and security purposes.
128The body of the request sent in a webhook execution.
8192The HTTP response code resulting from executing the webhook.
The response body returned by a webhook execution log.
900The unique identifier of the webhook associated with this log.
The unique identifier for the order associated with the webhook execution log.
Represents a configurable variant associated with a product, containing various properties such as pricing, stock, delivery options, and custom fields.
Show child attributes
Show child attributes
The unique identifier of the entity
The date the entity was created in the database
The name of the variant.
3 - 128Represents the unique identifier of the product associated with the variant.
The unique identifier for the store associated with the variant.
The cost of the variant.
0 <= x <= 100000A list of delivery methods associated with the variant.
A collection of stored files associated with this variant.
Show child attributes
Show child attributes
The unique identifier of the entity
The date the entity was created in the database
The friendly name of the file
1 - 128The IP address which uploaded the file
1 - 45The ID of the user who uploaded the file
1 - 36The minimum quantity of the product variant required for a single order.
The maximum quantity of the variant that can be purchased in a single order. A value of -1 indicates no limit.
Indicates the display order of the variant in a sequence.
A list of image file names associated with the variant.
Represents the quantity of items available for sale.
The stock calculation modes that are used
0, 1, 2 Represents the collection of custom fields associated with the variant. Each custom field provides additional configuration or metadata related to the variant, such as labels, identifiers, or placeholders.
Show child attributes
Show child attributes
The unique identifier of the entity
The date the entity was created in the database
FK back to the parent Variant.
The display label for this custom field.
1 - 128A machine-friendly identifier used in forms and storage.
1 - 64The type of the field: "text", "textarea", "select", "checkbox", "radio", or "number".
1 - 256Whether filling out this field is mandatory.
The list of allowed options (only for select or radio fields).
Show child attributes
Show child attributes
The unique identifier of the entity
The date the entity was created in the database
FK back to the parent CustomField.
The user-facing label for this option.
128The stored value for this option (often same as Label).
64Sort order among siblings.
0 <= x <= 2147483647Placeholder text shown when the field is empty (for text/textarea).
256Help text displayed under the field.
512Represents a dynamically generated or configurable URL associated with a variant.
2048An optional message associated with the delivery of this variant.
4096Miscellaneous metadata associated with the variant, this is used in migration to tie reviews/products
1000Represents the current status of the order, indicating the completion state of the payment process.
64The payment gateway used for processing the transaction.
32Represents the monetary value associated with an order.
The fee collected by the platform from the order's total amount
The ID of the customer who made the order
The fiat currency code used for the order, defaults to USD
1 - 3The user agent used to create the order
1 - 512The IP address used to create the order
1 - 45Whether the order was delivered manually or not
Whether the delivery items are locked or not, if this is true then the unauthenticated get order items will return an access denied error
Whether the customer has been authenticated by the create order endpoint, this makes the "Pay with customer balance" button not require auth
Represents a coupon code used on an order
Show child attributes
Show child attributes
The unique identifier of the entity
The date the entity was created in the database
The net amount the coupon decreased the order by
The code of the coupon
3 - 32The ID of the coupon
The percentage the coupon cut off the order, this is null if the coupon was a fixed amount instead which the net decrease is below
Represents a discount used on an order
Show child attributes
Show child attributes
The unique identifier of the entity
The date the entity was created in the database
The net amount the coupon decreased the order by
The percentage the coupon cut off the order, this is null if the coupon was a fixed amount instead which the net decrease is below
Represents a refund associated with a specific user, order, and reason for payment adjustment.
Show child attributes
Show child attributes
The unique identifier of the entity
The date the entity was created in the database
Represents the ID of the user associated with the refund.
1 - 36Represents the IP address associated with the refund transaction.
1 - 256Indicates a duplicate transaction or order as the reason for a refund.
0, 1, 2, 3 Gets or sets the amount of the refund.
Represents the unique identifier for the associated order in the refund process.
Represents a dispute entity in the payment system. A dispute is associated with a specific order and contains information about its status and reason.
Show child attributes
Show child attributes
The unique identifier of the entity
The date the entity was created in the database
Represents the current state of the dispute.
1 - 64Represents the reason associated with a dispute.
1 - 2000Represents the unique identifier for the associated order in the context of a dispute.
Represents the amount that has been paid for an order.
The fee charged by the payment gateway for processing a transaction
Unique identifier for the affiliate who referred this order
The ID of the user who manually delivered the order, null if the order was not manually delivered
36A collection of logs associated with webhook executions.
Show child attributes
Show child attributes
The unique identifier of the entity
The date the entity was created in the database
The URL associated with the webhook execution log.
2048The signature of the webhook execution, used for validation and security purposes.
128The body of the request sent in a webhook execution.
8192The HTTP response code resulting from executing the webhook.
The response body returned by a webhook execution log.
900The unique identifier of the webhook associated with this log.
The unique identifier for the order associated with the webhook execution log.
Details about an IP address such as the registration location and the owner
Show child attributes
Show child attributes
The status of the operation, either success or error
Whether the IP address was detected as a proxy
Whether the IP address is used by a hosting company
Whether the IP address belongs to a mobile network (3G, 4G (LTE), 5G, etc.)
The region the IP was registered in
The country the IP was registered in
The city the IP was registered in
The ISP that owns the IP address
Represents the identifier of the store associated with the order.
Gets or sets the name of the store associated with the order.
Was this page helpful?