Skip to content

关于 订单

访问范围

需要多个访问范围—请参阅每个端点以了解访问范围要求。

需要访问受保护的客户数据。

订单管理是 Genstore 交易系统的核心组成部分,它实现了从订单创建到完成的全生命周期管理。通过标准化的订单处理流程,为商家提供高效可靠的订单管理能力,确保交易安全和业务连续性。

核心功能

  • 订单基础操作:创建订单、修改订单、取消订单、删除订单。
  • 订单状态管理:确认订单、关闭订单、重新打开订单。
  • 订单信息查询:查询订单详情、查询订单列表、统计订单数量。

应用场景

  • 全渠道订单运营:商家可统一管理各渠道订单,实现多渠道订单的集中处理和状态同步,提升订单处理效率。
  • 订单履约管理:运营团队可实时掌握订单状态、分配处理任务、跟进异常订单,确保订单及时交付和客户满意度。
  • 交易数据分析:数据分析团队可获取订单全量数据,进行交易趋势分析、客户行为洞察,为业务决策提供数据支持。
  • 客服工单协同:客服团队可快速查询订单详情、处理售后请求、记录服务过程,提供专业的客户服务体验。

接口

EVENT orders/update: 订单更新

EVENT orders/create: 订单创建

EVENT orders/paid: 订单支付

EVENT orders/fulfilled: 订单履约

EVENT orders/cancelled: 订单取消

EVENT orders/partiallyFulfilled: 订单部分履约

订单 对象

订单业务域对象。

属性

orderobject
返回订单详细资料信息。
- 收起属性
billingAddressobject
与付款方式相关联的邮寄地址。此地址是一个可选字段,对于不需要付款方式的订单将不可用。
+ 展开属性
cancelReasonstring
订单被取消的原因。
cancelledTimestring
订单被取消的日期和时间。如果未取消订单,则返回 null。
closedTimestring
订单关闭的日期和时间(ISO 8601格式)。如果订单未关闭则返回 null。
createdTimestring
创建订单时自动生成的日期和时间(ISO 8601格式)。此属性的值不能更改。
currencystring
商店货币代码,三位代码。
customerobject
客户信息。
+ 展开属性
discountCodesarray
应用于订单的折扣列表。
+ 展开属性
emailstring
客户的电子邮件地址。
financialStatusstring
与订单相关的付款状态。枚举值:pending - 待支付;partiallyPaid - 部分支付;paid - 已支付。
fulfillmentsarray
履约单列表。
+ 展开属性
fulfillmentStatusstring
订单履约状态。枚举值:null - 未发货;partial - 部分发货;fulfilled - 已发货;canceled - 已取消。
lineItemsarray
订单项列表。
+ 展开属性
notestring
订单备注。
idnumber
订单号。
paymentTermsarray
支付项列表。
+ 展开属性
paymentGatewayNamesarray
订单支付方式列表。包括但不限于:CASH_ON_DELIVERY - 货到付款;MANUAL_METHOD - 手动支付。
phonestring
客户接收短信通知的电话号码。
shippingAddressobject
订单将被运送到的邮寄地址。此地址是可选的,将不可用于不需要送货的订单。
+ 展开属性
sourceIdentifierstring
在原始平台上的订单 ID。
subtotalPricestring
以商店货币表示的订单价格,扣除折扣后,不包括运费、关税、税金和小费。
tagsstring
附加到订单上的标记,格式为逗号分隔值的字符串。标签是额外的简短描述符,通常用于过滤和搜索。每个标签的长度限制为 40 个字符。
totalDiscountsstring
以商店货币表示的应用于订单价格的总折扣。
totalPricestring
以商店货币表示的所有行项目价格、折扣、运费、税和小费的总和
totalTaxstring
以商店货币表示的应用于订单的所有税目的价格总和,包括已退款和已取消的税目。
totalWeightstring
以克为单位的所有项目重量的总和。
updatedTimestring
最后一次修改订单的日期和时间。
paidTimestring
订单支付完成的日期和时间。
paymentTypestring
订单支付类型。枚举值:online - 线上支付;offline - 线下支付;noPayment - 无需支付;quick - 快捷支付。
convertRatenumber
汇率 市场货币->店铺货币。
totalDiscountsSetobject
总折扣金额价格集合。
+ 展开属性
discountApplicationsarray
折扣应用列表。
+ 展开属性
processedTimestring
处理时间。
refundsarray
售后列表。
+ 展开属性
shippingLinesarray
发货线路列表。
+ 展开属性
subtotalPriceSetobject
商品费用价格集合。
+ 展开属性
taxLinesarray
税费行列表。
+ 展开属性
totalPriceSetobject
总金额价格集合。
+ 展开属性
totalTaxSetobject
税费金额集合。
+ 展开属性
totalShippingPricestring
运费。
totalShippingPriceSetobject
运费金额集合。
+ 展开属性
userIdnumber
用户ID。
i18nstring
国际化信息。
shopCurrencystring
店铺货币。
appstring
应用标识。
typenumber
订单类型。枚举值:1 - 普通订单;11 - 外部创建订单。
extendedFieldsobject
订单扩展字段信息,Map类型。
+ 展开属性
marketIdnumber
市场的唯一标识符,订单所属市场。
bash
{
  "order": {
    "note": "Please deliver after 6 PM",
    "sourceIdentifier": "WEB123456",
    "shopCurrency": "USD",
    "totalPrice": "110.25",
    "totalDiscounts": "10.25",
    "paymentGatewayNames": [
      "PayPal",
      "Credit Card"
    ],
    "type": "1",
    "extendedFields": {
      "value": "extendedFieldValue1",
      "key": "extendedFieldKey1"
    },
    "closedTime": "2023-05-20T14:45:30Z",
    "fulfillmentStatus": "fulfilled",
    "paymentType": "online",
    "refunds": [
      {
        "totalRefundShippingPrice": "5.99",
        "totalRefundPrice": "29.99",
        "refundLineItems": [
          {
            "totalTax": "1.50",
            "quantity": "1",
            "lineItem": {
              "quantity": "2",
              "productId": "123456",
              "refundableQuantity": "1",
              "title": "Wireless Headphones",
              "fulfillableQuantity": "12",
              "fulfillmentStatus": "fulfilled",
              "requiresShipping": "true",
              "price": "29.99",
              "locationId": "1",
              "alreadyRightsNum": "1",
              "alreadyFulfillNum": "2",
              "totalDiscount": "3.50",
              "id": "",
              "variantId": "789012",
              "grams": "250",
              "sku": "ABC123-X",
              "currentQuantity": "1"
            },
            "lineItemId": "789",
            "subtotal": "19.99",
            "rightsReason": "Description of Other Reasons",
            "id": "201",
            "rightsReasonType": "1"
          }
        ],
        "refundId": "12345",
        "processedTime": "2023-05-20T10:00:00Z",
        "status": "1"
      }
    ],
    "totalTaxSet": {
      "shopMoney": {
        "amount": "8.50",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "8.50",
        "currencyCode": "USD"
      }
    },
    "marketId": "6016749228698",
    "lineItems": [
      {
        "priceSet": {
          "shopMoney": {
            "amount": "29.99",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "29.99",
            "currencyCode": "USD"
          }
        },
        "variantTitle": "Red",
        "discountAllocations": {
          "amount": "2.50",
          "discountApplicationIndex": "1",
          "amountSet": {
            "shopMoney": {
              "amount": "2.50",
              "currencyCode": "USD"
            },
            "presentmentMoney": {
              "amount": "2.50",
              "currencyCode": "USD"
            }
          }
        },
        "refundableQuantity": "1",
        "title": "Wireless Headphones",
        "fulfillableQuantity": "3",
        "extendedFields": {
          "value": "extendedFieldValue1",
          "key": "extendedFieldKey1"
        },
        "fulfillmentStatus": "fulfilled",
        "price": "29.99",
        "locationId": "456",
        "alreadyRightsNum": "1",
        "id": "987654",
        "variantId": "789012",
        "grams": "250",
        "sku": "ABC123-X",
        "currentQuantity": "1",
        "quantity": "2",
        "shippingLines": [
          {
            "priceSet": {
              "shopMoney": {
                "amount": "9.99",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "9.99",
                "currencyCode": "USD"
              }
            },
            "code": "EXPRESS",
            "discountedPrice": "7.99",
            "price": "9.99",
            "discountedPriceSet": {
              "shopMoney": {
                "amount": "7.99",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "7.99",
                "currencyCode": "USD"
              }
            },
            "taxLines": [
              {
                "priceSet": {
                  "shopMoney": {
                    "amount": "8.50",
                    "currencyCode": "USD"
                  },
                  "presentmentMoney": {
                    "amount": "8.50",
                    "currencyCode": "USD"
                  }
                },
                "rate": "10",
                "price": "8.50",
                "title": "VAT"
              }
            ]
          }
        ],
        "productId": "123456",
        "requiresShipping": "true",
        "giftCard": "false",
        "alreadyFulfillNum": "2",
        "totalDiscount": "3.50",
        "taxLines": [
          {
            "priceSet": {
              "shopMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              }
            },
            "rate": "10",
            "price": "8.50",
            "title": "VAT"
          }
        ],
        "totalDiscountSet": {
          "shopMoney": {
            "amount": "5.00",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "5.00",
            "currencyCode": "USD"
          }
        }
      }
    ],
    "totalTax": "8.50",
    "fulfillments": [
      {
        "lineItems": [
          {
            "fulfillmentOrderId": "456",
            "quantity": "2",
            "productId": "1001",
            "lineItemId": "789",
            "id": "101",
            "shopId": "123",
            "variantId": "2002"
          }
        ],
        "updatedTime": "2023-05-15T14:20:00Z",
        "orderId": "54321",
        "fulfillTime": "2023-05-15T14:20:00Z",
        "createdTime": "2023-05-15T10:30:00Z",
        "fulfillId": "98765",
        "status": "success"
      }
    ],
    "convertRate": "1.25",
    "totalPriceSet": {
      "shopMoney": {
        "amount": "110.25",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "110.25",
        "currencyCode": "USD"
      }
    },
    "createdTime": "2023-05-10T09:15:00Z",
    "currency": "USD",
    "totalDiscountsSet": {
      "shopMoney": {
        "amount": "10.25",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "10.25",
        "currencyCode": "USD"
      }
    },
    "id": "54321",
    "cancelReason": "customer",
    "subtotalPrice": "85.50",
    "email": "customer@example.com",
    "paymentTerms": [
      {
        "amount": "100.00",
        "paymentTermsName": "分期付款",
        "paymentId": "1",
        "channelTrxNo": "TRX123456",
        "currency": "CNY"
      }
    ],
    "subtotalPriceSet": {
      "shopMoney": {
        "amount": "85.50",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "85.50",
        "currencyCode": "USD"
      }
    },
    "app": "shopify",
    "updatedTime": "2023-05-15T16:30:00Z",
    "discountCodes": [
      {
        "amount": "25.00",
        "code": "SUMMER20",
        "type": "1"
      }
    ],
    "shippingLines": [
      {
        "priceSet": {
          "shopMoney": {
            "amount": "9.99",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "9.99",
            "currencyCode": "USD"
          }
        },
        "discountedPrice": "7.99",
        "price": "9.99",
        "id": "456",
        "source": "shopify",
        "title": "Express Shipping",
        "discountedPriceSet": {
          "shopMoney": {
            "amount": "7.99",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "7.99",
            "currencyCode": "USD"
          }
        },
        "taxLines": [
          {
            "priceSet": {
              "shopMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              }
            },
            "rate": "10",
            "price": "8.50",
            "title": "VAT"
          }
        ]
      }
    ],
    "totalShippingPriceSet": {
      "shopMoney": {
        "amount": "9.99",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "9.99",
        "currencyCode": "USD"
      }
    },
    "discountApplications": [
      {
        "code": "SAVE20",
        "targetType": "lineItem",
        "id": "da_12345",
        "title": "Summer Sale",
        "value": "15"
      }
    ],
    "totalShippingPrice": "9.99",
    "paidTime": "2023-05-15T10:30:00Z",
    "userId": "12345",
    "i18n": "{"language":"en", "country":"US"}",
    "tags": "urgent, gift",
    "processedTime": "2023-05-15T14:30:00Z",
    "phone": "+1234567890",
    "cancelledTime": "2023-05-15T10:30:00Z",
    "financialStatus": "paid",
    "totalWeight": "500",
    "shippingAddress": {
      "zip": "10001",
      "country": "USA",
      "lastName": "Smith",
      "address2": "Apt 3B",
      "city": "New York",
      "address1": "456 Oak Street",
      "provinceCode": "CA",
      "latitude": "40.7128",
      "firstName": "John",
      "province": "California",
      "phone": "+1234567890",
      "countryCode": "US",
      "name": "John Smith",
      "company": "XYZ Corporation",
      "longitude": "-74.0060"
    },
    "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",
      "company": "ABC Company",
      "longitude": "-75.6868"
    },
    "taxLines": [
      {
        "priceSet": {
          "shopMoney": {
            "amount": "8.50",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "8.50",
            "currencyCode": "USD"
          }
        },
        "rate": "10",
        "price": "8.50",
        "title": "VAT"
      }
    ],
    "customer": {
      "updatedTime": "2023-05-12T16:45:20Z",
      "lastName": "Smith",
      "note": "VIP customer with multiple purchases",
      "addresses": [
        {
          "zip": "200000",
          "country": "China",
          "lastName": "Doe",
          "address2": "Block A",
          "city": "Shanghai",
          "address1": "No.1 Road",
          "provinceCode": "SH",
          "firstName": "John",
          "isDefault": "true",
          "province": "Shanghai",
          "phone": "13800138000",
          "countryCode": "CN",
          "company": "Weimob",
          "countryName": "China"
        }
      ],
      "taxExempt": "false",
      "totalSpent": "542.75",
      "taxExemptions": [
        "VAT_EXEMPT"
      ],
      "tags": "loyal,repeat-customer",
      "firstName": "John",
      "ordersCount": "100",
      "phone": "+1234567890",
      "createdTime": "2023-01-15T10:30:00Z",
      "id": "12345",
      "email": "customer@example.com",
      "verifiedEmail": "true",
      "defaultAddress": {
        "zip": "200000",
        "country": "China",
        "lastName": "Doe",
        "address2": "Block A",
        "city": "Shanghai",
        "address1": "No.1 Road",
        "provinceCode": "SH",
        "firstName": "John",
        "isDefault": "true",
        "province": "Shanghai",
        "phone": "13800138000",
        "countryCode": "CN",
        "customerId": "123456",
        "company": "Weimob",
        "countryName": "China",
        "id": "123456"
      }
    }
  }
}

EVENT 订单更新

通知订单更新。

访问范围

需要以下任意访问权限: read_orders write_orders

消息

EVENT orders/update 

消息数据

orderobject
返回订单详细资料信息。
- 收起属性
billingAddressobject
与付款方式相关联的邮寄地址。此地址是一个可选字段,对于不需要付款方式的订单将不可用。
+ 展开属性
cancelReasonstring
订单被取消的原因。
cancelledTimestring
订单被取消的日期和时间。如果未取消订单,则返回 null。
closedTimestring
订单关闭的日期和时间(ISO 8601格式)。如果订单未关闭则返回 null。
createdTimestring
创建订单时自动生成的日期和时间(ISO 8601格式)。此属性的值不能更改。
currencystring
商店货币代码,三位代码。
customerobject
客户信息。
+ 展开属性
discountCodesarray
应用于订单的折扣列表。
+ 展开属性
emailstring
客户的电子邮件地址。
financialStatusstring
与订单相关的付款状态。枚举值:pending - 待支付;partiallyPaid - 部分支付;paid - 已支付。
fulfillmentsarray
履约单列表。
+ 展开属性
fulfillmentStatusstring
订单履约状态。枚举值:null - 未发货;partial - 部分发货;fulfilled - 已发货;canceled - 已取消。
lineItemsarray
订单项列表。
+ 展开属性
notestring
订单备注。
idnumber
订单号。
paymentTermsarray
支付项列表。
+ 展开属性
paymentGatewayNamesarray
订单支付方式列表。包括但不限于:CASH_ON_DELIVERY - 货到付款;MANUAL_METHOD - 手动支付。
phonestring
客户接收短信通知的电话号码。
shippingAddressobject
订单将被运送到的邮寄地址。此地址是可选的,将不可用于不需要送货的订单。
+ 展开属性
sourceIdentifierstring
在原始平台上的订单 ID。
subtotalPricestring
以商店货币表示的订单价格,扣除折扣后,不包括运费、关税、税金和小费。
tagsstring
附加到订单上的标记,格式为逗号分隔值的字符串。标签是额外的简短描述符,通常用于过滤和搜索。每个标签的长度限制为 40 个字符。
totalDiscountsstring
以商店货币表示的应用于订单价格的总折扣。
totalPricestring
以商店货币表示的所有行项目价格、折扣、运费、税和小费的总和
totalTaxstring
以商店货币表示的应用于订单的所有税目的价格总和,包括已退款和已取消的税目。
totalWeightstring
以克为单位的所有项目重量的总和。
updatedTimestring
最后一次修改订单的日期和时间。
paidTimestring
订单支付完成的日期和时间。
paymentTypestring
订单支付类型。枚举值:online - 线上支付;offline - 线下支付;noPayment - 无需支付;quick - 快捷支付。
convertRatenumber
汇率 市场货币->店铺货币。
totalDiscountsSetobject
总折扣金额价格集合。
+ 展开属性
discountApplicationsarray
折扣应用列表。
+ 展开属性
processedTimestring
处理时间。
refundsarray
售后列表。
+ 展开属性
shippingLinesarray
发货线路列表。
+ 展开属性
subtotalPriceSetobject
商品费用价格集合。
+ 展开属性
taxLinesarray
税费行列表。
+ 展开属性
totalPriceSetobject
总金额价格集合。
+ 展开属性
totalTaxSetobject
税费金额集合。
+ 展开属性
totalShippingPricestring
运费。
totalShippingPriceSetobject
运费金额集合。
+ 展开属性
userIdnumber
用户ID。
i18nstring
国际化信息。
shopCurrencystring
店铺货币。
appstring
应用标识。
typenumber
订单类型。枚举值:1 - 普通订单;11 - 外部创建订单。
extendedFieldsobject
订单扩展字段信息,Map类型。
+ 展开属性
marketIdnumber
市场的唯一标识符,订单所属市场。
json
{
  "order": {
    "note": "Please deliver after 6 PM",
    "sourceIdentifier": "WEB123456",
    "shopCurrency": "USD",
    "totalPrice": "110.25",
    "totalDiscounts": "10.25",
    "paymentGatewayNames": [
      "PayPal",
      "Credit Card"
    ],
    "type": "1",
    "extendedFields": {
      "value": "extendedFieldValue1",
      "key": "extendedFieldKey1"
    },
    "closedTime": "2023-05-20T14:45:30Z",
    "fulfillmentStatus": "fulfilled",
    "paymentType": "online",
    "refunds": [
      {
        "totalRefundShippingPrice": "5.99",
        "totalRefundPrice": "29.99",
        "refundLineItems": [
          {
            "totalTax": "1.50",
            "quantity": "1",
            "lineItem": {
              "quantity": "2",
              "productId": "123456",
              "refundableQuantity": "1",
              "title": "Wireless Headphones",
              "fulfillableQuantity": "12",
              "fulfillmentStatus": "fulfilled",
              "requiresShipping": "true",
              "price": "29.99",
              "locationId": "1",
              "alreadyRightsNum": "1",
              "alreadyFulfillNum": "2",
              "totalDiscount": "3.50",
              "id": "",
              "variantId": "789012",
              "grams": "250",
              "sku": "ABC123-X",
              "currentQuantity": "1"
            },
            "lineItemId": "789",
            "subtotal": "19.99",
            "rightsReason": "Description of Other Reasons",
            "id": "201",
            "rightsReasonType": "1"
          }
        ],
        "refundId": "12345",
        "processedTime": "2023-05-20T10:00:00Z",
        "status": "1"
      }
    ],
    "totalTaxSet": {
      "shopMoney": {
        "amount": "8.50",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "8.50",
        "currencyCode": "USD"
      }
    },
    "marketId": "6016749228698",
    "lineItems": [
      {
        "priceSet": {
          "shopMoney": {
            "amount": "29.99",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "29.99",
            "currencyCode": "USD"
          }
        },
        "variantTitle": "Red",
        "discountAllocations": {
          "amount": "2.50",
          "discountApplicationIndex": "1",
          "amountSet": {
            "shopMoney": {
              "amount": "2.50",
              "currencyCode": "USD"
            },
            "presentmentMoney": {
              "amount": "2.50",
              "currencyCode": "USD"
            }
          }
        },
        "refundableQuantity": "1",
        "title": "Wireless Headphones",
        "fulfillableQuantity": "3",
        "extendedFields": {
          "value": "extendedFieldValue1",
          "key": "extendedFieldKey1"
        },
        "fulfillmentStatus": "fulfilled",
        "price": "29.99",
        "locationId": "456",
        "alreadyRightsNum": "1",
        "id": "987654",
        "variantId": "789012",
        "grams": "250",
        "sku": "ABC123-X",
        "currentQuantity": "1",
        "quantity": "2",
        "shippingLines": [
          {
            "priceSet": {
              "shopMoney": {
                "amount": "9.99",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "9.99",
                "currencyCode": "USD"
              }
            },
            "code": "EXPRESS",
            "discountedPrice": "7.99",
            "price": "9.99",
            "discountedPriceSet": {
              "shopMoney": {
                "amount": "7.99",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "7.99",
                "currencyCode": "USD"
              }
            },
            "taxLines": [
              {
                "priceSet": {
                  "shopMoney": {
                    "amount": "8.50",
                    "currencyCode": "USD"
                  },
                  "presentmentMoney": {
                    "amount": "8.50",
                    "currencyCode": "USD"
                  }
                },
                "rate": "10",
                "price": "8.50",
                "title": "VAT"
              }
            ]
          }
        ],
        "productId": "123456",
        "requiresShipping": "true",
        "giftCard": "false",
        "alreadyFulfillNum": "2",
        "totalDiscount": "3.50",
        "taxLines": [
          {
            "priceSet": {
              "shopMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              }
            },
            "rate": "10",
            "price": "8.50",
            "title": "VAT"
          }
        ],
        "totalDiscountSet": {
          "shopMoney": {
            "amount": "5.00",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "5.00",
            "currencyCode": "USD"
          }
        }
      }
    ],
    "totalTax": "8.50",
    "fulfillments": [
      {
        "lineItems": [
          {
            "fulfillmentOrderId": "456",
            "quantity": "2",
            "productId": "1001",
            "lineItemId": "789",
            "id": "101",
            "shopId": "123",
            "variantId": "2002"
          }
        ],
        "updatedTime": "2023-05-15T14:20:00Z",
        "orderId": "54321",
        "fulfillTime": "2023-05-15T14:20:00Z",
        "createdTime": "2023-05-15T10:30:00Z",
        "fulfillId": "98765",
        "status": "success"
      }
    ],
    "convertRate": "1.25",
    "totalPriceSet": {
      "shopMoney": {
        "amount": "110.25",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "110.25",
        "currencyCode": "USD"
      }
    },
    "createdTime": "2023-05-10T09:15:00Z",
    "currency": "USD",
    "totalDiscountsSet": {
      "shopMoney": {
        "amount": "10.25",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "10.25",
        "currencyCode": "USD"
      }
    },
    "id": "54321",
    "cancelReason": "customer",
    "subtotalPrice": "85.50",
    "email": "customer@example.com",
    "paymentTerms": [
      {
        "amount": "100.00",
        "paymentTermsName": "分期付款",
        "paymentId": "1",
        "channelTrxNo": "TRX123456",
        "currency": "CNY"
      }
    ],
    "subtotalPriceSet": {
      "shopMoney": {
        "amount": "85.50",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "85.50",
        "currencyCode": "USD"
      }
    },
    "app": "shopify",
    "updatedTime": "2023-05-15T16:30:00Z",
    "discountCodes": [
      {
        "amount": "25.00",
        "code": "SUMMER20",
        "type": "1"
      }
    ],
    "shippingLines": [
      {
        "priceSet": {
          "shopMoney": {
            "amount": "9.99",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "9.99",
            "currencyCode": "USD"
          }
        },
        "discountedPrice": "7.99",
        "price": "9.99",
        "id": "456",
        "source": "shopify",
        "title": "Express Shipping",
        "discountedPriceSet": {
          "shopMoney": {
            "amount": "7.99",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "7.99",
            "currencyCode": "USD"
          }
        },
        "taxLines": [
          {
            "priceSet": {
              "shopMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              }
            },
            "rate": "10",
            "price": "8.50",
            "title": "VAT"
          }
        ]
      }
    ],
    "totalShippingPriceSet": {
      "shopMoney": {
        "amount": "9.99",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "9.99",
        "currencyCode": "USD"
      }
    },
    "discountApplications": [
      {
        "code": "SAVE20",
        "targetType": "lineItem",
        "id": "da_12345",
        "title": "Summer Sale",
        "value": "15"
      }
    ],
    "totalShippingPrice": "9.99",
    "paidTime": "2023-05-15T10:30:00Z",
    "userId": "12345",
    "i18n": "{\"language\":\"en\", \"country\":\"US\"}",
    "tags": "urgent, gift",
    "processedTime": "2023-05-15T14:30:00Z",
    "phone": "+1234567890",
    "cancelledTime": "2023-05-15T10:30:00Z",
    "financialStatus": "paid",
    "totalWeight": "500",
    "shippingAddress": {
      "zip": "10001",
      "country": "USA",
      "lastName": "Smith",
      "address2": "Apt 3B",
      "city": "New York",
      "address1": "456 Oak Street",
      "provinceCode": "CA",
      "latitude": "40.7128",
      "firstName": "John",
      "province": "California",
      "phone": "+1234567890",
      "countryCode": "US",
      "name": "John Smith",
      "company": "XYZ Corporation",
      "longitude": "-74.0060"
    },
    "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",
      "company": "ABC Company",
      "longitude": "-75.6868"
    },
    "taxLines": [
      {
        "priceSet": {
          "shopMoney": {
            "amount": "8.50",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "8.50",
            "currencyCode": "USD"
          }
        },
        "rate": "10",
        "price": "8.50",
        "title": "VAT"
      }
    ],
    "customer": {
      "updatedTime": "2023-05-12T16:45:20Z",
      "lastName": "Smith",
      "note": "VIP customer with multiple purchases",
      "addresses": [
        {
          "zip": "200000",
          "country": "China",
          "lastName": "Doe",
          "address2": "Block A",
          "city": "Shanghai",
          "address1": "No.1 Road",
          "provinceCode": "SH",
          "firstName": "John",
          "isDefault": "true",
          "province": "Shanghai",
          "phone": "13800138000",
          "countryCode": "CN",
          "company": "Weimob",
          "countryName": "China"
        }
      ],
      "taxExempt": "false",
      "totalSpent": "542.75",
      "taxExemptions": [
        "VAT_EXEMPT"
      ],
      "tags": "loyal,repeat-customer",
      "firstName": "John",
      "ordersCount": "100",
      "phone": "+1234567890",
      "createdTime": "2023-01-15T10:30:00Z",
      "id": "12345",
      "email": "customer@example.com",
      "verifiedEmail": "true",
      "defaultAddress": {
        "zip": "200000",
        "country": "China",
        "lastName": "Doe",
        "address2": "Block A",
        "city": "Shanghai",
        "address1": "No.1 Road",
        "provinceCode": "SH",
        "firstName": "John",
        "isDefault": "true",
        "province": "Shanghai",
        "phone": "13800138000",
        "countryCode": "CN",
        "customerId": "123456",
        "company": "Weimob",
        "countryName": "China",
        "id": "123456"
      }
    }
  }
}

EVENT 订单创建

通知订单创建。

访问范围

需要以下任意访问权限: read_orders write_orders

消息

EVENT orders/create 

消息数据

orderobject
返回订单详细资料信息。
- 收起属性
billingAddressobject
与付款方式相关联的邮寄地址。此地址是一个可选字段,对于不需要付款方式的订单将不可用。
+ 展开属性
cancelReasonstring
订单被取消的原因。
cancelledTimestring
订单被取消的日期和时间。如果未取消订单,则返回 null。
closedTimestring
订单关闭的日期和时间(ISO 8601格式)。如果订单未关闭则返回 null。
createdTimestring
创建订单时自动生成的日期和时间(ISO 8601格式)。此属性的值不能更改。
currencystring
商店货币代码,三位代码。
customerobject
客户信息。
+ 展开属性
discountCodesarray
应用于订单的折扣列表。
+ 展开属性
emailstring
客户的电子邮件地址。
financialStatusstring
与订单相关的付款状态。枚举值:pending - 待支付;partiallyPaid - 部分支付;paid - 已支付。
fulfillmentsarray
履约单列表。
+ 展开属性
fulfillmentStatusstring
订单履约状态。枚举值:null - 未发货;partial - 部分发货;fulfilled - 已发货;canceled - 已取消。
lineItemsarray
订单项列表。
+ 展开属性
notestring
订单备注。
idnumber
订单号。
paymentTermsarray
支付项列表。
+ 展开属性
paymentGatewayNamesarray
订单支付方式列表。包括但不限于:CASH_ON_DELIVERY - 货到付款;MANUAL_METHOD - 手动支付。
phonestring
客户接收短信通知的电话号码。
shippingAddressobject
订单将被运送到的邮寄地址。此地址是可选的,将不可用于不需要送货的订单。
+ 展开属性
sourceIdentifierstring
在原始平台上的订单 ID。
subtotalPricestring
以商店货币表示的订单价格,扣除折扣后,不包括运费、关税、税金和小费。
tagsstring
附加到订单上的标记,格式为逗号分隔值的字符串。标签是额外的简短描述符,通常用于过滤和搜索。每个标签的长度限制为 40 个字符。
totalDiscountsstring
以商店货币表示的应用于订单价格的总折扣。
totalPricestring
以商店货币表示的所有行项目价格、折扣、运费、税和小费的总和
totalTaxstring
以商店货币表示的应用于订单的所有税目的价格总和,包括已退款和已取消的税目。
totalWeightstring
以克为单位的所有项目重量的总和。
updatedTimestring
最后一次修改订单的日期和时间。
paidTimestring
订单支付完成的日期和时间。
paymentTypestring
订单支付类型。枚举值:online - 线上支付;offline - 线下支付;noPayment - 无需支付;quick - 快捷支付。
convertRatenumber
汇率 市场货币->店铺货币。
totalDiscountsSetobject
总折扣金额价格集合。
+ 展开属性
discountApplicationsarray
折扣应用列表。
+ 展开属性
processedTimestring
处理时间。
refundsarray
售后列表。
+ 展开属性
shippingLinesarray
发货线路列表。
+ 展开属性
subtotalPriceSetobject
商品费用价格集合。
+ 展开属性
taxLinesarray
税费行列表。
+ 展开属性
totalPriceSetobject
总金额价格集合。
+ 展开属性
totalTaxSetobject
税费金额集合。
+ 展开属性
totalShippingPricestring
运费。
totalShippingPriceSetobject
运费金额集合。
+ 展开属性
userIdnumber
用户ID。
i18nstring
国际化信息。
shopCurrencystring
店铺货币。
appstring
应用标识。
typenumber
订单类型。枚举值:1 - 普通订单;11 - 外部创建订单。
extendedFieldsobject
订单扩展字段信息,Map类型。
+ 展开属性
marketIdnumber
市场的唯一标识符,订单所属市场。
json
{
  "order": {
    "note": "Please deliver after 6 PM",
    "sourceIdentifier": "WEB123456",
    "shopCurrency": "USD",
    "totalPrice": "110.25",
    "totalDiscounts": "10.25",
    "paymentGatewayNames": [
      "PayPal",
      "Credit Card"
    ],
    "type": "1",
    "extendedFields": {
      "value": "extendedFieldValue1",
      "key": "extendedFieldKey1"
    },
    "closedTime": "2023-05-20T14:45:30Z",
    "fulfillmentStatus": "fulfilled",
    "paymentType": "online",
    "refunds": [
      {
        "totalRefundShippingPrice": "5.99",
        "totalRefundPrice": "29.99",
        "refundLineItems": [
          {
            "totalTax": "1.50",
            "quantity": "1",
            "lineItem": {
              "quantity": "2",
              "productId": "123456",
              "refundableQuantity": "1",
              "title": "Wireless Headphones",
              "fulfillableQuantity": "12",
              "fulfillmentStatus": "fulfilled",
              "requiresShipping": "true",
              "price": "29.99",
              "locationId": "1",
              "alreadyRightsNum": "1",
              "alreadyFulfillNum": "2",
              "totalDiscount": "3.50",
              "id": "",
              "variantId": "789012",
              "grams": "250",
              "sku": "ABC123-X",
              "currentQuantity": "1"
            },
            "lineItemId": "789",
            "subtotal": "19.99",
            "rightsReason": "Description of Other Reasons",
            "id": "201",
            "rightsReasonType": "1"
          }
        ],
        "refundId": "12345",
        "processedTime": "2023-05-20T10:00:00Z",
        "status": "1"
      }
    ],
    "totalTaxSet": {
      "shopMoney": {
        "amount": "8.50",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "8.50",
        "currencyCode": "USD"
      }
    },
    "marketId": "6016749228698",
    "lineItems": [
      {
        "priceSet": {
          "shopMoney": {
            "amount": "29.99",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "29.99",
            "currencyCode": "USD"
          }
        },
        "variantTitle": "Red",
        "discountAllocations": {
          "amount": "2.50",
          "discountApplicationIndex": "1",
          "amountSet": {
            "shopMoney": {
              "amount": "2.50",
              "currencyCode": "USD"
            },
            "presentmentMoney": {
              "amount": "2.50",
              "currencyCode": "USD"
            }
          }
        },
        "refundableQuantity": "1",
        "title": "Wireless Headphones",
        "fulfillableQuantity": "3",
        "extendedFields": {
          "value": "extendedFieldValue1",
          "key": "extendedFieldKey1"
        },
        "fulfillmentStatus": "fulfilled",
        "price": "29.99",
        "locationId": "456",
        "alreadyRightsNum": "1",
        "id": "987654",
        "variantId": "789012",
        "grams": "250",
        "sku": "ABC123-X",
        "currentQuantity": "1",
        "quantity": "2",
        "shippingLines": [
          {
            "priceSet": {
              "shopMoney": {
                "amount": "9.99",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "9.99",
                "currencyCode": "USD"
              }
            },
            "code": "EXPRESS",
            "discountedPrice": "7.99",
            "price": "9.99",
            "discountedPriceSet": {
              "shopMoney": {
                "amount": "7.99",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "7.99",
                "currencyCode": "USD"
              }
            },
            "taxLines": [
              {
                "priceSet": {
                  "shopMoney": {
                    "amount": "8.50",
                    "currencyCode": "USD"
                  },
                  "presentmentMoney": {
                    "amount": "8.50",
                    "currencyCode": "USD"
                  }
                },
                "rate": "10",
                "price": "8.50",
                "title": "VAT"
              }
            ]
          }
        ],
        "productId": "123456",
        "requiresShipping": "true",
        "giftCard": "false",
        "alreadyFulfillNum": "2",
        "totalDiscount": "3.50",
        "taxLines": [
          {
            "priceSet": {
              "shopMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              }
            },
            "rate": "10",
            "price": "8.50",
            "title": "VAT"
          }
        ],
        "totalDiscountSet": {
          "shopMoney": {
            "amount": "5.00",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "5.00",
            "currencyCode": "USD"
          }
        }
      }
    ],
    "totalTax": "8.50",
    "fulfillments": [
      {
        "lineItems": [
          {
            "fulfillmentOrderId": "456",
            "quantity": "2",
            "productId": "1001",
            "lineItemId": "789",
            "id": "101",
            "shopId": "123",
            "variantId": "2002"
          }
        ],
        "updatedTime": "2023-05-15T14:20:00Z",
        "orderId": "54321",
        "fulfillTime": "2023-05-15T14:20:00Z",
        "createdTime": "2023-05-15T10:30:00Z",
        "fulfillId": "98765",
        "status": "success"
      }
    ],
    "convertRate": "1.25",
    "totalPriceSet": {
      "shopMoney": {
        "amount": "110.25",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "110.25",
        "currencyCode": "USD"
      }
    },
    "createdTime": "2023-05-10T09:15:00Z",
    "currency": "USD",
    "totalDiscountsSet": {
      "shopMoney": {
        "amount": "10.25",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "10.25",
        "currencyCode": "USD"
      }
    },
    "id": "54321",
    "cancelReason": "customer",
    "subtotalPrice": "85.50",
    "email": "customer@example.com",
    "paymentTerms": [
      {
        "amount": "100.00",
        "paymentTermsName": "分期付款",
        "paymentId": "1",
        "channelTrxNo": "TRX123456",
        "currency": "CNY"
      }
    ],
    "subtotalPriceSet": {
      "shopMoney": {
        "amount": "85.50",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "85.50",
        "currencyCode": "USD"
      }
    },
    "app": "shopify",
    "updatedTime": "2023-05-15T16:30:00Z",
    "discountCodes": [
      {
        "amount": "25.00",
        "code": "SUMMER20",
        "type": "1"
      }
    ],
    "shippingLines": [
      {
        "priceSet": {
          "shopMoney": {
            "amount": "9.99",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "9.99",
            "currencyCode": "USD"
          }
        },
        "discountedPrice": "7.99",
        "price": "9.99",
        "id": "456",
        "source": "shopify",
        "title": "Express Shipping",
        "discountedPriceSet": {
          "shopMoney": {
            "amount": "7.99",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "7.99",
            "currencyCode": "USD"
          }
        },
        "taxLines": [
          {
            "priceSet": {
              "shopMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              }
            },
            "rate": "10",
            "price": "8.50",
            "title": "VAT"
          }
        ]
      }
    ],
    "totalShippingPriceSet": {
      "shopMoney": {
        "amount": "9.99",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "9.99",
        "currencyCode": "USD"
      }
    },
    "discountApplications": [
      {
        "code": "SAVE20",
        "targetType": "lineItem",
        "id": "da_12345",
        "title": "Summer Sale",
        "value": "15"
      }
    ],
    "totalShippingPrice": "9.99",
    "paidTime": "2023-05-15T10:30:00Z",
    "userId": "12345",
    "i18n": "{\"language\":\"en\", \"country\":\"US\"}",
    "tags": "urgent, gift",
    "processedTime": "2023-05-15T14:30:00Z",
    "phone": "+1234567890",
    "cancelledTime": "2023-05-15T10:30:00Z",
    "financialStatus": "paid",
    "totalWeight": "500",
    "shippingAddress": {
      "zip": "10001",
      "country": "USA",
      "lastName": "Smith",
      "address2": "Apt 3B",
      "city": "New York",
      "address1": "456 Oak Street",
      "provinceCode": "CA",
      "latitude": "40.7128",
      "firstName": "John",
      "province": "California",
      "phone": "+1234567890",
      "countryCode": "US",
      "name": "John Smith",
      "company": "XYZ Corporation",
      "longitude": "-74.0060"
    },
    "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",
      "company": "ABC Company",
      "longitude": "-75.6868"
    },
    "taxLines": [
      {
        "priceSet": {
          "shopMoney": {
            "amount": "8.50",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "8.50",
            "currencyCode": "USD"
          }
        },
        "rate": "10",
        "price": "8.50",
        "title": "VAT"
      }
    ],
    "customer": {
      "updatedTime": "2023-05-12T16:45:20Z",
      "lastName": "Smith",
      "note": "VIP customer with multiple purchases",
      "addresses": [
        {
          "zip": "200000",
          "country": "China",
          "lastName": "Doe",
          "address2": "Block A",
          "city": "Shanghai",
          "address1": "No.1 Road",
          "provinceCode": "SH",
          "firstName": "John",
          "isDefault": "true",
          "province": "Shanghai",
          "phone": "13800138000",
          "countryCode": "CN",
          "company": "Weimob",
          "countryName": "China"
        }
      ],
      "taxExempt": "false",
      "totalSpent": "542.75",
      "taxExemptions": [
        "VAT_EXEMPT"
      ],
      "tags": "loyal,repeat-customer",
      "firstName": "John",
      "ordersCount": "100",
      "phone": "+1234567890",
      "createdTime": "2023-01-15T10:30:00Z",
      "id": "12345",
      "email": "customer@example.com",
      "verifiedEmail": "true",
      "defaultAddress": {
        "zip": "200000",
        "country": "China",
        "lastName": "Doe",
        "address2": "Block A",
        "city": "Shanghai",
        "address1": "No.1 Road",
        "provinceCode": "SH",
        "firstName": "John",
        "isDefault": "true",
        "province": "Shanghai",
        "phone": "13800138000",
        "countryCode": "CN",
        "customerId": "123456",
        "company": "Weimob",
        "countryName": "China",
        "id": "123456"
      }
    }
  }
}

EVENT 订单支付

通知订单已支付。

访问范围

需要以下任意访问权限: read_orders write_orders

消息

EVENT orders/paid 

消息数据

orderobject
返回订单详细资料信息。
- 收起属性
billingAddressobject
与付款方式相关联的邮寄地址。此地址是一个可选字段,对于不需要付款方式的订单将不可用。
+ 展开属性
cancelReasonstring
订单被取消的原因。
cancelledTimestring
订单被取消的日期和时间。如果未取消订单,则返回 null。
closedTimestring
订单关闭的日期和时间(ISO 8601格式)。如果订单未关闭则返回 null。
createdTimestring
创建订单时自动生成的日期和时间(ISO 8601格式)。此属性的值不能更改。
currencystring
商店货币代码,三位代码。
customerobject
客户信息。
+ 展开属性
discountCodesarray
应用于订单的折扣列表。
+ 展开属性
emailstring
客户的电子邮件地址。
financialStatusstring
与订单相关的付款状态。枚举值:pending - 待支付;partiallyPaid - 部分支付;paid - 已支付。
fulfillmentsarray
履约单列表。
+ 展开属性
fulfillmentStatusstring
订单履约状态。枚举值:null - 未发货;partial - 部分发货;fulfilled - 已发货;canceled - 已取消。
lineItemsarray
订单项列表。
+ 展开属性
notestring
订单备注。
idnumber
订单号。
paymentTermsarray
支付项列表。
+ 展开属性
paymentGatewayNamesarray
订单支付方式列表。包括但不限于:CASH_ON_DELIVERY - 货到付款;MANUAL_METHOD - 手动支付。
phonestring
客户接收短信通知的电话号码。
shippingAddressobject
订单将被运送到的邮寄地址。此地址是可选的,将不可用于不需要送货的订单。
+ 展开属性
sourceIdentifierstring
在原始平台上的订单 ID。
subtotalPricestring
以商店货币表示的订单价格,扣除折扣后,不包括运费、关税、税金和小费。
tagsstring
附加到订单上的标记,格式为逗号分隔值的字符串。标签是额外的简短描述符,通常用于过滤和搜索。每个标签的长度限制为 40 个字符。
totalDiscountsstring
以商店货币表示的应用于订单价格的总折扣。
totalPricestring
以商店货币表示的所有行项目价格、折扣、运费、税和小费的总和
totalTaxstring
以商店货币表示的应用于订单的所有税目的价格总和,包括已退款和已取消的税目。
totalWeightstring
以克为单位的所有项目重量的总和。
updatedTimestring
最后一次修改订单的日期和时间。
paidTimestring
订单支付完成的日期和时间。
paymentTypestring
订单支付类型。枚举值:online - 线上支付;offline - 线下支付;noPayment - 无需支付;quick - 快捷支付。
convertRatenumber
汇率 市场货币->店铺货币。
totalDiscountsSetobject
总折扣金额价格集合。
+ 展开属性
discountApplicationsarray
折扣应用列表。
+ 展开属性
processedTimestring
处理时间。
refundsarray
售后列表。
+ 展开属性
shippingLinesarray
发货线路列表。
+ 展开属性
subtotalPriceSetobject
商品费用价格集合。
+ 展开属性
taxLinesarray
税费行列表。
+ 展开属性
totalPriceSetobject
总金额价格集合。
+ 展开属性
totalTaxSetobject
税费金额集合。
+ 展开属性
totalShippingPricestring
运费。
totalShippingPriceSetobject
运费金额集合。
+ 展开属性
userIdnumber
用户ID。
i18nstring
国际化信息。
shopCurrencystring
店铺货币。
appstring
应用标识。
typenumber
订单类型。枚举值:1 - 普通订单;11 - 外部创建订单。
extendedFieldsobject
订单扩展字段信息,Map类型。
+ 展开属性
marketIdnumber
市场的唯一标识符,订单所属市场。
json
{
  "order": {
    "note": "Please deliver after 6 PM",
    "sourceIdentifier": "WEB123456",
    "shopCurrency": "USD",
    "totalPrice": "110.25",
    "totalDiscounts": "10.25",
    "paymentGatewayNames": [
      "PayPal",
      "Credit Card"
    ],
    "type": "1",
    "extendedFields": {
      "value": "extendedFieldValue1",
      "key": "extendedFieldKey1"
    },
    "closedTime": "2023-05-20T14:45:30Z",
    "fulfillmentStatus": "fulfilled",
    "paymentType": "online",
    "refunds": [
      {
        "totalRefundShippingPrice": "5.99",
        "totalRefundPrice": "29.99",
        "refundLineItems": [
          {
            "totalTax": "1.50",
            "quantity": "1",
            "lineItem": {
              "quantity": "2",
              "productId": "123456",
              "refundableQuantity": "1",
              "title": "Wireless Headphones",
              "fulfillableQuantity": "12",
              "fulfillmentStatus": "fulfilled",
              "requiresShipping": "true",
              "price": "29.99",
              "locationId": "1",
              "alreadyRightsNum": "1",
              "alreadyFulfillNum": "2",
              "totalDiscount": "3.50",
              "id": "",
              "variantId": "789012",
              "grams": "250",
              "sku": "ABC123-X",
              "currentQuantity": "1"
            },
            "lineItemId": "789",
            "subtotal": "19.99",
            "rightsReason": "Description of Other Reasons",
            "id": "201",
            "rightsReasonType": "1"
          }
        ],
        "refundId": "12345",
        "processedTime": "2023-05-20T10:00:00Z",
        "status": "1"
      }
    ],
    "totalTaxSet": {
      "shopMoney": {
        "amount": "8.50",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "8.50",
        "currencyCode": "USD"
      }
    },
    "marketId": "6016749228698",
    "lineItems": [
      {
        "priceSet": {
          "shopMoney": {
            "amount": "29.99",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "29.99",
            "currencyCode": "USD"
          }
        },
        "variantTitle": "Red",
        "discountAllocations": {
          "amount": "2.50",
          "discountApplicationIndex": "1",
          "amountSet": {
            "shopMoney": {
              "amount": "2.50",
              "currencyCode": "USD"
            },
            "presentmentMoney": {
              "amount": "2.50",
              "currencyCode": "USD"
            }
          }
        },
        "refundableQuantity": "1",
        "title": "Wireless Headphones",
        "fulfillableQuantity": "3",
        "extendedFields": {
          "value": "extendedFieldValue1",
          "key": "extendedFieldKey1"
        },
        "fulfillmentStatus": "fulfilled",
        "price": "29.99",
        "locationId": "456",
        "alreadyRightsNum": "1",
        "id": "987654",
        "variantId": "789012",
        "grams": "250",
        "sku": "ABC123-X",
        "currentQuantity": "1",
        "quantity": "2",
        "shippingLines": [
          {
            "priceSet": {
              "shopMoney": {
                "amount": "9.99",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "9.99",
                "currencyCode": "USD"
              }
            },
            "code": "EXPRESS",
            "discountedPrice": "7.99",
            "price": "9.99",
            "discountedPriceSet": {
              "shopMoney": {
                "amount": "7.99",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "7.99",
                "currencyCode": "USD"
              }
            },
            "taxLines": [
              {
                "priceSet": {
                  "shopMoney": {
                    "amount": "8.50",
                    "currencyCode": "USD"
                  },
                  "presentmentMoney": {
                    "amount": "8.50",
                    "currencyCode": "USD"
                  }
                },
                "rate": "10",
                "price": "8.50",
                "title": "VAT"
              }
            ]
          }
        ],
        "productId": "123456",
        "requiresShipping": "true",
        "giftCard": "false",
        "alreadyFulfillNum": "2",
        "totalDiscount": "3.50",
        "taxLines": [
          {
            "priceSet": {
              "shopMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              }
            },
            "rate": "10",
            "price": "8.50",
            "title": "VAT"
          }
        ],
        "totalDiscountSet": {
          "shopMoney": {
            "amount": "5.00",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "5.00",
            "currencyCode": "USD"
          }
        }
      }
    ],
    "totalTax": "8.50",
    "fulfillments": [
      {
        "lineItems": [
          {
            "fulfillmentOrderId": "456",
            "quantity": "2",
            "productId": "1001",
            "lineItemId": "789",
            "id": "101",
            "shopId": "123",
            "variantId": "2002"
          }
        ],
        "updatedTime": "2023-05-15T14:20:00Z",
        "orderId": "54321",
        "fulfillTime": "2023-05-15T14:20:00Z",
        "createdTime": "2023-05-15T10:30:00Z",
        "fulfillId": "98765",
        "status": "success"
      }
    ],
    "convertRate": "1.25",
    "totalPriceSet": {
      "shopMoney": {
        "amount": "110.25",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "110.25",
        "currencyCode": "USD"
      }
    },
    "createdTime": "2023-05-10T09:15:00Z",
    "currency": "USD",
    "totalDiscountsSet": {
      "shopMoney": {
        "amount": "10.25",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "10.25",
        "currencyCode": "USD"
      }
    },
    "id": "54321",
    "cancelReason": "customer",
    "subtotalPrice": "85.50",
    "email": "customer@example.com",
    "paymentTerms": [
      {
        "amount": "100.00",
        "paymentTermsName": "分期付款",
        "paymentId": "1",
        "channelTrxNo": "TRX123456",
        "currency": "CNY"
      }
    ],
    "subtotalPriceSet": {
      "shopMoney": {
        "amount": "85.50",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "85.50",
        "currencyCode": "USD"
      }
    },
    "app": "shopify",
    "updatedTime": "2023-05-15T16:30:00Z",
    "discountCodes": [
      {
        "amount": "25.00",
        "code": "SUMMER20",
        "type": "1"
      }
    ],
    "shippingLines": [
      {
        "priceSet": {
          "shopMoney": {
            "amount": "9.99",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "9.99",
            "currencyCode": "USD"
          }
        },
        "discountedPrice": "7.99",
        "price": "9.99",
        "id": "456",
        "source": "shopify",
        "title": "Express Shipping",
        "discountedPriceSet": {
          "shopMoney": {
            "amount": "7.99",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "7.99",
            "currencyCode": "USD"
          }
        },
        "taxLines": [
          {
            "priceSet": {
              "shopMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              }
            },
            "rate": "10",
            "price": "8.50",
            "title": "VAT"
          }
        ]
      }
    ],
    "totalShippingPriceSet": {
      "shopMoney": {
        "amount": "9.99",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "9.99",
        "currencyCode": "USD"
      }
    },
    "discountApplications": [
      {
        "code": "SAVE20",
        "targetType": "lineItem",
        "id": "da_12345",
        "title": "Summer Sale",
        "value": "15"
      }
    ],
    "totalShippingPrice": "9.99",
    "paidTime": "2023-05-15T10:30:00Z",
    "userId": "12345",
    "i18n": "{\"language\":\"en\", \"country\":\"US\"}",
    "tags": "urgent, gift",
    "processedTime": "2023-05-15T14:30:00Z",
    "phone": "+1234567890",
    "cancelledTime": "2023-05-15T10:30:00Z",
    "financialStatus": "paid",
    "totalWeight": "500",
    "shippingAddress": {
      "zip": "10001",
      "country": "USA",
      "lastName": "Smith",
      "address2": "Apt 3B",
      "city": "New York",
      "address1": "456 Oak Street",
      "provinceCode": "CA",
      "latitude": "40.7128",
      "firstName": "John",
      "province": "California",
      "phone": "+1234567890",
      "countryCode": "US",
      "name": "John Smith",
      "company": "XYZ Corporation",
      "longitude": "-74.0060"
    },
    "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",
      "company": "ABC Company",
      "longitude": "-75.6868"
    },
    "taxLines": [
      {
        "priceSet": {
          "shopMoney": {
            "amount": "8.50",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "8.50",
            "currencyCode": "USD"
          }
        },
        "rate": "10",
        "price": "8.50",
        "title": "VAT"
      }
    ],
    "customer": {
      "updatedTime": "2023-05-12T16:45:20Z",
      "lastName": "Smith",
      "note": "VIP customer with multiple purchases",
      "addresses": [
        {
          "zip": "200000",
          "country": "China",
          "lastName": "Doe",
          "address2": "Block A",
          "city": "Shanghai",
          "address1": "No.1 Road",
          "provinceCode": "SH",
          "firstName": "John",
          "isDefault": "true",
          "province": "Shanghai",
          "phone": "13800138000",
          "countryCode": "CN",
          "company": "Weimob",
          "countryName": "China"
        }
      ],
      "taxExempt": "false",
      "totalSpent": "542.75",
      "taxExemptions": [
        "VAT_EXEMPT"
      ],
      "tags": "loyal,repeat-customer",
      "firstName": "John",
      "ordersCount": "100",
      "phone": "+1234567890",
      "createdTime": "2023-01-15T10:30:00Z",
      "id": "12345",
      "email": "customer@example.com",
      "verifiedEmail": "true",
      "defaultAddress": {
        "zip": "200000",
        "country": "China",
        "lastName": "Doe",
        "address2": "Block A",
        "city": "Shanghai",
        "address1": "No.1 Road",
        "provinceCode": "SH",
        "firstName": "John",
        "isDefault": "true",
        "province": "Shanghai",
        "phone": "13800138000",
        "countryCode": "CN",
        "customerId": "123456",
        "company": "Weimob",
        "countryName": "China",
        "id": "123456"
      }
    }
  }
}

EVENT 订单履约

通知订单已履约

访问范围

需要以下任意访问权限: read_orders write_orders

消息

EVENT orders/fulfilled 

消息数据

orderobject
返回订单详细资料信息。
- 收起属性
billingAddressobject
与付款方式相关联的邮寄地址。此地址是一个可选字段,对于不需要付款方式的订单将不可用。
+ 展开属性
cancelReasonstring
订单被取消的原因。
cancelledTimestring
订单被取消的日期和时间。如果未取消订单,则返回 null。
closedTimestring
订单关闭的日期和时间(ISO 8601格式)。如果订单未关闭则返回 null。
createdTimestring
创建订单时自动生成的日期和时间(ISO 8601格式)。此属性的值不能更改。
currencystring
商店货币代码,三位代码。
customerobject
客户信息。
+ 展开属性
discountCodesarray
应用于订单的折扣列表。
+ 展开属性
emailstring
客户的电子邮件地址。
financialStatusstring
与订单相关的付款状态。枚举值:pending - 待支付;partiallyPaid - 部分支付;paid - 已支付。
fulfillmentsarray
履约单列表。
+ 展开属性
fulfillmentStatusstring
订单履约状态。枚举值:null - 未发货;partial - 部分发货;fulfilled - 已发货;canceled - 已取消。
lineItemsarray
订单项列表。
+ 展开属性
notestring
订单备注。
idnumber
订单号。
paymentTermsarray
支付项列表。
+ 展开属性
paymentGatewayNamesarray
订单支付方式列表。包括但不限于:CASH_ON_DELIVERY - 货到付款;MANUAL_METHOD - 手动支付。
phonestring
客户接收短信通知的电话号码。
shippingAddressobject
订单将被运送到的邮寄地址。此地址是可选的,将不可用于不需要送货的订单。
+ 展开属性
sourceIdentifierstring
在原始平台上的订单 ID。
subtotalPricestring
以商店货币表示的订单价格,扣除折扣后,不包括运费、关税、税金和小费。
tagsstring
附加到订单上的标记,格式为逗号分隔值的字符串。标签是额外的简短描述符,通常用于过滤和搜索。每个标签的长度限制为 40 个字符。
totalDiscountsstring
以商店货币表示的应用于订单价格的总折扣。
totalPricestring
以商店货币表示的所有行项目价格、折扣、运费、税和小费的总和
totalTaxstring
以商店货币表示的应用于订单的所有税目的价格总和,包括已退款和已取消的税目。
totalWeightstring
以克为单位的所有项目重量的总和。
updatedTimestring
最后一次修改订单的日期和时间。
paidTimestring
订单支付完成的日期和时间。
paymentTypestring
订单支付类型。枚举值:online - 线上支付;offline - 线下支付;noPayment - 无需支付;quick - 快捷支付。
convertRatenumber
汇率 市场货币->店铺货币。
totalDiscountsSetobject
总折扣金额价格集合。
+ 展开属性
discountApplicationsarray
折扣应用列表。
+ 展开属性
processedTimestring
处理时间。
refundsarray
售后列表。
+ 展开属性
shippingLinesarray
发货线路列表。
+ 展开属性
subtotalPriceSetobject
商品费用价格集合。
+ 展开属性
taxLinesarray
税费行列表。
+ 展开属性
totalPriceSetobject
总金额价格集合。
+ 展开属性
totalTaxSetobject
税费金额集合。
+ 展开属性
totalShippingPricestring
运费。
totalShippingPriceSetobject
运费金额集合。
+ 展开属性
userIdnumber
用户ID。
i18nstring
国际化信息。
shopCurrencystring
店铺货币。
appstring
应用标识。
typenumber
订单类型。枚举值:1 - 普通订单;11 - 外部创建订单。
extendedFieldsobject
订单扩展字段信息,Map类型。
+ 展开属性
marketIdnumber
市场的唯一标识符,订单所属市场。
json
{
  "order": {
    "note": "Please deliver after 6 PM",
    "sourceIdentifier": "WEB123456",
    "shopCurrency": "USD",
    "totalPrice": "110.25",
    "totalDiscounts": "10.25",
    "paymentGatewayNames": [
      "PayPal",
      "Credit Card"
    ],
    "type": "1",
    "extendedFields": {
      "value": "extendedFieldValue1",
      "key": "extendedFieldKey1"
    },
    "closedTime": "2023-05-20T14:45:30Z",
    "fulfillmentStatus": "fulfilled",
    "paymentType": "online",
    "refunds": [
      {
        "totalRefundShippingPrice": "5.99",
        "totalRefundPrice": "29.99",
        "refundLineItems": [
          {
            "totalTax": "1.50",
            "quantity": "1",
            "lineItem": {
              "quantity": "2",
              "productId": "123456",
              "refundableQuantity": "1",
              "title": "Wireless Headphones",
              "fulfillableQuantity": "12",
              "fulfillmentStatus": "fulfilled",
              "requiresShipping": "true",
              "price": "29.99",
              "locationId": "1",
              "alreadyRightsNum": "1",
              "alreadyFulfillNum": "2",
              "totalDiscount": "3.50",
              "id": "",
              "variantId": "789012",
              "grams": "250",
              "sku": "ABC123-X",
              "currentQuantity": "1"
            },
            "lineItemId": "789",
            "subtotal": "19.99",
            "rightsReason": "Description of Other Reasons",
            "id": "201",
            "rightsReasonType": "1"
          }
        ],
        "refundId": "12345",
        "processedTime": "2023-05-20T10:00:00Z",
        "status": "1"
      }
    ],
    "totalTaxSet": {
      "shopMoney": {
        "amount": "8.50",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "8.50",
        "currencyCode": "USD"
      }
    },
    "marketId": "6016749228698",
    "lineItems": [
      {
        "priceSet": {
          "shopMoney": {
            "amount": "29.99",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "29.99",
            "currencyCode": "USD"
          }
        },
        "variantTitle": "Red",
        "discountAllocations": {
          "amount": "2.50",
          "discountApplicationIndex": "1",
          "amountSet": {
            "shopMoney": {
              "amount": "2.50",
              "currencyCode": "USD"
            },
            "presentmentMoney": {
              "amount": "2.50",
              "currencyCode": "USD"
            }
          }
        },
        "refundableQuantity": "1",
        "title": "Wireless Headphones",
        "fulfillableQuantity": "3",
        "extendedFields": {
          "value": "extendedFieldValue1",
          "key": "extendedFieldKey1"
        },
        "fulfillmentStatus": "fulfilled",
        "price": "29.99",
        "locationId": "456",
        "alreadyRightsNum": "1",
        "id": "987654",
        "variantId": "789012",
        "grams": "250",
        "sku": "ABC123-X",
        "currentQuantity": "1",
        "quantity": "2",
        "shippingLines": [
          {
            "priceSet": {
              "shopMoney": {
                "amount": "9.99",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "9.99",
                "currencyCode": "USD"
              }
            },
            "code": "EXPRESS",
            "discountedPrice": "7.99",
            "price": "9.99",
            "discountedPriceSet": {
              "shopMoney": {
                "amount": "7.99",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "7.99",
                "currencyCode": "USD"
              }
            },
            "taxLines": [
              {
                "priceSet": {
                  "shopMoney": {
                    "amount": "8.50",
                    "currencyCode": "USD"
                  },
                  "presentmentMoney": {
                    "amount": "8.50",
                    "currencyCode": "USD"
                  }
                },
                "rate": "10",
                "price": "8.50",
                "title": "VAT"
              }
            ]
          }
        ],
        "productId": "123456",
        "requiresShipping": "true",
        "giftCard": "false",
        "alreadyFulfillNum": "2",
        "totalDiscount": "3.50",
        "taxLines": [
          {
            "priceSet": {
              "shopMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              }
            },
            "rate": "10",
            "price": "8.50",
            "title": "VAT"
          }
        ],
        "totalDiscountSet": {
          "shopMoney": {
            "amount": "5.00",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "5.00",
            "currencyCode": "USD"
          }
        }
      }
    ],
    "totalTax": "8.50",
    "fulfillments": [
      {
        "lineItems": [
          {
            "fulfillmentOrderId": "456",
            "quantity": "2",
            "productId": "1001",
            "lineItemId": "789",
            "id": "101",
            "shopId": "123",
            "variantId": "2002"
          }
        ],
        "updatedTime": "2023-05-15T14:20:00Z",
        "orderId": "54321",
        "fulfillTime": "2023-05-15T14:20:00Z",
        "createdTime": "2023-05-15T10:30:00Z",
        "fulfillId": "98765",
        "status": "success"
      }
    ],
    "convertRate": "1.25",
    "totalPriceSet": {
      "shopMoney": {
        "amount": "110.25",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "110.25",
        "currencyCode": "USD"
      }
    },
    "createdTime": "2023-05-10T09:15:00Z",
    "currency": "USD",
    "totalDiscountsSet": {
      "shopMoney": {
        "amount": "10.25",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "10.25",
        "currencyCode": "USD"
      }
    },
    "id": "54321",
    "cancelReason": "customer",
    "subtotalPrice": "85.50",
    "email": "customer@example.com",
    "paymentTerms": [
      {
        "amount": "100.00",
        "paymentTermsName": "分期付款",
        "paymentId": "1",
        "channelTrxNo": "TRX123456",
        "currency": "CNY"
      }
    ],
    "subtotalPriceSet": {
      "shopMoney": {
        "amount": "85.50",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "85.50",
        "currencyCode": "USD"
      }
    },
    "app": "shopify",
    "updatedTime": "2023-05-15T16:30:00Z",
    "discountCodes": [
      {
        "amount": "25.00",
        "code": "SUMMER20",
        "type": "1"
      }
    ],
    "shippingLines": [
      {
        "priceSet": {
          "shopMoney": {
            "amount": "9.99",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "9.99",
            "currencyCode": "USD"
          }
        },
        "discountedPrice": "7.99",
        "price": "9.99",
        "id": "456",
        "source": "shopify",
        "title": "Express Shipping",
        "discountedPriceSet": {
          "shopMoney": {
            "amount": "7.99",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "7.99",
            "currencyCode": "USD"
          }
        },
        "taxLines": [
          {
            "priceSet": {
              "shopMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              }
            },
            "rate": "10",
            "price": "8.50",
            "title": "VAT"
          }
        ]
      }
    ],
    "totalShippingPriceSet": {
      "shopMoney": {
        "amount": "9.99",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "9.99",
        "currencyCode": "USD"
      }
    },
    "discountApplications": [
      {
        "code": "SAVE20",
        "targetType": "lineItem",
        "id": "da_12345",
        "title": "Summer Sale",
        "value": "15"
      }
    ],
    "totalShippingPrice": "9.99",
    "paidTime": "2023-05-15T10:30:00Z",
    "userId": "12345",
    "i18n": "{\"language\":\"en\", \"country\":\"US\"}",
    "tags": "urgent, gift",
    "processedTime": "2023-05-15T14:30:00Z",
    "phone": "+1234567890",
    "cancelledTime": "2023-05-15T10:30:00Z",
    "financialStatus": "paid",
    "totalWeight": "500",
    "shippingAddress": {
      "zip": "10001",
      "country": "USA",
      "lastName": "Smith",
      "address2": "Apt 3B",
      "city": "New York",
      "address1": "456 Oak Street",
      "provinceCode": "CA",
      "latitude": "40.7128",
      "firstName": "John",
      "province": "California",
      "phone": "+1234567890",
      "countryCode": "US",
      "name": "John Smith",
      "company": "XYZ Corporation",
      "longitude": "-74.0060"
    },
    "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",
      "company": "ABC Company",
      "longitude": "-75.6868"
    },
    "taxLines": [
      {
        "priceSet": {
          "shopMoney": {
            "amount": "8.50",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "8.50",
            "currencyCode": "USD"
          }
        },
        "rate": "10",
        "price": "8.50",
        "title": "VAT"
      }
    ],
    "customer": {
      "updatedTime": "2023-05-12T16:45:20Z",
      "lastName": "Smith",
      "note": "VIP customer with multiple purchases",
      "addresses": [
        {
          "zip": "200000",
          "country": "China",
          "lastName": "Doe",
          "address2": "Block A",
          "city": "Shanghai",
          "address1": "No.1 Road",
          "provinceCode": "SH",
          "firstName": "John",
          "isDefault": "true",
          "province": "Shanghai",
          "phone": "13800138000",
          "countryCode": "CN",
          "company": "Weimob",
          "countryName": "China"
        }
      ],
      "taxExempt": "false",
      "totalSpent": "542.75",
      "taxExemptions": [
        "VAT_EXEMPT"
      ],
      "tags": "loyal,repeat-customer",
      "firstName": "John",
      "ordersCount": "100",
      "phone": "+1234567890",
      "createdTime": "2023-01-15T10:30:00Z",
      "id": "12345",
      "email": "customer@example.com",
      "verifiedEmail": "true",
      "defaultAddress": {
        "zip": "200000",
        "country": "China",
        "lastName": "Doe",
        "address2": "Block A",
        "city": "Shanghai",
        "address1": "No.1 Road",
        "provinceCode": "SH",
        "firstName": "John",
        "isDefault": "true",
        "province": "Shanghai",
        "phone": "13800138000",
        "countryCode": "CN",
        "customerId": "123456",
        "company": "Weimob",
        "countryName": "China",
        "id": "123456"
      }
    }
  }
}

EVENT 订单取消

此 Webhook 在订单被取消时触发,帮助您实时获取订单取消的信息,以便进行相应的操作或跟踪。

访问范围

需要以下任意访问权限: read_orders write_orders

消息

EVENT orders/cancelled 

消息数据

orderobject
返回订单详细资料信息。
- 收起属性
billingAddressobject
与付款方式相关联的邮寄地址。此地址是一个可选字段,对于不需要付款方式的订单将不可用。
+ 展开属性
cancelReasonstring
订单被取消的原因。
cancelledTimestring
订单被取消的日期和时间。如果未取消订单,则返回 null。
closedTimestring
订单关闭的日期和时间(ISO 8601格式)。如果订单未关闭则返回 null。
createdTimestring
创建订单时自动生成的日期和时间(ISO 8601格式)。此属性的值不能更改。
currencystring
商店货币代码,三位代码。
customerobject
客户信息。
+ 展开属性
discountCodesarray
应用于订单的折扣列表。
+ 展开属性
emailstring
客户的电子邮件地址。
financialStatusstring
与订单相关的付款状态。枚举值:pending - 待支付;partiallyPaid - 部分支付;paid - 已支付。
fulfillmentsarray
履约单列表。
+ 展开属性
fulfillmentStatusstring
订单履约状态。枚举值:null - 未发货;partial - 部分发货;fulfilled - 已发货;canceled - 已取消。
lineItemsarray
订单项列表。
+ 展开属性
notestring
订单备注。
idnumber
订单号。
paymentTermsarray
支付项列表。
+ 展开属性
paymentGatewayNamesarray
订单支付方式列表。包括但不限于:CASH_ON_DELIVERY - 货到付款;MANUAL_METHOD - 手动支付。
phonestring
客户接收短信通知的电话号码。
shippingAddressobject
订单将被运送到的邮寄地址。此地址是可选的,将不可用于不需要送货的订单。
+ 展开属性
sourceIdentifierstring
在原始平台上的订单 ID。
subtotalPricestring
以商店货币表示的订单价格,扣除折扣后,不包括运费、关税、税金和小费。
tagsstring
附加到订单上的标记,格式为逗号分隔值的字符串。标签是额外的简短描述符,通常用于过滤和搜索。每个标签的长度限制为 40 个字符。
totalDiscountsstring
以商店货币表示的应用于订单价格的总折扣。
totalPricestring
以商店货币表示的所有行项目价格、折扣、运费、税和小费的总和
totalTaxstring
以商店货币表示的应用于订单的所有税目的价格总和,包括已退款和已取消的税目。
totalWeightstring
以克为单位的所有项目重量的总和。
updatedTimestring
最后一次修改订单的日期和时间。
paidTimestring
订单支付完成的日期和时间。
paymentTypestring
订单支付类型。枚举值:online - 线上支付;offline - 线下支付;noPayment - 无需支付;quick - 快捷支付。
convertRatenumber
汇率 市场货币->店铺货币。
totalDiscountsSetobject
总折扣金额价格集合。
+ 展开属性
discountApplicationsarray
折扣应用列表。
+ 展开属性
processedTimestring
处理时间。
refundsarray
售后列表。
+ 展开属性
shippingLinesarray
发货线路列表。
+ 展开属性
subtotalPriceSetobject
商品费用价格集合。
+ 展开属性
taxLinesarray
税费行列表。
+ 展开属性
totalPriceSetobject
总金额价格集合。
+ 展开属性
totalTaxSetobject
税费金额集合。
+ 展开属性
totalShippingPricestring
运费。
totalShippingPriceSetobject
运费金额集合。
+ 展开属性
userIdnumber
用户ID。
i18nstring
国际化信息。
shopCurrencystring
店铺货币。
appstring
应用标识。
typenumber
订单类型。枚举值:1 - 普通订单;11 - 外部创建订单。
extendedFieldsobject
订单扩展字段信息,Map类型。
+ 展开属性
marketIdnumber
市场的唯一标识符,订单所属市场。
json
{
  "order": {
    "note": "Please deliver after 6 PM",
    "sourceIdentifier": "WEB123456",
    "shopCurrency": "USD",
    "totalPrice": "110.25",
    "totalDiscounts": "10.25",
    "paymentGatewayNames": [
      "PayPal",
      "Credit Card"
    ],
    "type": "1",
    "extendedFields": {
      "value": "extendedFieldValue1",
      "key": "extendedFieldKey1"
    },
    "closedTime": "2023-05-20T14:45:30Z",
    "fulfillmentStatus": "fulfilled",
    "paymentType": "online",
    "refunds": [
      {
        "totalRefundShippingPrice": "5.99",
        "totalRefundPrice": "29.99",
        "refundLineItems": [
          {
            "totalTax": "1.50",
            "quantity": "1",
            "lineItem": {
              "quantity": "2",
              "productId": "123456",
              "refundableQuantity": "1",
              "title": "Wireless Headphones",
              "fulfillableQuantity": "12",
              "fulfillmentStatus": "fulfilled",
              "requiresShipping": "true",
              "price": "29.99",
              "locationId": "1",
              "alreadyRightsNum": "1",
              "alreadyFulfillNum": "2",
              "totalDiscount": "3.50",
              "id": "",
              "variantId": "789012",
              "grams": "250",
              "sku": "ABC123-X",
              "currentQuantity": "1"
            },
            "lineItemId": "789",
            "subtotal": "19.99",
            "rightsReason": "Description of Other Reasons",
            "id": "201",
            "rightsReasonType": "1"
          }
        ],
        "refundId": "12345",
        "processedTime": "2023-05-20T10:00:00Z",
        "status": "1"
      }
    ],
    "totalTaxSet": {
      "shopMoney": {
        "amount": "8.50",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "8.50",
        "currencyCode": "USD"
      }
    },
    "marketId": "6016749228698",
    "lineItems": [
      {
        "priceSet": {
          "shopMoney": {
            "amount": "29.99",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "29.99",
            "currencyCode": "USD"
          }
        },
        "variantTitle": "Red",
        "discountAllocations": {
          "amount": "2.50",
          "discountApplicationIndex": "1",
          "amountSet": {
            "shopMoney": {
              "amount": "2.50",
              "currencyCode": "USD"
            },
            "presentmentMoney": {
              "amount": "2.50",
              "currencyCode": "USD"
            }
          }
        },
        "refundableQuantity": "1",
        "title": "Wireless Headphones",
        "fulfillableQuantity": "3",
        "extendedFields": {
          "value": "extendedFieldValue1",
          "key": "extendedFieldKey1"
        },
        "fulfillmentStatus": "fulfilled",
        "price": "29.99",
        "locationId": "456",
        "alreadyRightsNum": "1",
        "id": "987654",
        "variantId": "789012",
        "grams": "250",
        "sku": "ABC123-X",
        "currentQuantity": "1",
        "quantity": "2",
        "shippingLines": [
          {
            "priceSet": {
              "shopMoney": {
                "amount": "9.99",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "9.99",
                "currencyCode": "USD"
              }
            },
            "code": "EXPRESS",
            "discountedPrice": "7.99",
            "price": "9.99",
            "discountedPriceSet": {
              "shopMoney": {
                "amount": "7.99",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "7.99",
                "currencyCode": "USD"
              }
            },
            "taxLines": [
              {
                "priceSet": {
                  "shopMoney": {
                    "amount": "8.50",
                    "currencyCode": "USD"
                  },
                  "presentmentMoney": {
                    "amount": "8.50",
                    "currencyCode": "USD"
                  }
                },
                "rate": "10",
                "price": "8.50",
                "title": "VAT"
              }
            ]
          }
        ],
        "productId": "123456",
        "requiresShipping": "true",
        "giftCard": "false",
        "alreadyFulfillNum": "2",
        "totalDiscount": "3.50",
        "taxLines": [
          {
            "priceSet": {
              "shopMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              }
            },
            "rate": "10",
            "price": "8.50",
            "title": "VAT"
          }
        ],
        "totalDiscountSet": {
          "shopMoney": {
            "amount": "5.00",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "5.00",
            "currencyCode": "USD"
          }
        }
      }
    ],
    "totalTax": "8.50",
    "fulfillments": [
      {
        "lineItems": [
          {
            "fulfillmentOrderId": "456",
            "quantity": "2",
            "productId": "1001",
            "lineItemId": "789",
            "id": "101",
            "shopId": "123",
            "variantId": "2002"
          }
        ],
        "updatedTime": "2023-05-15T14:20:00Z",
        "orderId": "54321",
        "fulfillTime": "2023-05-15T14:20:00Z",
        "createdTime": "2023-05-15T10:30:00Z",
        "fulfillId": "98765",
        "status": "success"
      }
    ],
    "convertRate": "1.25",
    "totalPriceSet": {
      "shopMoney": {
        "amount": "110.25",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "110.25",
        "currencyCode": "USD"
      }
    },
    "createdTime": "2023-05-10T09:15:00Z",
    "currency": "USD",
    "totalDiscountsSet": {
      "shopMoney": {
        "amount": "10.25",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "10.25",
        "currencyCode": "USD"
      }
    },
    "id": "54321",
    "cancelReason": "customer",
    "subtotalPrice": "85.50",
    "email": "customer@example.com",
    "paymentTerms": [
      {
        "amount": "100.00",
        "paymentTermsName": "分期付款",
        "paymentId": "1",
        "channelTrxNo": "TRX123456",
        "currency": "CNY"
      }
    ],
    "subtotalPriceSet": {
      "shopMoney": {
        "amount": "85.50",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "85.50",
        "currencyCode": "USD"
      }
    },
    "app": "shopify",
    "updatedTime": "2023-05-15T16:30:00Z",
    "discountCodes": [
      {
        "amount": "25.00",
        "code": "SUMMER20",
        "type": "1"
      }
    ],
    "shippingLines": [
      {
        "priceSet": {
          "shopMoney": {
            "amount": "9.99",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "9.99",
            "currencyCode": "USD"
          }
        },
        "discountedPrice": "7.99",
        "price": "9.99",
        "id": "456",
        "source": "shopify",
        "title": "Express Shipping",
        "discountedPriceSet": {
          "shopMoney": {
            "amount": "7.99",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "7.99",
            "currencyCode": "USD"
          }
        },
        "taxLines": [
          {
            "priceSet": {
              "shopMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              }
            },
            "rate": "10",
            "price": "8.50",
            "title": "VAT"
          }
        ]
      }
    ],
    "totalShippingPriceSet": {
      "shopMoney": {
        "amount": "9.99",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "9.99",
        "currencyCode": "USD"
      }
    },
    "discountApplications": [
      {
        "code": "SAVE20",
        "targetType": "lineItem",
        "id": "da_12345",
        "title": "Summer Sale",
        "value": "15"
      }
    ],
    "totalShippingPrice": "9.99",
    "paidTime": "2023-05-15T10:30:00Z",
    "userId": "12345",
    "i18n": "{\"language\":\"en\", \"country\":\"US\"}",
    "tags": "urgent, gift",
    "processedTime": "2023-05-15T14:30:00Z",
    "phone": "+1234567890",
    "cancelledTime": "2023-05-15T10:30:00Z",
    "financialStatus": "paid",
    "totalWeight": "500",
    "shippingAddress": {
      "zip": "10001",
      "country": "USA",
      "lastName": "Smith",
      "address2": "Apt 3B",
      "city": "New York",
      "address1": "456 Oak Street",
      "provinceCode": "CA",
      "latitude": "40.7128",
      "firstName": "John",
      "province": "California",
      "phone": "+1234567890",
      "countryCode": "US",
      "name": "John Smith",
      "company": "XYZ Corporation",
      "longitude": "-74.0060"
    },
    "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",
      "company": "ABC Company",
      "longitude": "-75.6868"
    },
    "taxLines": [
      {
        "priceSet": {
          "shopMoney": {
            "amount": "8.50",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "8.50",
            "currencyCode": "USD"
          }
        },
        "rate": "10",
        "price": "8.50",
        "title": "VAT"
      }
    ],
    "customer": {
      "updatedTime": "2023-05-12T16:45:20Z",
      "lastName": "Smith",
      "note": "VIP customer with multiple purchases",
      "addresses": [
        {
          "zip": "200000",
          "country": "China",
          "lastName": "Doe",
          "address2": "Block A",
          "city": "Shanghai",
          "address1": "No.1 Road",
          "provinceCode": "SH",
          "firstName": "John",
          "isDefault": "true",
          "province": "Shanghai",
          "phone": "13800138000",
          "countryCode": "CN",
          "company": "Weimob",
          "countryName": "China"
        }
      ],
      "taxExempt": "false",
      "totalSpent": "542.75",
      "taxExemptions": [
        "VAT_EXEMPT"
      ],
      "tags": "loyal,repeat-customer",
      "firstName": "John",
      "ordersCount": "100",
      "phone": "+1234567890",
      "createdTime": "2023-01-15T10:30:00Z",
      "id": "12345",
      "email": "customer@example.com",
      "verifiedEmail": "true",
      "defaultAddress": {
        "zip": "200000",
        "country": "China",
        "lastName": "Doe",
        "address2": "Block A",
        "city": "Shanghai",
        "address1": "No.1 Road",
        "provinceCode": "SH",
        "firstName": "John",
        "isDefault": "true",
        "province": "Shanghai",
        "phone": "13800138000",
        "countryCode": "CN",
        "customerId": "123456",
        "company": "Weimob",
        "countryName": "China",
        "id": "123456"
      }
    }
  }
}

EVENT 订单部分履约

当订单被部分履行时触发事件.

访问范围

需要以下任意访问权限: read_orders write_orders

消息

EVENT orders/partiallyFulfilled 

消息数据

orderobject
返回订单详细资料信息。
- 收起属性
billingAddressobject
与付款方式相关联的邮寄地址。此地址是一个可选字段,对于不需要付款方式的订单将不可用。
+ 展开属性
cancelReasonstring
订单被取消的原因。
cancelledTimestring
订单被取消的日期和时间。如果未取消订单,则返回 null。
closedTimestring
订单关闭的日期和时间(ISO 8601格式)。如果订单未关闭则返回 null。
createdTimestring
创建订单时自动生成的日期和时间(ISO 8601格式)。此属性的值不能更改。
currencystring
商店货币代码,三位代码。
customerobject
客户信息。
+ 展开属性
discountCodesarray
应用于订单的折扣列表。
+ 展开属性
emailstring
客户的电子邮件地址。
financialStatusstring
与订单相关的付款状态。枚举值:pending - 待支付;partiallyPaid - 部分支付;paid - 已支付。
fulfillmentsarray
履约单列表。
+ 展开属性
fulfillmentStatusstring
订单履约状态。枚举值:null - 未发货;partial - 部分发货;fulfilled - 已发货;canceled - 已取消。
lineItemsarray
订单项列表。
+ 展开属性
notestring
订单备注。
idnumber
订单号。
paymentTermsarray
支付项列表。
+ 展开属性
paymentGatewayNamesarray
订单支付方式列表。包括但不限于:CASH_ON_DELIVERY - 货到付款;MANUAL_METHOD - 手动支付。
phonestring
客户接收短信通知的电话号码。
shippingAddressobject
订单将被运送到的邮寄地址。此地址是可选的,将不可用于不需要送货的订单。
+ 展开属性
sourceIdentifierstring
在原始平台上的订单 ID。
subtotalPricestring
以商店货币表示的订单价格,扣除折扣后,不包括运费、关税、税金和小费。
tagsstring
附加到订单上的标记,格式为逗号分隔值的字符串。标签是额外的简短描述符,通常用于过滤和搜索。每个标签的长度限制为 40 个字符。
totalDiscountsstring
以商店货币表示的应用于订单价格的总折扣。
totalPricestring
以商店货币表示的所有行项目价格、折扣、运费、税和小费的总和
totalTaxstring
以商店货币表示的应用于订单的所有税目的价格总和,包括已退款和已取消的税目。
totalWeightstring
以克为单位的所有项目重量的总和。
updatedTimestring
最后一次修改订单的日期和时间。
paidTimestring
订单支付完成的日期和时间。
paymentTypestring
订单支付类型。枚举值:online - 线上支付;offline - 线下支付;noPayment - 无需支付;quick - 快捷支付。
convertRatenumber
汇率 市场货币->店铺货币。
totalDiscountsSetobject
总折扣金额价格集合。
+ 展开属性
discountApplicationsarray
折扣应用列表。
+ 展开属性
processedTimestring
处理时间。
refundsarray
售后列表。
+ 展开属性
shippingLinesarray
发货线路列表。
+ 展开属性
subtotalPriceSetobject
商品费用价格集合。
+ 展开属性
taxLinesarray
税费行列表。
+ 展开属性
totalPriceSetobject
总金额价格集合。
+ 展开属性
totalTaxSetobject
税费金额集合。
+ 展开属性
totalShippingPricestring
运费。
totalShippingPriceSetobject
运费金额集合。
+ 展开属性
userIdnumber
用户ID。
i18nstring
国际化信息。
shopCurrencystring
店铺货币。
appstring
应用标识。
typenumber
订单类型。枚举值:1 - 普通订单;11 - 外部创建订单。
extendedFieldsobject
订单扩展字段信息,Map类型。
+ 展开属性
marketIdnumber
市场的唯一标识符,订单所属市场。
json
{
  "order": {
    "note": "Please deliver after 6 PM",
    "sourceIdentifier": "WEB123456",
    "shopCurrency": "USD",
    "totalPrice": "110.25",
    "totalDiscounts": "10.25",
    "paymentGatewayNames": [
      "PayPal",
      "Credit Card"
    ],
    "type": "1",
    "extendedFields": {
      "value": "extendedFieldValue1",
      "key": "extendedFieldKey1"
    },
    "closedTime": "2023-05-20T14:45:30Z",
    "fulfillmentStatus": "fulfilled",
    "paymentType": "online",
    "refunds": [
      {
        "totalRefundShippingPrice": "5.99",
        "totalRefundPrice": "29.99",
        "refundLineItems": [
          {
            "totalTax": "1.50",
            "quantity": "1",
            "lineItem": {
              "quantity": "2",
              "productId": "123456",
              "refundableQuantity": "1",
              "title": "Wireless Headphones",
              "fulfillableQuantity": "12",
              "fulfillmentStatus": "fulfilled",
              "requiresShipping": "true",
              "price": "29.99",
              "locationId": "1",
              "alreadyRightsNum": "1",
              "alreadyFulfillNum": "2",
              "totalDiscount": "3.50",
              "id": "",
              "variantId": "789012",
              "grams": "250",
              "sku": "ABC123-X",
              "currentQuantity": "1"
            },
            "lineItemId": "789",
            "subtotal": "19.99",
            "rightsReason": "Description of Other Reasons",
            "id": "201",
            "rightsReasonType": "1"
          }
        ],
        "refundId": "12345",
        "processedTime": "2023-05-20T10:00:00Z",
        "status": "1"
      }
    ],
    "totalTaxSet": {
      "shopMoney": {
        "amount": "8.50",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "8.50",
        "currencyCode": "USD"
      }
    },
    "marketId": "6016749228698",
    "lineItems": [
      {
        "priceSet": {
          "shopMoney": {
            "amount": "29.99",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "29.99",
            "currencyCode": "USD"
          }
        },
        "variantTitle": "Red",
        "discountAllocations": {
          "amount": "2.50",
          "discountApplicationIndex": "1",
          "amountSet": {
            "shopMoney": {
              "amount": "2.50",
              "currencyCode": "USD"
            },
            "presentmentMoney": {
              "amount": "2.50",
              "currencyCode": "USD"
            }
          }
        },
        "refundableQuantity": "1",
        "title": "Wireless Headphones",
        "fulfillableQuantity": "3",
        "extendedFields": {
          "value": "extendedFieldValue1",
          "key": "extendedFieldKey1"
        },
        "fulfillmentStatus": "fulfilled",
        "price": "29.99",
        "locationId": "456",
        "alreadyRightsNum": "1",
        "id": "987654",
        "variantId": "789012",
        "grams": "250",
        "sku": "ABC123-X",
        "currentQuantity": "1",
        "quantity": "2",
        "shippingLines": [
          {
            "priceSet": {
              "shopMoney": {
                "amount": "9.99",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "9.99",
                "currencyCode": "USD"
              }
            },
            "code": "EXPRESS",
            "discountedPrice": "7.99",
            "price": "9.99",
            "discountedPriceSet": {
              "shopMoney": {
                "amount": "7.99",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "7.99",
                "currencyCode": "USD"
              }
            },
            "taxLines": [
              {
                "priceSet": {
                  "shopMoney": {
                    "amount": "8.50",
                    "currencyCode": "USD"
                  },
                  "presentmentMoney": {
                    "amount": "8.50",
                    "currencyCode": "USD"
                  }
                },
                "rate": "10",
                "price": "8.50",
                "title": "VAT"
              }
            ]
          }
        ],
        "productId": "123456",
        "requiresShipping": "true",
        "giftCard": "false",
        "alreadyFulfillNum": "2",
        "totalDiscount": "3.50",
        "taxLines": [
          {
            "priceSet": {
              "shopMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              }
            },
            "rate": "10",
            "price": "8.50",
            "title": "VAT"
          }
        ],
        "totalDiscountSet": {
          "shopMoney": {
            "amount": "5.00",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "5.00",
            "currencyCode": "USD"
          }
        }
      }
    ],
    "totalTax": "8.50",
    "fulfillments": [
      {
        "lineItems": [
          {
            "fulfillmentOrderId": "456",
            "quantity": "2",
            "productId": "1001",
            "lineItemId": "789",
            "id": "101",
            "shopId": "123",
            "variantId": "2002"
          }
        ],
        "updatedTime": "2023-05-15T14:20:00Z",
        "orderId": "54321",
        "fulfillTime": "2023-05-15T14:20:00Z",
        "createdTime": "2023-05-15T10:30:00Z",
        "fulfillId": "98765",
        "status": "success"
      }
    ],
    "convertRate": "1.25",
    "totalPriceSet": {
      "shopMoney": {
        "amount": "110.25",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "110.25",
        "currencyCode": "USD"
      }
    },
    "createdTime": "2023-05-10T09:15:00Z",
    "currency": "USD",
    "totalDiscountsSet": {
      "shopMoney": {
        "amount": "10.25",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "10.25",
        "currencyCode": "USD"
      }
    },
    "id": "54321",
    "cancelReason": "customer",
    "subtotalPrice": "85.50",
    "email": "customer@example.com",
    "paymentTerms": [
      {
        "amount": "100.00",
        "paymentTermsName": "分期付款",
        "paymentId": "1",
        "channelTrxNo": "TRX123456",
        "currency": "CNY"
      }
    ],
    "subtotalPriceSet": {
      "shopMoney": {
        "amount": "85.50",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "85.50",
        "currencyCode": "USD"
      }
    },
    "app": "shopify",
    "updatedTime": "2023-05-15T16:30:00Z",
    "discountCodes": [
      {
        "amount": "25.00",
        "code": "SUMMER20",
        "type": "1"
      }
    ],
    "shippingLines": [
      {
        "priceSet": {
          "shopMoney": {
            "amount": "9.99",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "9.99",
            "currencyCode": "USD"
          }
        },
        "discountedPrice": "7.99",
        "price": "9.99",
        "id": "456",
        "source": "shopify",
        "title": "Express Shipping",
        "discountedPriceSet": {
          "shopMoney": {
            "amount": "7.99",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "7.99",
            "currencyCode": "USD"
          }
        },
        "taxLines": [
          {
            "priceSet": {
              "shopMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              },
              "presentmentMoney": {
                "amount": "8.50",
                "currencyCode": "USD"
              }
            },
            "rate": "10",
            "price": "8.50",
            "title": "VAT"
          }
        ]
      }
    ],
    "totalShippingPriceSet": {
      "shopMoney": {
        "amount": "9.99",
        "currencyCode": "USD"
      },
      "presentmentMoney": {
        "amount": "9.99",
        "currencyCode": "USD"
      }
    },
    "discountApplications": [
      {
        "code": "SAVE20",
        "targetType": "lineItem",
        "id": "da_12345",
        "title": "Summer Sale",
        "value": "15"
      }
    ],
    "totalShippingPrice": "9.99",
    "paidTime": "2023-05-15T10:30:00Z",
    "userId": "12345",
    "i18n": "{\"language\":\"en\", \"country\":\"US\"}",
    "tags": "urgent, gift",
    "processedTime": "2023-05-15T14:30:00Z",
    "phone": "+1234567890",
    "cancelledTime": "2023-05-15T10:30:00Z",
    "financialStatus": "paid",
    "totalWeight": "500",
    "shippingAddress": {
      "zip": "10001",
      "country": "USA",
      "lastName": "Smith",
      "address2": "Apt 3B",
      "city": "New York",
      "address1": "456 Oak Street",
      "provinceCode": "CA",
      "latitude": "40.7128",
      "firstName": "John",
      "province": "California",
      "phone": "+1234567890",
      "countryCode": "US",
      "name": "John Smith",
      "company": "XYZ Corporation",
      "longitude": "-74.0060"
    },
    "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",
      "company": "ABC Company",
      "longitude": "-75.6868"
    },
    "taxLines": [
      {
        "priceSet": {
          "shopMoney": {
            "amount": "8.50",
            "currencyCode": "USD"
          },
          "presentmentMoney": {
            "amount": "8.50",
            "currencyCode": "USD"
          }
        },
        "rate": "10",
        "price": "8.50",
        "title": "VAT"
      }
    ],
    "customer": {
      "updatedTime": "2023-05-12T16:45:20Z",
      "lastName": "Smith",
      "note": "VIP customer with multiple purchases",
      "addresses": [
        {
          "zip": "200000",
          "country": "China",
          "lastName": "Doe",
          "address2": "Block A",
          "city": "Shanghai",
          "address1": "No.1 Road",
          "provinceCode": "SH",
          "firstName": "John",
          "isDefault": "true",
          "province": "Shanghai",
          "phone": "13800138000",
          "countryCode": "CN",
          "company": "Weimob",
          "countryName": "China"
        }
      ],
      "taxExempt": "false",
      "totalSpent": "542.75",
      "taxExemptions": [
        "VAT_EXEMPT"
      ],
      "tags": "loyal,repeat-customer",
      "firstName": "John",
      "ordersCount": "100",
      "phone": "+1234567890",
      "createdTime": "2023-01-15T10:30:00Z",
      "id": "12345",
      "email": "customer@example.com",
      "verifiedEmail": "true",
      "defaultAddress": {
        "zip": "200000",
        "country": "China",
        "lastName": "Doe",
        "address2": "Block A",
        "city": "Shanghai",
        "address1": "No.1 Road",
        "provinceCode": "SH",
        "firstName": "John",
        "isDefault": "true",
        "province": "Shanghai",
        "phone": "13800138000",
        "countryCode": "CN",
        "customerId": "123456",
        "company": "Weimob",
        "countryName": "China",
        "id": "123456"
      }
    }
  }
}