Create Order

Create order

curl --request POST \
  --url https://api.komerza.com/stores/{storeId}/orders \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "message": "<string>",
  "code": "<string>",
  "data": {
    "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,
        "quantity": 123
      }
    ],
    "currencyCode": "<string>",
    "gateway": "<string>",
    "customer": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "countryCode": "<string>",
      "emailAddress": "<string>",
      "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "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"
    },
    "status": "<string>",
    "amountPaid": 123,
    "amount": 123,
    "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",
        "type": "<string>",
        "source": "<string>",
        "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "textContent": "<string>",
        "file": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "dateCreated": "2023-11-07T05:31:56Z",
          "friendlyName": "<string>"
        }
      }
    ],
    "chargeback": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "reason": "<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
    },
    "customFieldAnswers": {}
  }
}

POST

stores

{storeId}

orders

Create order

curl --request POST \
  --url https://api.komerza.com/stores/{storeId}/orders \
  --header 'Authorization: Bearer <token>'

{
  "success": true,
  "message": "<string>",
  "code": "<string>",
  "data": {
    "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,
        "quantity": 123
      }
    ],
    "currencyCode": "<string>",
    "gateway": "<string>",
    "customer": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "countryCode": "<string>",
      "emailAddress": "<string>",
      "customerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "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"
    },
    "status": "<string>",
    "amountPaid": 123,
    "amount": 123,
    "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",
        "type": "<string>",
        "source": "<string>",
        "productId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "variantId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "textContent": "<string>",
        "file": {
          "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
          "dateCreated": "2023-11-07T05:31:56Z",
          "friendlyName": "<string>"
        }
      }
    ],
    "chargeback": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "dateCreated": "2023-11-07T05:31:56Z",
      "status": "<string>",
      "reason": "<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
    },
    "customFieldAnswers": {}
  }
}

Authorizations

Authorization

string

header

required

Your API key goes here

Path Parameters

storeId

string<uuid>

required

The ID of the store the order will be created in.

Response

The object was successfully created.

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

An order made by a customer to a merchant for a product they are selling

Show child attributes

data.id

string<uuid>

required

The unique identifier of the entity

data.dateCreated

string<date-time>

required

The date the entity was created

data.items

object[]

required

The product that was purchased

Show child attributes

data.items.id

string<uuid>

required

The unique identifier of the entity

data.items.dateCreated

string<date-time>

required

The date the entity was created

data.items.productName

string

required

The name of the product

data.items.productId

string<uuid>

required

The ID of the product

data.items.variantId

string<uuid>

required

The ID of the variant they purchased

data.items.variantName

string

required

The name of the variant they purchased

data.items.amount

number<double>

required

The unit cost, how much one unit of the product costs

data.items.lineTotal

number<double>

required

The total cost for the line item (Amount * Quantity)

data.items.additionalFeePercentage

number<double>

required

An additional fee percentage applied to the line item, if any.

data.items.additionalFeeAmount

number<double>

required

The total amount of any additional fees applied to the line item.

data.items.quantity

integer<int32>

required

The amount of product that was purchased

data.currencyCode

string

required

The fiat currency code used for the order, defaults to USD

data.gateway

string

required

The gateway used to facilitate the purchase

data.customer

object

required

The customer details on the order

Show child attributes

data.customer.id

string<uuid>

required

The unique identifier of the entity

data.customer.dateCreated

string<date-time>

required

The date the entity was created

data.customer.countryCode

string

required

The country code of the customer

data.customer.emailAddress

string

required

The email address of the customer

data.customer.customerId

string<uuid>

required

The ID of the customer profile in the database

data.gatewayMetadata

object

required

The gateway-specific metadata for the order

Show child attributes

data.gatewayMetadata.id

string<uuid>

required

The unique identifier of the entity

data.gatewayMetadata.dateCreated

string<date-time>

required

The date the entity was created

data.gatewayMetadata.transactionId

string | null

The transaction ID associated with the gateway

data.gatewayMetadata.clientSecret

string | null

The client secret used by card gateways to facilitate payments down to the browser

data.gatewayMetadata.note

string | null

The note for PayPal Friends and Family or Cash App payments

data.gatewayMetadata.cryptocurrencyAddress

string | null

The address for a cryptocurrency payment

data.gatewayMetadata.cryptocurrencyAmount

number<double> | null

The amount of cryptocurrency converted at the time for a cryptocurrency payment

data.gatewayMetadata.cryptocurrencyExpiration

string<date-time> | null

The date the cryptocurrency payment expires

data.status

string

required

The current payment status

data.amountPaid

number<double>

required

The amount that the customer has paid for the invoice

data.amount

number<double>

required

The cost of the order

data.deliveredItems

object[]

required

The list of delivered items

Show child attributes

data.deliveredItems.id

string<uuid>

required

The unique identifier of the entity

data.deliveredItems.dateCreated

string<date-time>

required

The date the entity was created

data.deliveredItems.orderId

string<uuid>

required

The unique identifier for the order associated with the delivered item.

data.deliveredItems.storeId

string<uuid>

required

The unique identifier for the store associated with the delivered item.

data.deliveredItems.type

string

required

The type that categorizes the delivered item.

Maximum string length: 128

data.deliveredItems.source

string

required

The source of the delivered item, indicates its origin or context.

Maximum string length: 128

data.deliveredItems.productId

string<uuid> | null

The identifier of the related product, if applicable.

data.deliveredItems.variantId

string<uuid> | null

The optional identifier for the variant of the delivered item, if applicable.

data.deliveredItems.textContent

string | null

The text content associated with the delivered item. Used for LicenseKey, Plaintext, or Dynamic types.

Maximum string length: 10000

data.deliveredItems.file

object

Represents a publicly accessible file with additional metadata.

Show child attributes

data.deliveredItems.file.id

string<uuid>

required

The unique identifier of the entity

data.deliveredItems.file.dateCreated

string<date-time>

required

The date the entity was created

data.deliveredItems.file.friendlyName

string

required

The friendly name representing the stored file.

Required string length: 1 - 128

data.chargeback

object

Represents a cardholder chargeback/dispute on an order

Show child attributes

data.chargeback.id

string<uuid>

required

The unique identifier of the entity

data.chargeback.dateCreated

string<date-time>

required

The date the entity was created

data.chargeback.status

string

required

Represents the current state of the dispute.

data.chargeback.reason

string

required

Represents the reason associated with a dispute.

data.coupon

object

Represents the usage data of a coupon within an order

Show child attributes

data.coupon.id

string<uuid>

required

The unique identifier of the entity

data.coupon.dateCreated

string<date-time>

required

The date the entity was created

data.coupon.netDecrease

number<double>

required

The net amount the coupon decreased the order by

data.coupon.code

string

required

The code of the coupon

data.coupon.couponId

string<uuid>

required

The ID of the coupon

data.coupon.percentageDecrease

number<double> | null

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

data.affiliateDiscount

object

Represents the usage data of a coupon within an order

Show child attributes

data.affiliateDiscount.id

string<uuid>

required

The unique identifier of the entity

data.affiliateDiscount.dateCreated

string<date-time>

required

The date the entity was created

data.affiliateDiscount.netDecrease

number<double>

required

The net amount the coupon decreased the order by

data.affiliateDiscount.percentageDecrease

number<double> | null

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

data.customFieldAnswers

object

The answers to the custom fields for the order

Show child attributes

data.customFieldAnswers.{key}

string

Search Orders

Deliver Order

⌘I

API Documentation

Reference

User

Stores

Products

Categories

Variants

Coupons

Tickets

Customers

Orders

Reviews

Authorizations

Path Parameters

Response