About Order

Access scope

Multiple access scopes needed — refer to each endpoint for access scope requirements.

Order Management is a core component of the Genstore trading system, enabling end-to-end order lifecycle management. Through standardized order processing workflows, it provides merchants with efficient and reliable order management capabilities, ensuring transaction security and business continuity.

Core Features

• Basic Order Operations: Create order, modify order, cancel order, delete order.
• Order Status Management: Confirm order, close order, reopen order.
• Order Information Query: Get order details, list orders, count orders.

Use Cases

• Omnichannel Order Operations: Merchants can centrally manage orders from different channels, achieving unified order processing and status synchronization to improve operational efficiency.
• Order Fulfillment Management: Operations teams can monitor order status in real-time, assign processing tasks, and track exceptional orders to ensure timely delivery and customer satisfaction.
• Transaction Data Analytics: Data analysis teams can access comprehensive order data to perform transaction trend analysis and customer behavior insights, supporting business decision-making.
• Customer Service Coordination: Customer service teams can quickly retrieve order details, process after-sales requests, and document service interactions to deliver professional customer service experience.

Endpoints

EVENT orders/fulfilled: Order fulfilled

EVENT orders/update: Order update

EVENT orders/paid: Order paid

EVENT orders/create: Order create

EVENT orders/cancelled: Order cancelled

Order Object

The order object.

Properties

orderobject

The order is a customer's request to purchase one or more products from a shop.

- Hide child properties

billingAddressobject

The mailing address associated with the payment method. This address is an optional field that won't be available on orders that do not require a payment method.

+ Show child properties

buyerAcceptsMarketingboolean

Whether the customer consented to receive email updates from the shop.

cancelReasonstring

The reason why the order was canceled.

cancelledAtstring

The date and time when the order was canceled. Returns null if the order isn't canceled.

closedAtstring

The date and time (ISO 8601 format) when the order was closed. Returns null if the order isn't closed.

createdAtstring

The autogenerated date and time (ISO 8601 format) when the order was created.The value for this property cannot be changed.

currencystring

The three-letter code (ISO 4217 format) for the shop currency.

currentTotalDiscountsstring

The current total discounts on the order in the shop currency. The value of this field reflects order edits, returns, and refunds.

currentTotalPricestring

The current total price of the order in the shop currency. The value of this field reflects order edits, returns, and refunds.

currentSubtotalPricestring

The sum of the prices for all line items after discounts and returns in the shop currency.

currentTotalTaxstring

The sum of the prices for all tax lines applied to the order in the shop currency, excluding refunded and removed tax lines.

customerobject

Information about the customer.

+ Show child properties

discountCodesarray

A list of discounts applied to the order.

+ Show child properties

emailstring

The customer's email address.

financialStatusstring

The status of payments associated with the order. Can only be set when the order is created.

fulfillmentsarray

An array of fulfillments associated with the order.

+ Show child properties

fulfillmentStatusstring

The order's status in terms of fulfilled line items.

lineItemsarray

A list of line item objects, each containing information about an item in the order.

+ Show child properties

notestring

An optional note that a shop owner can attach to the order.

orderIdnumber

The order's position in the shop's count of orders.

paymentTermsobject

The terms and conditions under which a payment should be processed.

+ Show child properties

paymentGatewayNamesarray

The list of payment gateways used for the order.

phonestring

The customer's phone number for receiving SMS notifications.

presentmentCurrencystring

The presentment currency that was used to display prices to the customer.

shippingAddressobject

The mailing address to where the order will be shipped. This address is optional and will not be available on orders that do not require shipping.

+ Show child properties

sourceNamestring

The source of the checkout.

sourceIdentifierstring

The ID of the order placed on the originating platform.

subtotalPricestring

The price of the order in the shop currency after discounts but before shipping, duties, taxes, and tips.

tagsstring

Tags attached to the order, formatted as a string of comma-separated values. Tags are additional short descriptors, commonly used for filtering and searching. Each individual tag is limited to 40 characters in length.

taxesIncludedboolean

Whether taxes are included in the order subtotal.

dutiesIncludedboolean

Whether duties are included in the order subtotal.

totalDiscountsstring

The total discounts applied to the price of the order in the shop currency.

totalLineItemsPricestring

The sum of all line item prices in the shop currency.

totalOutstandingstring

The total outstanding amount of the order in the shop currency.

totalPricestring

The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive.

totalTaxstring

The sum of the prices for all tax lines applied to the order in the shop currency, including refunded and removed tax lines.

totalWeightnumber

The sum of all line item weights in grams. The sum is not adjusted as items are removed from the order.

updatedAtstring

The date and time (ISO 8601 format) when the order was last modified.

Order Object

{
  "order": {
    "note": "Customer changed their mind.",
    "sourceIdentifier": "ORDERID-123",
    "totalOutstanding": "5.00",
    "currentTotalDiscounts": "10.00",
    "orderId": "1001",
    "totalPrice": "409.94",
    "totalDiscounts": "0.00",
    "paymentGatewayNames": "["authorize_net","Cash on Delivery (COD)"]",
    "currentTotalTax": "10.00",
    "fulfillmentStatus": "partial",
    "currentTotalPrice": "10.00",
    "currentSubtotalPrice": "10.00",
    "lineItems": [
      {
        "variantTitle": "Pink",
        "quantity": "1",
        "productId": "7513594",
        "taxable": "true",
        "title": "IPod Nano",
        "fulfillableQuantity": "1",
        "fulfillmentStatus": "fulfilled",
        "requiresShipping": "true",
        "price": "199.99",
        "giftCard": "false",
        "totalDiscount": "5.00",
        "id": "669751112",
        "variantId": "4264112",
        "grams": "500",
        "sku": "IPOD-342-N",
        "currentQuantity": "1"
      }
    ],
    "totalTax": "11.94",
    "createdAt": "2008-01-10T11:00:00-05:00",
    "fulfillments": [
      {
        "createdAt": "2022-01-01T11:00:00-01:00",
        "orderId": "3183479",
        "fulfillId": "255858046",
        "status": "failure",
        "updatedAt": "2022-01-01T11:00:00-01:00""
      }
    ],
    "presentmentCurrency": "CAD",
    "dutiesIncluded": "false",
    "currency": "USD",
    "cancelReason": "customer",
    "closedAt": "2008-01-10T11:00:00-05:00",
    "subtotalPrice": "398.00",
    "email": "[email protected]",
    "paymentTerms": {
      "amount": "70",
      "currency": "CAD"
    },
    "updatedAt": "2012-08-24T14:02:15-04:00",
    "taxesIncluded": "false",
    "discountCodes": [
      {
        "amount": "30.00",
        "code": "SPRING30",
        "type": "fixed_amount"
      }
    ],
    "cancelledAt": "null",
    "tags": "imported, vip",
    "buyerAcceptsMarketing": "false",
    "phone": "+557734881234",
    "totalLineItemsPrice": "398.00",
    "financialStatus": "paid",
    "totalWeight": "300",
    "shippingAddress": {
      "zip": "K2P0V6",
      "country": "Canada",
      "lastName": "Bobsen",
      "address2": "Amoebobacterieae",
      "city": "Ottawa",
      "address1": "123 Amoebobacterieae St",
      "provinceCode": "ON",
      "latitude": "45.41634",
      "firstName": "Bob",
      "province": "Ontario",
      "phone": "555-625-1199",
      "countryCode": "CA",
      "name": "Bob Bobsen",
      "longitude": "-75.6868"
    },
    "billingAddress": {
      "zip": "T0E 0M0",
      "country": "Canada",
      "lastName": "Gorski",
      "address2": "Apartment 5",
      "city": "Drayton Valley",
      "address1": "2259 Park Ct",
      "provinceCode": "AB",
      "latitude": "45.41634",
      "firstName": "Christopher",
      "province": "Alberta",
      "phone": "(555)555-5555",
      "countryCode": "CA",
      "name": "Christopher Gorski",
      "longitude": "-75.6868"
    },
    "sourceName": "instagram",
    "customer": {
      "lastName": "Norman",
      "note": "A note about the customer.",
      "addresses": "",
      "taxExempt": "true",
      "taxExemptions": "["CA_STATUS_CARD_EXEMPTION","CA_BC_RESELLER_EXEMPTION"]",
      "tags": "loyal",
      "createdAt": "2013-06-27T08:48:27-04:00",
      "firstName": "John",
      "phone": "16135551111",
      "currency": "JPY",
      "id": "207119551",
      "state": "disabled",
      "email": "[email protected]",
      "updatedAt": "2012-08-24T14:01:46-04:00",
      "verifiedEmail": "true",
      "defaultAddress": ""
    }
  }
}

EVENT Order fulfilled

Occurs whenever an order is fulfilled.

Access scope

Requires ANY of the following access scopes: read_orders write_orders

Topic

EVENT orders/fulfilled 

Event Data

orderobject

The order is a customer's request to purchase one or more products from a shop.

- Hide child properties

billingAddressobject

The mailing address associated with the payment method. This address is an optional field that won't be available on orders that do not require a payment method.

+ Show child properties

buyerAcceptsMarketingboolean

Whether the customer consented to receive email updates from the shop.

cancelReasonstring

The reason why the order was canceled.

cancelledAtstring

The date and time when the order was canceled. Returns null if the order isn't canceled.

closedAtstring

The date and time (ISO 8601 format) when the order was closed. Returns null if the order isn't closed.

createdAtstring

The autogenerated date and time (ISO 8601 format) when the order was created.The value for this property cannot be changed.

currencystring

The three-letter code (ISO 4217 format) for the shop currency.

currentTotalDiscountsstring

The current total discounts on the order in the shop currency. The value of this field reflects order edits, returns, and refunds.

currentTotalPricestring

The current total price of the order in the shop currency. The value of this field reflects order edits, returns, and refunds.

currentSubtotalPricestring

The sum of the prices for all line items after discounts and returns in the shop currency.

currentTotalTaxstring

The sum of the prices for all tax lines applied to the order in the shop currency, excluding refunded and removed tax lines.

customerobject

Information about the customer.

+ Show child properties

discountCodesarray

A list of discounts applied to the order.

+ Show child properties

emailstring

The customer's email address.

financialStatusstring

The status of payments associated with the order. Can only be set when the order is created.

fulfillmentsarray

An array of fulfillments associated with the order.

+ Show child properties

fulfillmentStatusstring

The order's status in terms of fulfilled line items.

lineItemsarray

A list of line item objects, each containing information about an item in the order.

+ Show child properties

notestring

An optional note that a shop owner can attach to the order.

orderIdnumber

The order's position in the shop's count of orders.

paymentTermsobject

The terms and conditions under which a payment should be processed.

+ Show child properties

paymentGatewayNamesarray

The list of payment gateways used for the order.

phonestring

The customer's phone number for receiving SMS notifications.

presentmentCurrencystring

The presentment currency that was used to display prices to the customer.

shippingAddressobject

The mailing address to where the order will be shipped. This address is optional and will not be available on orders that do not require shipping.

+ Show child properties

sourceNamestring

The source of the checkout.

sourceIdentifierstring

The ID of the order placed on the originating platform.

subtotalPricestring

The price of the order in the shop currency after discounts but before shipping, duties, taxes, and tips.

tagsstring

Tags attached to the order, formatted as a string of comma-separated values. Tags are additional short descriptors, commonly used for filtering and searching. Each individual tag is limited to 40 characters in length.

taxesIncludedboolean

Whether taxes are included in the order subtotal.

dutiesIncludedboolean

Whether duties are included in the order subtotal.

totalDiscountsstring

The total discounts applied to the price of the order in the shop currency.

totalLineItemsPricestring

The sum of all line item prices in the shop currency.

totalOutstandingstring

The total outstanding amount of the order in the shop currency.

totalPricestring

The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive.

totalTaxstring

The sum of the prices for all tax lines applied to the order in the shop currency, including refunded and removed tax lines.

totalWeightnumber

The sum of all line item weights in grams. The sum is not adjusted as items are removed from the order.

updatedAtstring

The date and time (ISO 8601 format) when the order was last modified.

orders/fulfilled: Sample Payload

{
  "order": {
    "note": "Customer changed their mind.",
    "sourceIdentifier": "ORDERID-123",
    "totalOutstanding": "5.00",
    "currentTotalDiscounts": "10.00",
    "orderId": "1001",
    "totalPrice": "409.94",
    "totalDiscounts": "0.00",
    "paymentGatewayNames": "[\"authorize_net\",\"Cash on Delivery (COD)\"]",
    "currentTotalTax": "10.00",
    "fulfillmentStatus": "partial",
    "currentTotalPrice": "10.00",
    "currentSubtotalPrice": "10.00",
    "lineItems": [
      {
        "variantTitle": "Pink",
        "quantity": "1",
        "productId": "7513594",
        "taxable": "true",
        "title": "IPod Nano",
        "fulfillableQuantity": "1",
        "fulfillmentStatus": "fulfilled",
        "requiresShipping": "true",
        "price": "199.99",
        "giftCard": "false",
        "totalDiscount": "5.00",
        "id": "669751112",
        "variantId": "4264112",
        "grams": "500",
        "sku": "IPOD-342-N",
        "currentQuantity": "1"
      }
    ],
    "totalTax": "11.94",
    "createdAt": "2008-01-10T11:00:00-05:00",
    "fulfillments": [
      {
        "createdAt": "2022-01-01T11:00:00-01:00",
        "orderId": "3183479",
        "fulfillId": "255858046",
        "status": "failure",
        "updatedAt": "2022-01-01T11:00:00-01:00\""
      }
    ],
    "presentmentCurrency": "CAD",
    "dutiesIncluded": "false",
    "currency": "USD",
    "cancelReason": "customer",
    "closedAt": "2008-01-10T11:00:00-05:00",
    "subtotalPrice": "398.00",
    "email": "[email protected]",
    "paymentTerms": {
      "amount": "70",
      "currency": "CAD"
    },
    "updatedAt": "2012-08-24T14:02:15-04:00",
    "taxesIncluded": "false",
    "discountCodes": [
      {
        "amount": "30.00",
        "code": "SPRING30",
        "type": "fixed_amount"
      }
    ],
    "cancelledAt": "null",
    "tags": "imported, vip",
    "buyerAcceptsMarketing": "false",
    "phone": "+557734881234",
    "totalLineItemsPrice": "398.00",
    "financialStatus": "paid",
    "totalWeight": "300",
    "shippingAddress": {
      "zip": "K2P0V6",
      "country": "Canada",
      "lastName": "Bobsen",
      "address2": "Amoebobacterieae",
      "city": "Ottawa",
      "address1": "123 Amoebobacterieae St",
      "provinceCode": "ON",
      "latitude": "45.41634",
      "firstName": "Bob",
      "province": "Ontario",
      "phone": "555-625-1199",
      "countryCode": "CA",
      "name": "Bob Bobsen",
      "longitude": "-75.6868"
    },
    "billingAddress": {
      "zip": "T0E 0M0",
      "country": "Canada",
      "lastName": "Gorski",
      "address2": "Apartment 5",
      "city": "Drayton Valley",
      "address1": "2259 Park Ct",
      "provinceCode": "AB",
      "latitude": "45.41634",
      "firstName": "Christopher",
      "province": "Alberta",
      "phone": "(555)555-5555",
      "countryCode": "CA",
      "name": "Christopher Gorski",
      "longitude": "-75.6868"
    },
    "sourceName": "instagram",
    "customer": {
      "lastName": "Norman",
      "note": "A note about the customer.",
      "addresses": "",
      "taxExempt": "true",
      "taxExemptions": "[\"CA_STATUS_CARD_EXEMPTION\",\"CA_BC_RESELLER_EXEMPTION\"]",
      "tags": "loyal",
      "createdAt": "2013-06-27T08:48:27-04:00",
      "firstName": "John",
      "phone": "16135551111",
      "currency": "JPY",
      "id": "207119551",
      "state": "disabled",
      "email": "[email protected]",
      "updatedAt": "2012-08-24T14:01:46-04:00",
      "verifiedEmail": "true",
      "defaultAddress": ""
    }
  }
}

EVENT Order update

Occurs whenever an order is updated.

Access scope

Requires ANY of the following access scopes: read_orders write_orders

Topic

EVENT orders/update 

Event Data

orderobject

The order is a customer's request to purchase one or more products from a shop.

- Hide child properties

billingAddressobject

The mailing address associated with the payment method. This address is an optional field that won't be available on orders that do not require a payment method.

+ Show child properties

buyerAcceptsMarketingboolean

Whether the customer consented to receive email updates from the shop.

cancelReasonstring

The reason why the order was canceled.

cancelledAtstring

The date and time when the order was canceled. Returns null if the order isn't canceled.

closedAtstring

The date and time (ISO 8601 format) when the order was closed. Returns null if the order isn't closed.

createdAtstring

The autogenerated date and time (ISO 8601 format) when the order was created.The value for this property cannot be changed.

currencystring

The three-letter code (ISO 4217 format) for the shop currency.

currentTotalDiscountsstring

The current total discounts on the order in the shop currency. The value of this field reflects order edits, returns, and refunds.

currentTotalPricestring

The current total price of the order in the shop currency. The value of this field reflects order edits, returns, and refunds.

currentSubtotalPricestring

The sum of the prices for all line items after discounts and returns in the shop currency.

currentTotalTaxstring

The sum of the prices for all tax lines applied to the order in the shop currency, excluding refunded and removed tax lines.

customerobject

Information about the customer.

+ Show child properties

discountCodesarray

A list of discounts applied to the order.

+ Show child properties

emailstring

The customer's email address.

financialStatusstring

The status of payments associated with the order. Can only be set when the order is created.

fulfillmentsarray

An array of fulfillments associated with the order.

+ Show child properties

fulfillmentStatusstring

The order's status in terms of fulfilled line items.

lineItemsarray

A list of line item objects, each containing information about an item in the order.

+ Show child properties

notestring

An optional note that a shop owner can attach to the order.

orderIdnumber

The order's position in the shop's count of orders.

paymentTermsobject

The terms and conditions under which a payment should be processed.

+ Show child properties

paymentGatewayNamesarray

The list of payment gateways used for the order.

phonestring

The customer's phone number for receiving SMS notifications.

presentmentCurrencystring

The presentment currency that was used to display prices to the customer.

shippingAddressobject

The mailing address to where the order will be shipped. This address is optional and will not be available on orders that do not require shipping.

+ Show child properties

sourceNamestring

The source of the checkout.

sourceIdentifierstring

The ID of the order placed on the originating platform.

subtotalPricestring

The price of the order in the shop currency after discounts but before shipping, duties, taxes, and tips.

tagsstring

Tags attached to the order, formatted as a string of comma-separated values. Tags are additional short descriptors, commonly used for filtering and searching. Each individual tag is limited to 40 characters in length.

taxesIncludedboolean

Whether taxes are included in the order subtotal.

dutiesIncludedboolean

Whether duties are included in the order subtotal.

totalDiscountsstring

The total discounts applied to the price of the order in the shop currency.

totalLineItemsPricestring

The sum of all line item prices in the shop currency.

totalOutstandingstring

The total outstanding amount of the order in the shop currency.

totalPricestring

The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive.

totalTaxstring

The sum of the prices for all tax lines applied to the order in the shop currency, including refunded and removed tax lines.

totalWeightnumber

The sum of all line item weights in grams. The sum is not adjusted as items are removed from the order.

updatedAtstring

The date and time (ISO 8601 format) when the order was last modified.

orders/update: Sample Payload

{
  "order": {
    "note": "Customer changed their mind.",
    "sourceIdentifier": "ORDERID-123",
    "totalOutstanding": "5.00",
    "currentTotalDiscounts": "10.00",
    "orderId": "1001",
    "totalPrice": "409.94",
    "totalDiscounts": "0.00",
    "paymentGatewayNames": "[\"authorize_net\",\"Cash on Delivery (COD)\"]",
    "currentTotalTax": "10.00",
    "fulfillmentStatus": "partial",
    "currentTotalPrice": "10.00",
    "currentSubtotalPrice": "10.00",
    "lineItems": [
      {
        "variantTitle": "Pink",
        "quantity": "1",
        "productId": "7513594",
        "taxable": "true",
        "title": "IPod Nano",
        "fulfillableQuantity": "1",
        "fulfillmentStatus": "fulfilled",
        "requiresShipping": "true",
        "price": "199.99",
        "giftCard": "false",
        "totalDiscount": "5.00",
        "id": "669751112",
        "variantId": "4264112",
        "grams": "500",
        "sku": "IPOD-342-N",
        "currentQuantity": "1"
      }
    ],
    "totalTax": "11.94",
    "createdAt": "2008-01-10T11:00:00-05:00",
    "fulfillments": [
      {
        "createdAt": "2022-01-01T11:00:00-01:00",
        "orderId": "3183479",
        "fulfillId": "255858046",
        "status": "failure",
        "updatedAt": "2022-01-01T11:00:00-01:00\""
      }
    ],
    "presentmentCurrency": "CAD",
    "dutiesIncluded": "false",
    "currency": "USD",
    "cancelReason": "customer",
    "closedAt": "2008-01-10T11:00:00-05:00",
    "subtotalPrice": "398.00",
    "email": "[email protected]",
    "paymentTerms": {
      "amount": "70",
      "currency": "CAD"
    },
    "updatedAt": "2012-08-24T14:02:15-04:00",
    "taxesIncluded": "false",
    "discountCodes": [
      {
        "amount": "30.00",
        "code": "SPRING30",
        "type": "fixed_amount"
      }
    ],
    "cancelledAt": "null",
    "tags": "imported, vip",
    "buyerAcceptsMarketing": "false",
    "phone": "+557734881234",
    "totalLineItemsPrice": "398.00",
    "financialStatus": "paid",
    "totalWeight": "300",
    "shippingAddress": {
      "zip": "K2P0V6",
      "country": "Canada",
      "lastName": "Bobsen",
      "address2": "Amoebobacterieae",
      "city": "Ottawa",
      "address1": "123 Amoebobacterieae St",
      "provinceCode": "ON",
      "latitude": "45.41634",
      "firstName": "Bob",
      "province": "Ontario",
      "phone": "555-625-1199",
      "countryCode": "CA",
      "name": "Bob Bobsen",
      "longitude": "-75.6868"
    },
    "billingAddress": {
      "zip": "T0E 0M0",
      "country": "Canada",
      "lastName": "Gorski",
      "address2": "Apartment 5",
      "city": "Drayton Valley",
      "address1": "2259 Park Ct",
      "provinceCode": "AB",
      "latitude": "45.41634",
      "firstName": "Christopher",
      "province": "Alberta",
      "phone": "(555)555-5555",
      "countryCode": "CA",
      "name": "Christopher Gorski",
      "longitude": "-75.6868"
    },
    "sourceName": "instagram",
    "customer": {
      "lastName": "Norman",
      "note": "A note about the customer.",
      "addresses": "",
      "taxExempt": "true",
      "taxExemptions": "[\"CA_STATUS_CARD_EXEMPTION\",\"CA_BC_RESELLER_EXEMPTION\"]",
      "tags": "loyal",
      "createdAt": "2013-06-27T08:48:27-04:00",
      "firstName": "John",
      "phone": "16135551111",
      "currency": "JPY",
      "id": "207119551",
      "state": "disabled",
      "email": "[email protected]",
      "updatedAt": "2012-08-24T14:01:46-04:00",
      "verifiedEmail": "true",
      "defaultAddress": ""
    }
  }
}

EVENT Order paid

Occurs whenever an order is paid.

Access scope

Requires ANY of the following access scopes: read_orders write_orders

Topic

EVENT orders/paid 

Event Data

orderobject

The order is a customer's request to purchase one or more products from a shop.

- Hide child properties

billingAddressobject

The mailing address associated with the payment method. This address is an optional field that won't be available on orders that do not require a payment method.

+ Show child properties

buyerAcceptsMarketingboolean

Whether the customer consented to receive email updates from the shop.

cancelReasonstring

The reason why the order was canceled.

cancelledAtstring

The date and time when the order was canceled. Returns null if the order isn't canceled.

closedAtstring

The date and time (ISO 8601 format) when the order was closed. Returns null if the order isn't closed.

createdAtstring

The autogenerated date and time (ISO 8601 format) when the order was created.The value for this property cannot be changed.

currencystring

The three-letter code (ISO 4217 format) for the shop currency.

currentTotalDiscountsstring

The current total discounts on the order in the shop currency. The value of this field reflects order edits, returns, and refunds.

currentTotalPricestring

The current total price of the order in the shop currency. The value of this field reflects order edits, returns, and refunds.

currentSubtotalPricestring

The sum of the prices for all line items after discounts and returns in the shop currency.

currentTotalTaxstring

The sum of the prices for all tax lines applied to the order in the shop currency, excluding refunded and removed tax lines.

customerobject

Information about the customer.

+ Show child properties

discountCodesarray

A list of discounts applied to the order.

+ Show child properties

emailstring

The customer's email address.

financialStatusstring

The status of payments associated with the order. Can only be set when the order is created.

fulfillmentsarray

An array of fulfillments associated with the order.

+ Show child properties

fulfillmentStatusstring

The order's status in terms of fulfilled line items.

lineItemsarray

A list of line item objects, each containing information about an item in the order.

+ Show child properties

notestring

An optional note that a shop owner can attach to the order.

orderIdnumber

The order's position in the shop's count of orders.

paymentTermsobject

The terms and conditions under which a payment should be processed.

+ Show child properties

paymentGatewayNamesarray

The list of payment gateways used for the order.

phonestring

The customer's phone number for receiving SMS notifications.

presentmentCurrencystring

The presentment currency that was used to display prices to the customer.

shippingAddressobject

The mailing address to where the order will be shipped. This address is optional and will not be available on orders that do not require shipping.

+ Show child properties

sourceNamestring

The source of the checkout.

sourceIdentifierstring

The ID of the order placed on the originating platform.

subtotalPricestring

The price of the order in the shop currency after discounts but before shipping, duties, taxes, and tips.

tagsstring

Tags attached to the order, formatted as a string of comma-separated values. Tags are additional short descriptors, commonly used for filtering and searching. Each individual tag is limited to 40 characters in length.

taxesIncludedboolean

Whether taxes are included in the order subtotal.

dutiesIncludedboolean

Whether duties are included in the order subtotal.

totalDiscountsstring

The total discounts applied to the price of the order in the shop currency.

totalLineItemsPricestring

The sum of all line item prices in the shop currency.

totalOutstandingstring

The total outstanding amount of the order in the shop currency.

totalPricestring

The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive.

totalTaxstring

The sum of the prices for all tax lines applied to the order in the shop currency, including refunded and removed tax lines.

totalWeightnumber

The sum of all line item weights in grams. The sum is not adjusted as items are removed from the order.

updatedAtstring

The date and time (ISO 8601 format) when the order was last modified.

orders/paid: Sample Payload

{
  "order": {
    "note": "Customer changed their mind.",
    "sourceIdentifier": "ORDERID-123",
    "totalOutstanding": "5.00",
    "currentTotalDiscounts": "10.00",
    "orderId": "1001",
    "totalPrice": "409.94",
    "totalDiscounts": "0.00",
    "paymentGatewayNames": "[\"authorize_net\",\"Cash on Delivery (COD)\"]",
    "currentTotalTax": "10.00",
    "fulfillmentStatus": "partial",
    "currentTotalPrice": "10.00",
    "currentSubtotalPrice": "10.00",
    "lineItems": [
      {
        "variantTitle": "Pink",
        "quantity": "1",
        "productId": "7513594",
        "taxable": "true",
        "title": "IPod Nano",
        "fulfillableQuantity": "1",
        "fulfillmentStatus": "fulfilled",
        "requiresShipping": "true",
        "price": "199.99",
        "giftCard": "false",
        "totalDiscount": "5.00",
        "id": "669751112",
        "variantId": "4264112",
        "grams": "500",
        "sku": "IPOD-342-N",
        "currentQuantity": "1"
      }
    ],
    "totalTax": "11.94",
    "createdAt": "2008-01-10T11:00:00-05:00",
    "fulfillments": [
      {
        "createdAt": "2022-01-01T11:00:00-01:00",
        "orderId": "3183479",
        "fulfillId": "255858046",
        "status": "failure",
        "updatedAt": "2022-01-01T11:00:00-01:00\""
      }
    ],
    "presentmentCurrency": "CAD",
    "dutiesIncluded": "false",
    "currency": "USD",
    "cancelReason": "customer",
    "closedAt": "2008-01-10T11:00:00-05:00",
    "subtotalPrice": "398.00",
    "email": "[email protected]",
    "paymentTerms": {
      "amount": "70",
      "currency": "CAD"
    },
    "updatedAt": "2012-08-24T14:02:15-04:00",
    "taxesIncluded": "false",
    "discountCodes": [
      {
        "amount": "30.00",
        "code": "SPRING30",
        "type": "fixed_amount"
      }
    ],
    "cancelledAt": "null",
    "tags": "imported, vip",
    "buyerAcceptsMarketing": "false",
    "phone": "+557734881234",
    "totalLineItemsPrice": "398.00",
    "financialStatus": "paid",
    "totalWeight": "300",
    "shippingAddress": {
      "zip": "K2P0V6",
      "country": "Canada",
      "lastName": "Bobsen",
      "address2": "Amoebobacterieae",
      "city": "Ottawa",
      "address1": "123 Amoebobacterieae St",
      "provinceCode": "ON",
      "latitude": "45.41634",
      "firstName": "Bob",
      "province": "Ontario",
      "phone": "555-625-1199",
      "countryCode": "CA",
      "name": "Bob Bobsen",
      "longitude": "-75.6868"
    },
    "billingAddress": {
      "zip": "T0E 0M0",
      "country": "Canada",
      "lastName": "Gorski",
      "address2": "Apartment 5",
      "city": "Drayton Valley",
      "address1": "2259 Park Ct",
      "provinceCode": "AB",
      "latitude": "45.41634",
      "firstName": "Christopher",
      "province": "Alberta",
      "phone": "(555)555-5555",
      "countryCode": "CA",
      "name": "Christopher Gorski",
      "longitude": "-75.6868"
    },
    "sourceName": "instagram",
    "customer": {
      "lastName": "Norman",
      "note": "A note about the customer.",
      "addresses": "",
      "taxExempt": "true",
      "taxExemptions": "[\"CA_STATUS_CARD_EXEMPTION\",\"CA_BC_RESELLER_EXEMPTION\"]",
      "tags": "loyal",
      "createdAt": "2013-06-27T08:48:27-04:00",
      "firstName": "John",
      "phone": "16135551111",
      "currency": "JPY",
      "id": "207119551",
      "state": "disabled",
      "email": "[email protected]",
      "updatedAt": "2012-08-24T14:01:46-04:00",
      "verifiedEmail": "true",
      "defaultAddress": ""
    }
  }
}

EVENT Order create

Occurs whenever an order is created.

Access scope

Requires ANY of the following access scopes: read_orders write_orders

Topic

EVENT orders/create 

Event Data

orderobject

The order is a customer's request to purchase one or more products from a shop.

- Hide child properties

billingAddressobject

The mailing address associated with the payment method. This address is an optional field that won't be available on orders that do not require a payment method.

+ Show child properties

buyerAcceptsMarketingboolean

Whether the customer consented to receive email updates from the shop.

cancelReasonstring

The reason why the order was canceled.

cancelledAtstring

The date and time when the order was canceled. Returns null if the order isn't canceled.

closedAtstring

The date and time (ISO 8601 format) when the order was closed. Returns null if the order isn't closed.

createdAtstring

The autogenerated date and time (ISO 8601 format) when the order was created.The value for this property cannot be changed.

currencystring

The three-letter code (ISO 4217 format) for the shop currency.

currentTotalDiscountsstring

The current total discounts on the order in the shop currency. The value of this field reflects order edits, returns, and refunds.

currentTotalPricestring

The current total price of the order in the shop currency. The value of this field reflects order edits, returns, and refunds.

currentSubtotalPricestring

The sum of the prices for all line items after discounts and returns in the shop currency.

currentTotalTaxstring

The sum of the prices for all tax lines applied to the order in the shop currency, excluding refunded and removed tax lines.

customerobject

Information about the customer.

+ Show child properties

discountCodesarray

A list of discounts applied to the order.

+ Show child properties

emailstring

The customer's email address.

financialStatusstring

The status of payments associated with the order. Can only be set when the order is created.

fulfillmentsarray

An array of fulfillments associated with the order.

+ Show child properties

fulfillmentStatusstring

The order's status in terms of fulfilled line items.

lineItemsarray

A list of line item objects, each containing information about an item in the order.

+ Show child properties

notestring

An optional note that a shop owner can attach to the order.

orderIdnumber

The order's position in the shop's count of orders.

paymentTermsobject

The terms and conditions under which a payment should be processed.

+ Show child properties

paymentGatewayNamesarray

The list of payment gateways used for the order.

phonestring

The customer's phone number for receiving SMS notifications.

presentmentCurrencystring

The presentment currency that was used to display prices to the customer.

shippingAddressobject

The mailing address to where the order will be shipped. This address is optional and will not be available on orders that do not require shipping.

+ Show child properties

sourceNamestring

The source of the checkout.

sourceIdentifierstring

The ID of the order placed on the originating platform.

subtotalPricestring

The price of the order in the shop currency after discounts but before shipping, duties, taxes, and tips.

tagsstring

Tags attached to the order, formatted as a string of comma-separated values. Tags are additional short descriptors, commonly used for filtering and searching. Each individual tag is limited to 40 characters in length.

taxesIncludedboolean

Whether taxes are included in the order subtotal.

dutiesIncludedboolean

Whether duties are included in the order subtotal.

totalDiscountsstring

The total discounts applied to the price of the order in the shop currency.

totalLineItemsPricestring

The sum of all line item prices in the shop currency.

totalOutstandingstring

The total outstanding amount of the order in the shop currency.

totalPricestring

The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive.

totalTaxstring

The sum of the prices for all tax lines applied to the order in the shop currency, including refunded and removed tax lines.

totalWeightnumber

The sum of all line item weights in grams. The sum is not adjusted as items are removed from the order.

updatedAtstring

The date and time (ISO 8601 format) when the order was last modified.

orders/create: Sample Payload

{
  "order": {
    "note": "Customer changed their mind.",
    "sourceIdentifier": "ORDERID-123",
    "totalOutstanding": "5.00",
    "currentTotalDiscounts": "10.00",
    "orderId": "1001",
    "totalPrice": "409.94",
    "totalDiscounts": "0.00",
    "paymentGatewayNames": "[\"authorize_net\",\"Cash on Delivery (COD)\"]",
    "currentTotalTax": "10.00",
    "fulfillmentStatus": "partial",
    "currentTotalPrice": "10.00",
    "currentSubtotalPrice": "10.00",
    "lineItems": [
      {
        "variantTitle": "Pink",
        "quantity": "1",
        "productId": "7513594",
        "taxable": "true",
        "title": "IPod Nano",
        "fulfillableQuantity": "1",
        "fulfillmentStatus": "fulfilled",
        "requiresShipping": "true",
        "price": "199.99",
        "giftCard": "false",
        "totalDiscount": "5.00",
        "id": "669751112",
        "variantId": "4264112",
        "grams": "500",
        "sku": "IPOD-342-N",
        "currentQuantity": "1"
      }
    ],
    "totalTax": "11.94",
    "createdAt": "2008-01-10T11:00:00-05:00",
    "fulfillments": [
      {
        "createdAt": "2022-01-01T11:00:00-01:00",
        "orderId": "3183479",
        "fulfillId": "255858046",
        "status": "failure",
        "updatedAt": "2022-01-01T11:00:00-01:00\""
      }
    ],
    "presentmentCurrency": "CAD",
    "dutiesIncluded": "false",
    "currency": "USD",
    "cancelReason": "customer",
    "closedAt": "2008-01-10T11:00:00-05:00",
    "subtotalPrice": "398.00",
    "email": "[email protected]",
    "paymentTerms": {
      "amount": "70",
      "currency": "CAD"
    },
    "updatedAt": "2012-08-24T14:02:15-04:00",
    "taxesIncluded": "false",
    "discountCodes": [
      {
        "amount": "30.00",
        "code": "SPRING30",
        "type": "fixed_amount"
      }
    ],
    "cancelledAt": "null",
    "tags": "imported, vip",
    "buyerAcceptsMarketing": "false",
    "phone": "+557734881234",
    "totalLineItemsPrice": "398.00",
    "financialStatus": "paid",
    "totalWeight": "300",
    "shippingAddress": {
      "zip": "K2P0V6",
      "country": "Canada",
      "lastName": "Bobsen",
      "address2": "Amoebobacterieae",
      "city": "Ottawa",
      "address1": "123 Amoebobacterieae St",
      "provinceCode": "ON",
      "latitude": "45.41634",
      "firstName": "Bob",
      "province": "Ontario",
      "phone": "555-625-1199",
      "countryCode": "CA",
      "name": "Bob Bobsen",
      "longitude": "-75.6868"
    },
    "billingAddress": {
      "zip": "T0E 0M0",
      "country": "Canada",
      "lastName": "Gorski",
      "address2": "Apartment 5",
      "city": "Drayton Valley",
      "address1": "2259 Park Ct",
      "provinceCode": "AB",
      "latitude": "45.41634",
      "firstName": "Christopher",
      "province": "Alberta",
      "phone": "(555)555-5555",
      "countryCode": "CA",
      "name": "Christopher Gorski",
      "longitude": "-75.6868"
    },
    "sourceName": "instagram",
    "customer": {
      "lastName": "Norman",
      "note": "A note about the customer.",
      "addresses": "",
      "taxExempt": "true",
      "taxExemptions": "[\"CA_STATUS_CARD_EXEMPTION\",\"CA_BC_RESELLER_EXEMPTION\"]",
      "tags": "loyal",
      "createdAt": "2013-06-27T08:48:27-04:00",
      "firstName": "John",
      "phone": "16135551111",
      "currency": "JPY",
      "id": "207119551",
      "state": "disabled",
      "email": "[email protected]",
      "updatedAt": "2012-08-24T14:01:46-04:00",
      "verifiedEmail": "true",
      "defaultAddress": ""
    }
  }
}

EVENT Order cancelled

This webhook is triggered whenever an order is cancelled, allowing you to receive real-time updates and take appropriate actions or track cancellations.

Access scope

Requires ANY of the following access scopes: read_orders write_orders

Topic

EVENT orders/cancelled 

Event Data

orderobject

The order is a customer's request to purchase one or more products from a shop.

- Hide child properties

billingAddressobject

The mailing address associated with the payment method. This address is an optional field that won't be available on orders that do not require a payment method.

+ Show child properties

buyerAcceptsMarketingboolean

Whether the customer consented to receive email updates from the shop.

cancelReasonstring

The reason why the order was canceled.

cancelledTimestring

The date and time when the order was canceled. Returns null if the order isn't canceled.

closedTimestring

The date and time (ISO 8601 format) when the order was closed. Returns null if the order isn't closed.

createTimestring

The autogenerated date and time (ISO 8601 format) when the order was created.The value for this property cannot be changed.

currencystring

The three-letter code (ISO 4217 format) for the shop currency.

currentTotalDiscountsstring

The current total discounts on the order in the shop currency. The value of this field reflects order edits, returns, and refunds.

currentTotalPricestring

The current total price of the order in the shop currency. The value of this field reflects order edits, returns, and refunds.

currentSubtotalPricestring

The sum of the prices for all line items after discounts and returns in the shop currency.

currentTotalTaxstring

The sum of the prices for all tax lines applied to the order in the shop currency, excluding refunded and removed tax lines.

customerobject

Information about the customer.

+ Show child properties

discountCodesarray

A list of discounts applied to the order.

+ Show child properties

emailstring

The customer's email address.

financialStatusstring

The status of payments associated with the order. Can only be set when the order is created.

fulfillmentsarray

An array of fulfillments associated with the order.

+ Show child properties

fulfillmentStatusstring

The order's status in terms of fulfilled line items.

lineItemsarray

A list of line item objects, each containing information about an item in the order.

+ Show child properties

notestring

An optional note that a shop owner can attach to the order.

orderIdnumber

The order's position in the shop's count of orders.

paymentTermsobject

The terms and conditions under which a payment should be processed.

+ Show child properties

paymentGatewayNamesarray

The list of payment gateways used for the order.

phonestring

The customer's phone number for receiving SMS notifications.

presentmentCurrencystring

The presentment currency that was used to display prices to the customer.

shippingAddressobject

The mailing address to where the order will be shipped. This address is optional and will not be available on orders that do not require shipping.

+ Show child properties

sourceNamestring

The source of the checkout.

sourceIdentifierstring

The ID of the order placed on the originating platform.

subtotalPricestring

The price of the order in the shop currency after discounts but before shipping, duties, taxes, and tips.

tagsstring

Tags attached to the order, formatted as a string of comma-separated values. Tags are additional short descriptors, commonly used for filtering and searching. Each individual tag is limited to 40 characters in length.

taxesIncludedboolean

Whether taxes are included in the order subtotal.

dutiesIncludedboolean

Whether duties are included in the order subtotal.

totalDiscountsstring

The total discounts applied to the price of the order in the shop currency.

totalLineItemsPricestring

The sum of all line item prices in the shop currency.

totalOutstandingstring

The total outstanding amount of the order in the shop currency.

totalPricestring

The sum of all line item prices, discounts, shipping, taxes, and tips in the shop currency. Must be positive.

totalTaxstring

The sum of the prices for all tax lines applied to the order in the shop currency, including refunded and removed tax lines.

totalWeightnumber

The sum of all line item weights in grams. The sum is not adjusted as items are removed from the order.

updateTimestring

The date and time (ISO 8601 format) when the order was last modified.

orders/cancelled: Sample Payload

{
  "order": {
    "note": "Customer changed their mind.",
    "sourceIdentifier": "ORDERID-123",
    "totalOutstanding": "5.00",
    "currentTotalDiscounts": "10.00",
    "orderId": "1001",
    "totalPrice": "409.94",
    "totalDiscounts": "0.00",
    "paymentGatewayNames": [
      "authorize_net",
      "Cash on Delivery (COD)"
    ],
    "currentTotalTax": "10.00",
    "closedTime": "2008-01-10T11:00:00-05:00",
    "fulfillmentStatus": "partial",
    "currentTotalPrice": "10.00",
    "currentSubtotalPrice": "10.00",
    "lineItems": [
      {
        "variantTitle": "Pink",
        "quantity": "1",
        "productId": "7513594",
        "taxable": "true",
        "title": "IPod Nano",
        "fulfillableQuantity": "1",
        "fulfillmentStatus": "fulfilled",
        "requiresShipping": "true",
        "price": "199.99",
        "giftCard": "false",
        "totalDiscount": "5.00",
        "id": "669751112",
        "variantId": "4264112",
        "grams": "500",
        "sku": "IPOD-342-N",
        "currentQuantity": "1"
      }
    ],
    "totalTax": "11.94",
    "fulfillments": [
      {
        "createTime": "2022-01-01T11:00:00-01:00",
        "orderId": "3183479",
        "updateTime": "2022-01-01T11:00:00-01:00\"",
        "fulfillId": "255858046",
        "status": "failure"
      }
    ],
    "presentmentCurrency": "CAD",
    "dutiesIncluded": "false",
    "currency": "USD",
    "cancelReason": "customer",
    "subtotalPrice": "398.00",
    "email": "[email protected]",
    "paymentTerms": {
      "amount": "70",
      "currency": "CAD"
    },
    "taxesIncluded": "false",
    "discountCodes": [
      {
        "amount": "30.00",
        "code": "SPRING30",
        "type": "fixed_amount"
      }
    ],
    "updateTime": "2012-08-24T14:02:15-04:00",
    "tags": "imported, vip",
    "buyerAcceptsMarketing": "false",
    "createTime": "2008-01-10T11:00:00-05:00",
    "phone": "+557734881234",
    "totalLineItemsPrice": "398.00",
    "cancelledTime": "null",
    "financialStatus": "paid",
    "totalWeight": "300",
    "shippingAddress": {
      "zip": "K2P0V6",
      "country": "Canada",
      "lastName": "Bobsen",
      "address2": "Amoebobacterieae",
      "city": "Ottawa",
      "address1": "123 Amoebobacterieae St",
      "provinceCode": "ON",
      "latitude": "45.41634",
      "firstName": "Bob",
      "province": "Ontario",
      "phone": "555-625-1199",
      "countryCode": "CA",
      "name": "Bob Bobsen",
      "longitude": "-75.6868"
    },
    "billingAddress": {
      "zip": "T0E 0M0",
      "country": "Canada",
      "lastName": "Gorski",
      "address2": "Apartment 5",
      "city": "Drayton Valley",
      "address1": "2259 Park Ct",
      "provinceCode": "AB",
      "latitude": "45.41634",
      "firstName": "Christopher",
      "province": "Alberta",
      "phone": "(555)555-5555",
      "countryCode": "CA",
      "name": "Christopher Gorski",
      "longitude": "-75.6868"
    },
    "sourceName": "instagram",
    "customer": {
      "lastName": "Norman",
      "note": "A note about the customer.",
      "taxExempt": "true",
      "taxExemptions": [
        "CA_STATUS_CARD_EXEMPTION",
        "CA_BC_RESELLER_EXEMPTION"
      ],
      "updateTime": "2012-08-24T14:01:46-04:00",
      "tags": "loyal",
      "firstName": "John",
      "createTime": "2013-06-27T08:48:27-04:00",
      "phone": "16135551111",
      "currency": "JPY",
      "id": "207119551",
      "state": "disabled",
      "email": "[email protected]",
      "verifiedEmail": "true",
      "defaultAddress": ""
    }
  }
}

About Order

Access scope

Multiple access scopes needed — refer to each endpoint for access scope requirements.

Order Management is a core component of the Genstore trading system, enabling end-to-end order lifecycle management. Through standardized order processing workflows, it provides merchants with efficient and reliable order management capabilities, ensuring transaction security and business continuity.

Core Features

• Basic Order Operations: Create order, modify order, cancel order, delete order.
• Order Status Management: Confirm order, close order, reopen order.
• Order Information Query: Get order details, list orders, count orders.

Use Cases

• Omnichannel Order Operations: Merchants can centrally manage orders from different channels, achieving unified order processing and status synchronization to improve operational efficiency.
• Order Fulfillment Management: Operations teams can monitor order status in real-time, assign processing tasks, and track exceptional orders to ensure timely delivery and customer satisfaction.
• Transaction Data Analytics: Data analysis teams can access comprehensive order data to perform transaction trend analysis and customer behavior insights, supporting business decision-making.
• Customer Service Coordination: Customer service teams can quickly retrieve order details, process after-sales requests, and document service interactions to deliver professional customer service experience.

Order Object

The order object.

Properties

EVENT Order fulfilled

Occurs whenever an order is fulfilled.

Access scope

Requires ANY of the following access scopes: read_orders write_orders

Topic

EVENT orders/fulfilled 

EVENT Order update

Occurs whenever an order is updated.

Access scope

Requires ANY of the following access scopes: read_orders write_orders

Topic

EVENT orders/update 

EVENT Order paid

Occurs whenever an order is paid.

Access scope

Requires ANY of the following access scopes: read_orders write_orders

Topic

EVENT orders/paid 

EVENT Order create

Occurs whenever an order is created.

Access scope

Requires ANY of the following access scopes: read_orders write_orders

Topic

EVENT orders/create 

EVENT Order cancelled

This webhook is triggered whenever an order is cancelled, allowing you to receive real-time updates and take appropriate actions or track cancellations.

Access scope

Requires ANY of the following access scopes: read_orders write_orders

Topic

EVENT orders/cancelled