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
POST /api/202412/orders: Creates an order
POST /api/202412/orders/{orderId}/cancel: Cancel an order
PUT /api/202412/orders/{orderId}: Update an order
GET /api/202412/orders: Get order list
GET /api/202412/orders/count: Get order count
GET /api/202412/orders/{orderId}: Get order details
Object
[none:object_desc]
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.
bash
{
"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": ""
}
}
}POST Creates an order
Create an order. By default, product inventory does not need to be declared when creating an order, but product and variant unique IDs do need to be specified.
Access scope
Requires ANY of the following access scopes: write_orders
Endpoint
POST /api/202412/orders
Request Params
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.
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.
marketIdnumber
The market id to which the order belongs.
Response 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.
bash
curl -X POST \
https://{shop}.genmystore.com/api/202412/orders" \
-H "X-Genstore-Access-Token: {access_token}" \
-H "Content-Type: application/json" \
-d '{
"order":{
"note":"Customer changed their mind.",
"sourceIdentifier":"ORDERID-123",
"totalOutstanding":"5.00",
"currentTotalDiscounts":"10.00",
"totalPrice":"409.94",
"totalDiscounts":"0.00",
"paymentGatewayNames":[
"authorize_net",
"Cash on Delivery (COD)"
],
"currentTotalTax":"10.00",
"fulfillmentStatus":"partial",
"marketId":"1122",
"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.",
"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":""
}
}
}'json
HTTP/1.1 200 OK
{
"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.",
"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": ""
}
}
}POST Cancel an order
Cancel an order. Orders that have been paid for and fulfilled can not be canceled.
Access scope
Requires ANY of the following access scopes: write_orders
Endpoint
POST /api/202412/orders/{orderId}/cancel
Request Params
orderIdnumber
The order's position in the shop's count of orders.
reasonstring
The reason why the order was canceled.
Response 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.
bash
curl -X POST \
https://{shop}.genmystore.com/api/202412/orders/{orderId}/cancel" \
-H "X-Genstore-Access-Token: {access_token}" \
-H "Content-Type: application/json" \
-d '{
"reason":"customer",
"orderId":"1001"
}'json
HTTP/1.1 200 OK
{
"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.",
"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": ""
}
}
}PUT Update an order
This action allows updating the order's properties, including email, phone, notes, and tags fields. It does not apply to editing line items.
Access scope
Requires ANY of the following access scopes: write_orders
Endpoint
PUT /api/202412/orders/{orderId}
Request Params
orderobject
The order is a customer's request to purchase one or more products from a shop.
- Hide child properties
orderIdnumber
The order's position in the shop's count of orders.
emailstring
The customer's email address.
phonestring
The customer's phone number for receiving SMS notifications.
notestring
An optional note that a shop owner can attach to the order.
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.
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
Response 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.
bash
curl -X PUT \
https://{shop}.genmystore.com/api/202412/orders/{orderId}" \
-H "X-Genstore-Access-Token: {access_token}" \
-H "Content-Type: application/json" \
-d '{
"order":{
"note":"Customer changed their mind.",
"orderId":"1001",
"phone":"+557734881234",
"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"
},
"email":"[email protected]",
"tags":"imported, vip"
}
}'json
HTTP/1.1 200 OK
{
"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.",
"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": ""
}
}
}GET Get order list
Retrieves a list of orders that meet the specified criteria.
Access scope
Requires ANY of the following access scopes: read_orders write_orders
Endpoint
GET /api/202412/orders
Request Params
createdAtMaxstring
Show orders created at or before date.
createdAtMinstring
Show orders created at or after date.
updatedAtMaxstring
Show orders last updated at or before date.
updatedAtMinstring
Show orders last updated at or after date.
financialStatusstring
Filter orders by their financial status.
fulfillmentStatusstring
Filter orders by their fulfillment status.
idsstring
Retrieve only orders specified by a comma-separated list of order IDs.
limitnumber
The maximum number of results to show on a page.
Response Data
ordersarray
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.
bash
curl -X GET \
https://{shop}.genmystore.com/api/202412/orders" \
-H "X-Genstore-Access-Token: {access_token}" \json
HTTP/1.1 200 OK
{
"orders": [
{
"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": ""
}
}
]
}GET Get order count
Retrieve the total number of orders that meet the specified criteria.
Access scope
Requires ANY of the following access scopes: read_orders write_orders
Endpoint
GET /api/202412/orders/count
Request Params
createdAtMaxstring
Show orders created at or before date.
financialStatusstring
Filter orders by their financial status.
createdAtMinstring
Show orders created at or after date.
updatedAtMinstring
Show orders last updated at or after date.
fulfillmentStatusstring
Filter orders by their fulfillment status.
updatedAtMaxstring
Show orders last updated at or before date.
Response Data
countnumber
The total number of orders.
bash
curl -X GET \
https://{shop}.genmystore.com/api/202412/orders/count" \
-H "X-Genstore-Access-Token: {access_token}" \json
HTTP/1.1 200 OK
{
"count": "500"
}GET Get order details
Retrieve an order by specifying the ID.
Access scope
Requires ANY of the following access scopes: read_orders write_orders
Endpoint
GET /api/202412/orders/{orderId}
Request Params
orderIdnumber
Unique identification of the order.
Response 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.
bash
curl -X GET \
https://{shop}.genmystore.com/api/202412/orders/{orderId}" \
-H "X-Genstore-Access-Token: {access_token}" \json
HTTP/1.1 200 OK
{
"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.",
"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": ""
}
}
}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.
Object
[none:object_desc]
Properties
POST Creates an order
Create an order. By default, product inventory does not need to be declared when creating an order, but product and variant unique IDs do need to be specified.
Access scope
Requires ANY of the following access scopes: write_orders
Endpoint
POST /api/202412/orders
POST Cancel an order
Cancel an order. Orders that have been paid for and fulfilled can not be canceled.
Access scope
Requires ANY of the following access scopes: write_orders
Endpoint
POST /api/202412/orders/{orderId}/cancel
PUT Update an order
This action allows updating the order's properties, including email, phone, notes, and tags fields. It does not apply to editing line items.
Access scope
Requires ANY of the following access scopes: write_orders
Endpoint
PUT /api/202412/orders/{orderId}
GET Get order list
Retrieves a list of orders that meet the specified criteria.
Access scope
Requires ANY of the following access scopes: read_orders write_orders
Endpoint
GET /api/202412/orders
GET Get order count
Retrieve the total number of orders that meet the specified criteria.
Access scope
Requires ANY of the following access scopes: read_orders write_orders
Endpoint
GET /api/202412/orders/count
GET Get order details
Retrieve an order by specifying the ID.
Access scope
Requires ANY of the following access scopes: read_orders write_orders
Endpoint
GET /api/202412/orders/{orderId}