Order creation

Event GroupEvent Identification
ordersorders/create
After the order have been created successfully, you will receive this notification.
For details on how to subscribe to Webhooks and how to respond after receiving a Webhook, please refer to the Webhook overview.
Request Headers
  • X-Shopline-Topic string required
    Event operation identification
    Example: orders/edited
  • X-Shopline-Hmac-Sha256 string required
    Signature
    Example: XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM=
  • X-Shopline-Shop-Domain string required
    Shop domain
    Example: shophub.myshopline.com
  • X-Shopline-Shop-Id string required
    Shop ID
    Example: 1610418123456
  • X-Shopline-Merchant-Id string required
    Merchant ID
    Example: 2000001234
  • X-Shopline-API-Version string required
    Version
    Example: v20210901
  • X-Shopline-Webhook-Id string required
    Message ID
    Example: b54557e48a5fbf7d70bcd043
Request Body
  • adjust_price string
    The amount discrepancy due to rounding adjustments in POS transactions, expressed in the store currency.
    Example: 8.00
  • adjust_price_setobject
    The amount discrepancy due to rounding adjustments in POS transactions, displayed in both the buyer's order currency and the store currency.
  • presentment_moneyobject
    Buyer's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • shop_moneyobject
    Store's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • billing_addressobject
    The address for sending billing invoices.
  • address1 string
    The first line of the address. This typically includes information such as the street address or a post office box number.
    Example: Address 1
  • address2 string
    The second line of the address. This typically includes information such as apartment, suite, or unit number.
    Example: Address 2
  • city string
    The city in the address.
    Example: New York
  • company string
    The company name of the billing recipient.
    Example: new company
  • country string
    The country or region in the address.
    Example: USA
  • country_code string
    A two-letter country or region code that follows the ISO 3166-1 standard, used to identify a specific country or region in the address. For example, US.
    Example: US
  • first_name string
    The first name of the billing recipient.
    Example: Tom
  • last_name string
    The last name of the billing recipient.
    Example: Washington
  • name string
    The name of the billing recipient.
    Example: Tom Washington
  • phone string
    The phone number of the billing recipient.
    Example: 19872653123
  • province string
    The province in the address.
    Example: California
  • province_code string
    The code for the province in the billing address, which can be a custom code or a two-digit ISO 3166-2 international code.
    Example: 4500006
  • zip string
    The postal code information of the address.
    Example: 65432
  • browser_ip string
    Merchant's reason for order cancellation.
    Example: 157.119.232.35
  • buyer_note string
    Buyer's message.
    Example: Notes
  • cancel_reason string
    Merchant's reason for order cancellation.
    Example: I don't want to buy it.
  • cancelled_at string
    The date and time when the order is canceled. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
    Example: 2012-05-01T14:22:25-04:00
  • cart_token string
    The unique identifier for shopping cart data.
    Example: c2c4a58186b9d96395d7e6b5c2969577
  • checkout_id string
    Abandoned checkout ID.
    Example: 2404785166526352972864
  • checkout_token string
    The unique identifier for abandoned order data.
    Example: c2c4a58186b9d96395d7e6b5c2969577
  • client_detailsobject
    Client details.
  • browser_ip string
    Browser IP.
    Example: 157.119.232.35
  • session_hash string
    Member session encryption information.
    Example: 90c6724a-cf0d-4517-bd61-5c2727c2f886
  • user_agent string
    Client proxy.
    Example: Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 Sa
  • uuid string
    The unique identifier before the user is registered.
    Example: 11111223
  • companyobject
    The buyer's company information.
  • id string
    Company ID.
    Example: 1005619945158043247856
  • location_id string
    Location ID.
    Example: 3005619945158043247856
  • tax_registration_id string
    Tax registration ID.
    Example: 213213
  • contract_seq string
    Subscription contract ID.
    Example: 3005619945158043247856
  • created_at string
    The date and time when the order was created. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
    Example: 2012-05-01T14:22:25-04:00
  • credit_limitobject
    Credit payment information.
  • credit_limit_currency string
    The currency of the credit payment, same as the store currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • is_credit_limit boolean
    Indicates whether the order used credit payment.
    • true: used
    • false: not used
    Example: true
  • outstanding_credit_limit string
    The total occupied credit amount. Initially equal to the total_credit_limit, it decreases accordingly if there are subsequent actions such as repayments.
    Example: 1.00
  • total_credit_limit string
    The total credit amount used, indicating how much credit was utilized to pay for this order.
    Example: 1.00
  • currency string
    Settlement currency of the order. A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • current_subtotal_price string
    The total amount of the products, calculated as the product of the unit price and quantity, displayed in the store's currency.
    Example: 8.00
  • current_subtotal_price_setobject
    The total amount of the products, calculated as the product of the unit price and quantity, displayed in both the buyer's currency and the store's currency.
  • presentment_moneyobject
    Buyer's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • shop_moneyobject
    Store's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • current_total_discounts string
    The total discount amount, rounded to two decimal places, is the sum of marketing discounts and custom discounts, displayed in the store's currency.
    Example: 8.00
  • current_total_discounts_setobject
    The total discount amount, displayed in both the buyer's currency and the store's currency.
  • presentment_moneyobject
    Buyer's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • shop_moneyobject
    Store's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • current_total_duties_setobject
    The total customs duties for the products, displayed in both the buyer's currency and the store's currency.
  • presentment_moneyobject
    Buyer's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • shop_moneyobject
    Store's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • current_total_price string
    The total order amount, displayed in both the buyer's currency and the store's currency.
    Example: 8.00
  • current_total_price_setobject
    The total order amount, displayed in both the buyer's currency and the store's currency.
  • presentment_moneyobject
    Buyer's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • shop_moneyobject
    Store's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • current_total_tax string
    The total tax amount, displayed in the store's currency.
    Example: 8.00
  • current_total_tax_setobject
    The total tax amount, displayed in both the buyer's currency and the store's currency.
  • presentment_moneyobject
    Buyer's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • shop_moneyobject
    Store's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • customerobject
    Buyer information.
  • addressesobject
    Shipping address.
  • address1 string
    The first line of the address. This typically includes information such as the street address or a post office box number.
    Example: Address 1
  • address2 string
    The second line of the address. This typically includes information such as apartment, suite, or unit number.
    Example: Address 2
  • city string
    The city in the shipping address.
    Example: New York
  • country string
    The country or region in the shipping address.
    Example: USA
  • country_code string
    A two-letter country or region code that follows the ISO 3166-1 standard, used to identify a specific country or region in the address. For example, US.
    Example: US
  • first_name string
    The buyer's first name.
    Example: Tom
  • last_name string
    The buyer's last name.
    Example: Washington
  • name string
    The buyer's name.
    Example: Tom Washington
  • phone string
    The buyer's phone number.
    Example: 19872334222
  • province string
    The province in the shipping address.
    Example: California
  • province_code string
    The code for the province in the shipping address, which can be a custom code or a two-digit ISO 3166-2 international code.
    Example: 4200006
  • zip string
    The postal code for the shipping address.
    Example: 510000
  • area_code string
    Phone area code.
    Example: +86
  • created_at string
    The date and time when the customer was created. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
    Example: 2022-11-04T10:18:46+00:00
  • currency string
    The currency used by the buyer to place an order. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • email string
    The buyer's email.
    Example: test1001@Gmail.com
  • first_name string
    The buyer's first name.
    Example: Tom
  • id string
    Buyer ID.
    Example: 4201057495
  • last_name string
    The buyer's last name.
    Example: Washington
  • phone string
    Buyer's mobile phone number.
    Example: 19872334222
  • customer_locale string
    Buyer's country, language code + country name abbreviation.
    Example: enCA
    Example: enCN
  • deduct_member_point_amount string
    The order amount deducted using membership points, displayed in the store's currency.
    Example: 8.00
  • deduct_member_point_amount_setobject
    The order amount deducted using membership points, displayed in both the buyer's currency and the store's currency.
  • presentment_moneyobject
    Buyer's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • shop_moneyobject
    Store's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • discount_applicationsobject[]
    Discount information.
  • allocation_method string
    Discount range. Valid values are: :
    • across: Discount based on the total quantity purchased.
    • each: Discount applied to each individual item separately.
    Example: For a purchase of 3 identical items with a discount of 10 units. across means the 10 units are applied to the total of all 3 items together. each means 10 units are applied to each individual item.
    Example: across
  • code string
    Discount code.
    Example: 1Q3UMQM8RBP5
  • description string
    Detailed description of the activity.
    Example: Detailed description of the activity
  • target_selection string
    Discount distribution method for line items. Valid values are:
    • explicit: discount is assigned to explicitly selected line items
    • all: discount is assigned to all line items
    • entitled: discount is assigned only to line items for which it has permission
    Example: explicit
  • target_type string
    Discount target type. Valid values are:
    • line_item: discount applied to the product
    • shipping_line: discount applied to the shipping fee
    Example: line_item
  • title string
    The title of discount activity.
    Example: Detailed description of the activity
  • type string
    Discount type. Valid values are:
    • manual: manual discount
    • automatic: automatic discount
    • discount_code: discount applied through a discount code
    Example: manual
  • value string
    Discount value.
    Example: 20
  • value_type string
    The type of value. Valid values are:
    • fix_amount: fixed amount discount
    • percentage: percentage discount
    Example: fixed_amount
  • discount_codesobject[]
    Promo code information.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • amount_setobject
    The discount amount, displayed in both the buyer's currency and the store's currency.
  • presentment_moneyobject
    Buyer's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • shop_moneyobject
    Store's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • code string
    Promo code.
    Example: KIN4GNAB2FRH
  • type string
    Types of discounts. Valid values are:
    • AMOUNT_DISCOUNT
    • PERCENTAGE_DISCOUNT
    • FREE_SHIPPING
    • MARKUP_DISCOUNT
    • ANY_ N_ITEMS_DISCOUNT
    • BUNDLE_DISCOUNT
    • GIFT
    • FIX_AMOUNT_DISCOUNT
    • LOWEST_PRICED_ITEM_FREE
    • BUNDLE_PRICE
    • NTH_ITEM_DISCOUNT
    • BUY_X_GET_Y
    • CUSTOMER_DISCOUNT
    Example: Reduction amount
  • draft_order_seq string
    The draft order ID.
    Example: 2506031660544058504339
  • email string
    Buyer's email.
    Example: test1001@Gmail.com
  • exist_subscription boolean
    Whether there exists merchandise within the sales plan.
    • true：exists
    • false：do not exist
    Example: true
  • financial_status string
    Order payment status. Valid values are:
    • unpaid: order not paid
    • authorized: order payment has been authorized.
    • pending: order payment in progress
    • partially_paid: order partially paid
    • paid: order paid
    • partially_refunded: order partially refund
    • refunded: order refund
    Example: unpaid
  • fulfillment_status string
    Shipping status. Valid values are:
    • fulfilled: order shipped
    • partial: order partially shipped
    • null: order not shipped
    Note: the returned enum value is different from the query enumeration value of the input parameter.
    Example: fulfilled
  • fulfillmentsobject[]
    A list of fulfillment.
  • created_at string
    The date and time when the fulfillment was created. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
    Example: 2022-11-04T10:18:46+00:00
  • id string
    Fulfillment ID.
    Example: 22046737798141702810214336
  • line_itemsobject[]
    A list of product line.
  • attribute string
    Product attributes: name - attribute value. Multiple separated by comma ",". For example, color - red, size - X.
    Example: red
  • bundle_parent_variant_id string
    Parent product variant ID associated with the bundle child product.
    Example: 18056761559984840457934011
  • fulfillable_quantity integer
    The remaining quantity of products that can be fulfilled at the product line dimension.
    Example: 2
  • fulfillment_quantity integer
    The quantity of products that have been shipped.
    Example: 1
  • fulfillment_service string
    Logistics business name, if there are multiple different delivery providers in product, then use separated by ','.
    Example: Sf international
  • fulfillment_status string
    The shipping status of the product. Valid values are:
    • fulfilled: products shipped
    • partial: products partially shipped
    • null: products not shipped
    Example: fulfilled
  • grams double
    Product weight, unit: g.
    Example: 100
  • id string
    The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number.
    Example: 417
  • image_url string
    Product picture.
    Example: https://d2n979dmt31clo.cloudfront.net/image/store/4211449909/1667384795847/63928f08a7174ab2958c6a969
  • is_bundle boolean
    whether the product is a bundle product.
    Example: true
  • is_bundle_component boolean
    whether the product is a bundle component product.
    Example: true
  • location_id string
    Location ID.
    Example: 5327026538935748524
  • name string
    SKU title.
    Example: testProduct1001
  • price string
    Product selling price. The value is rounded to two decimal places.
    Example: 8.00
  • priceSetobject
    The product price, displayed in both the store's currency and the buyer's currency.
  • presentment_moneyobject
    Buyer's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • shop_moneyobject
    Store's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • product_id string
    SPU serial number.
    Example: 16056761559984840457934011
  • quantity integer
    Quantity of products in the order.
    Example: 2
  • requires_shipping boolean
    Indicates whether the product is subject to shipping.
    • true：Shipping is required.
    • false：Shipping is not required.
    Example: true
  • sku string
    SKU number.
    Example: 18056761559987524812644011
  • tax_linesobject[]
    List of tax.
  • price string
    The tax amount, displayed in the store's currency.
    Example: 8.00
  • price_setobject
    The tax amount, displayed in both the buyer's currency and the store's currency.
  • presentment_moneyobject
    Buyer's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • shop_moneyobject
    Store's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • rate double
    Tax rate.
    Example: 1
  • title string
    Tax name.
    Example: Tax
  • taxable boolean
    Indicates whether the product is taxable.
    • true: taxable
    • false: not taxable
    Example: true
  • title string
    Product title.
    Example: Beautiful skirt
  • variant_id string
    Product SKU serial number.
    Example: 18056761559987524812644011
  • variant_title string
    Commodity attribute value, multiple divided by " / ".
    Example: 155 / red / large
    Example: big
  • vendor string
    Supplier.
    Example: Supplier
  • order_id string
    The order ID.
    Example: 21056577640603870897253153
  • shipment_status string
    Logistics delivery status. Valid values are:
    • success: shipment successful
    • cancelled: shipment has been canceled
    Example: fulfilled
  • status string
    Logistics delivery status. Valid values are:
    • success: shipped
    • cancelled: cancelled
    Example: success
  • tracking_company string
    Logistics company name.
    Example: Sf international
  • tracking_number string
    Third-party logistics tracking number.
    Example: yun0001
  • tracking_url string
    Logistics company URL.
    Example: https://www.sf-international.com/
  • updated_at string
    The date and time when the fulfillment was updated. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
    Example: 2022-11-04T10:18:46+00:00
  • hidden_order boolean
    Indicate whether it is an archived order. Valid values are:
    • true: archived order
    • false: unarchived order
    Example: true
  • id string
    System order number.
    Example: 21050224312121887324667162
  • landing_site string
    Landing page.
    Example: https://www.url.com
  • line_itemsobject[]
    A list of product line.
  • attribute string
    Product attributes: name - attribute value. Multiple separated by comma ",".
    Example: color - red, size - X
    Example: red
  • bundle_parent_variant_id string
    Parent product variant ID associated with the bundle child product.
    Example: 18056761559984840457934011
  • discount_allocationsobject[]
    Discount details.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • amount_setobject
    The discount amount, displayed in both the buyer's currency and the store's currency.
  • presentment_moneyobject
    Buyer's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • shop_moneyobject
    Store's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • discount_application_index integer
    Position in discount details.
    Example: 1
  • dutiesobject[]
    Tariff information.
  • country_code_of_origin string
    Country code of origin or shipping point.
  • harmonized_system_code string
    Customs code.
  • id string
    Tariff number.
  • priceobject
    Tariff, displayed in both the buyer's currency and the store's currency.
  • presentment_moneyobject
    Buyer's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • shop_moneyobject
    Store's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • tax_linesobject[]
    List of tax.
  • price_setobject
    The tax amount, displayed in both the buyer's currency and the store's currency.
  • presentment_moneyobject
    Buyer's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • shop_moneyobject
    Store's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • rate double
    Tax rate.
  • rate_percentage double
    Tax rate (percentage value, i.e. rate * 100).
  • title string
    Tax name.
  • fulfillable_quantity integer
    The remaining quantity of products that can be fulfilled at the product line dimension.
    Example: 3
  • fulfillment_service string
    Logistics business name, if there are multiple different delivery providers in product, then use separated by ','.
    Example: Sf international
  • fulfillment_status string
    The shipping status of the product. Valid values are:
    • fulfilled: products shipped
    • partial: products partially shipped
    • null: products not shipped
    Example: fulfilled
  • giftCard boolean
    Indicates whether the product is a gift card item.
    • true：gift card item
    • false：not a gift card item
  • grams double
    Product weight, unit: g.
    Example: 100
  • id string
    The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number.
    Example: 413
  • image_url string
    Product picture.
    Example: https://d2n979dmt31clo.cloudfront.net/image/store/4211449909/1667384795847/63928f08a7174ab2958c6a969
  • is_bundle boolean
    whether the product is a bundle product.
    Example: true
  • is_bundle_component boolean
    whether the product is a bundle component product.
    Example: true
  • location_id string
    Location ID.
    Example: 5327026538935748524
  • name string
    SKU title.
    Example: testProduct1001
  • price string
    Product selling price. The value is rounded to two decimal places.
    Example: 8.00
  • product_id string
    SPU serial number.
    Example: 16056761559984840457934011
  • propertiesobject[]
    Customize additional fields for products.
  • additional string
    Customize additional fields for products. For example, when name is "text", additional can include attributes like font size, font style, color, etc.
    Example: Expand
  • name string
    Product customization information name.
    Example: Custom properties
  • type string
    Types of customized product information. Valid values are:
    • text：text type
    • picture：picture type
    • link：link type
    Example: text
  • urls array
    Product customization information link.
    Example: https://www.url.comhttps://www.url.com
  • value string
    Product customization information content.
    Example: Custom properties
  • quantity integer
    Quantity of products in the order.
    Example: 1
  • requires_shipping boolean
    Indicates whether the product is subject to shipping.
    • true：Shipping is required.
    • false：Shipping is not.
    Example: true
  • sku string
    SKU number.
    Example: 18056761559987524812644011
  • tags string
    Product tags, multiple commas separated.
    Example: watch
  • tax_linesobject[]
    List of tax.
  • price string
    The tax amount, displayed in the store's currency.
    Example: 8.00
  • price_setobject
    The tax amount, displayed in both the buyer's currency and the store's currency.
  • presentment_moneyobject
    Buyer's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • shop_moneyobject
    Store's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • rate double
    Tax rate.
    Example: 1
  • title string
    Tax name.
    Example: Tax
  • type string
    Tax fee type, used to distinguish between commodity tax and freight tax. Valid values are:
    • product_tax: commodity tax
    • shipping_tax: freight tax
    Example: shipping_tax
  • taxable boolean
    Indicates whether the product is taxable.
    • true: taxable
    • false: not taxable
    Example: true
  • title string
    Product title.
    Example: Beautiful skirt
  • variant_id string
    Product SKU serial number.
    Example: 18056761559987524812644011
  • variant_title string
    Commodity attribute value, multiple divided by " / ".
    Example: 155 / red / large
    Example: big
  • vendor string
    Supplier.
    Example: Supplier
  • locationsobject[]
    Product location information.
  • location_id string
    Location ID.
    Example: 5327026538935748524
  • name string
    Location name.
    Example: US.street
  • type string
    Location types. Valid values are:
    • posLocation: The store location where the order was created through the POS channel (it is recommended to use posLocationId, as it will replace this in the future).
    • pickupLocation: The store location for pickup when the order's delivery method is self-pickup.
    • productLocation: The inventory location of the products in the order (it is recommended to use the location information in the product line, as it will be deprecated in the future).
    Example: pickupLocation
  • name string
    Order number. Different from the order ID, this number can have a custom prefix set in the SHOPLINE Admin.
    Example: test1001
  • note string
    Merchant remark content, multiple separated by commas.
    Example: Notes
  • note_attributesobject[]
    Merchant note content.
  • create_time string
    The date and time when the remark was updated. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
    Example: 2022-11-04T10:18:46+00:00
  • name string
    Remark source, merchant ID.
    Example: Note source
  • value string
    Remark content.
    Example: Notes
  • order_at string
    The date and time when the order was completed. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
    Example: 2021-08-16T08:27:57+00:00
  • order_source string
    The order source channel.
    Example: pos
  • order_status_url string
    Order status page URL.
    Example: https://shoptest.myshopline.com/trade/thank_you?mainOrderMark=xxx&mainOrderSeq=200565776406008509
  • payment_detailsobject[]
    A list of payment order.
  • create_time string
    The date and time when the payment order was created. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
    Example: 2021-08-16T08:27:57+00:00
  • pay_amount double
    Payment amount.
    Example: 8
  • pay_channel_deal_id string
    Payment serial number: the payment number generated by the payment channel.
    Example: pi_3MI897Hezv8FxjBO1uGxMPhX
  • pay_seq string
    Payment network payment order number, the unique number request number of the payment order defined internally in SL.
    Example: 23057287797738260472676128
  • pay_status string
    Payment order status. Valid values are:
    • unpaid: payment order unpaid
    • pending: payment order in process
    • risking: payment order under risk control
    • paid：payment order paid
    • paid_overtime: payment order payment timeout
    • paid_failed: payment order failed
    Example: unpaid
  • processed_at string
    The date and time when the payment order was completed. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
    Example: 2023-04-12T22:59:52+08:00
  • status_code string
    Payment status code.
    Example: RISK_PENDING
  • status_msg string
    Payment order status code description.
    Example: PENDING_REVIEW
  • payment_gateway_names array
    Payment method list, payment method list used for this order:
    • SLpayments
    • Paypal
    • Oceanpay
    • TwoCheckout
    • AsiaBill
    • Stripe
    • Pacypay
    • WorldPay
    • COD
    • CUSTOM
    • adjustPay
    • Xendit
    • XenditOther
    Example: Paypal
  • payment_termsobject
    Payment terms.
  • created_at string
    The date and time when the payment term was created. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
    Example: 2024-06-05 08:00:00
  • due_in_days integer
    When the terms type is NET, the payment is due after how many days if the payment is not made.
    Example: 2
  • id string
    The unique identifier for the payment term.
    Example: 6497210673894431747
  • overdue boolean
    Indicates whether the payment terms are overdue.
    • true: overdue
    • false: not overdue
    Example: true
  • payment_schedulesobject[]
    A set of schedules associated with the payment terms.
  • completed_at string
    The date and time when the payment was completed. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
    Example: 2024-06-05 08:00:00
  • due_at string
    Expected payment date. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
    Example: 2024-06-05 08:00:00
  • issued_at string
    The time when the payment terms are triggered. When the type is FIXED, it is the saved time (if the draft order becomes an order, the order inherits the draft order time); when the type is FULFILLMENT/RECEIPT, it is the effective time of the condition; when the type is NET, it is the saved time (if the draft order becomes an order, the order inherits the draft order time).
    Example: 2024-06-05 08:00:00
  • payment_terms_name string
    The name of the payment terms template used to create the payment terms.
    Example: Due on receipt
  • payment_terms_type string
    The type of payment terms template used to create the payment terms. Valid values are:
    • FIXED: Merchant specified date.
    • FULFILLMENT: Fulfillment completion date.
    • NET: Fixed condition date.
    • RECEIPT: Billing sent date.
    • UNKNOWN: Unknown type.
    Example: RECEIPT
  • updated_at string
    The date and time when the payment term was updated. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
    Example: 2024-06-05 08:00:00
  • phone string
    Buyer's mobile phone number.
    Example: 19872334222
  • po_number string
    Purchase order number recorded on the order in B2B scenarios.
  • pos_location_id string
    POS trading location.
    Example: 5327026538935748524
  • presentment_currency string
    Buyer side currency.
    Example: USD
  • processed_at string
    The date and time when the order was completed. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
    Example: 2023-04-12T22:59:52+08:00
  • processed_user_id string
    Order creator.
    Example: 4201057495
  • referring_site string
    External link.
    Example: https://www.url.com
  • refundsobject[]
    A list of refund.
  • created_at string
    The date and time when the refund was created. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
    Example: 2021-08-16T08:27:57+00:00
  • id string
    Refund ID.
    Example: 2605659027312156877634
  • note string
    Refund notes.
    Example: Notes
  • order_id string
    Order ID.
    Example: 21056577640603870897253153
  • processed_at string
    The date and time when the refund was updated. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
    Example: 2021-08-16T08:27:57+00:00
  • user_id string
    User ID.
    Example: 4201057495
  • serivce string
    Shipping method type. Valid values are:
    • Pickup: pick up in store
    • null: not pick up in store
    Example: Pickup
  • shipping_addressobject
    Shipping address.
  • address1 string
    The first line of the address. This typically includes information such as the street address or a post office box number.
    Example: Address 1
  • address2 string
    The second line of the address. This typically includes information such as apartment, suite, or unit number.
    Example: Address 2
  • city string
    The city in the shipping address.
    Example: New York
  • company string
    The company name of the recipient.
    Example: Company
  • country string
    The country or region in the shipping address.
    Example: USA
  • country_code string
    A two-letter country or region code that follows the ISO 3166-1 standard, used to identify a specific country or region in the address. For example, US.
    Example: US
  • delivery_store_code string
    Store ID.
    Example: 1001
  • delivery_store_name string
    Store name.
    Example: Store
  • district string
    The district of the shipping address.
    Example: Manhattan
  • district_code string
    The code for the district in the shipping address, custom identifier.
    Example: NY
  • first_name string
    The buyer's first name.
    Example: Tom
  • last_name string
    The buyer's last name.
    Example: Washington
  • latitude string
    Latitude of shipping address.
    Example: 23.35773
  • longitude string
    Longitude of shipping address.
    Example: 116.4151
  • name string
    The buyer's name.
    Example: Tom Washington
  • phone string
    The buyer's phone number.
    Example: 13100000000
  • province string
    The province in the shipping address.
    Example: California
  • province_code string
    The code for the province in the shipping address, which can be a custom code or a two-digit ISO 3166-2 international code.
    Example: 4200006
  • zip string
    The postal code for the shipping address.
    Example: 521000
  • shipping_linesobject[]
    Logistics information.
  • code string
    Logistics number.
    Example: SF534535555324556
  • discount_allocationsobject[]
    Discount details.
  • amount string
    Discount amount. The value is rounded to two decimal places. For example, 88.98.
    Example: 8.00
  • amount_setobject
    The discount amount, rounded to two decimal places, is displayed in both the buyer's currency and the store's currency.
  • presentment_moneyobject
    Buyer's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • shop_moneyobject
    Store's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • discount_application_index integer
    Position in discount details.
    Example: 1
  • discounted_price string
    Discount amount. The value is rounded to two decimal places. For example, 88.98.
    Example: 8.00
  • discounted_price_setobject
    Discount amount, displayed in both the buyer's currency and the store's currency.
  • presentment_moneyobject
    Buyer's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • shop_moneyobject
    Store's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • phone string
    Phone number.
    Example: 13100000000
  • price string
    The shipping fee amount. The value is rounded to two decimal places.
    Example: 8.00
  • price_setobject
    The shipping fee amount, displayed in both the buyer's currency and the store's currency.
  • presentment_moneyobject
    Buyer's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • shop_moneyobject
    Store's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • shipping_price string
    The original freight amount value should be rounded to two decimal places.
    Example: 8.00
  • source string
    Logistics type.
    Example: SHOPLINE
  • tax_linesobject[]
    The logistics tax information.
  • price string
    Tax amount, displayed in the store's currency.
    Example: 8.00
  • price_setobject
    The tax amount, displayed in both the buyer's currency and the store's currency.
  • presentment_moneyobject
    Buyer's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • shop_moneyobject
    The value is rounded to two decimal places.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • rate double
    Tax rate.
    Example: 1
  • title string
    Tax name.
    Example: Tax
  • title string
    Logistics name.
    Example: Sf international
  • source_identifier string
    The ID used to identify business processing.
    Example: -
  • source_name string
    Marketing referral code when a customer clicks on a link to visit the store. The following URL parameters are supported: ref, resource, or r. For example, if the URL is myshopline.com/products/slide?ref=22dd9dctg, the value is 22dd9dctg.
    Example: -
  • source_url string
    Attribution URL, the customer clicks the link and jumps to the online store.
    Example: https://www.url.com
  • status string
    Order status. Valid values are:
    • open: processing
    • cancelled: cancelled
    Example: open
  • store_id string
    Store ID.
    Example: 1644828244663
  • subtotal_price string
    The total price after product discounts is calculated as the total product price minus discounts and custom discounts, displayed in the store's currency.
  • subtotal_price_setobject
    The total price after product discounts is displayed in both the buyer's currency and the store's currency, calculated as the total product price minus discounts and custom discounts.
  • presentment_moneyobject
    Buyer's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • shop_moneyobject
    Store's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • tags string
    Order label.
    Example: watch
  • tax_linesobject[]
    The order tax information.
  • price string
    The order tax amount, displayed in the store's currency.
    Example: 8.00
  • price_setobject
    The order tax amount, displayed in both the buyer's currency and the store's currency.
  • presentment_moneyobject
    Buyer's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • shop_moneyobject
    Store's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • rate double
    Tax rate.
    Example: 1
  • title string
    Tax name.
    Example: Tax
  • tax_number string
    TIN. Tax identification number.
    Example: 111111
  • tax_type string
    Types of tax ID.
    Example: Type
  • taxes_included boolean
    Whether the total amount includes the tax amount.
    • true：including
    • false：not including
    Example: true
  • total_discounts string
    The total discount amount, rounded to two decimal places, is the sum of marketing discounts and custom discounts, displayed in the store's currency.
    Example: 8.00
  • total_discounts_setobject
    The total discount amount, rounded to two decimal places, is the sum of marketing discounts and custom discounts, displayed in both the buyer's currency and the store's currency.
  • presentment_moneyobject
    Buyer's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • shop_moneyobject
    Store's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • total_line_items_price string
    The total original price of the products, rounded to two decimal places, is displayed in the store's currency.
    Example: 8.00
  • total_line_items_price_setobject
    The total original price of the products, displayed in both the buyer's currency and the store's currency.
  • presentment_moneyobject
    Buyer's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • shop_moneyobject
    Store's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • total_outstanding string
    The total unpaid amount, rounded to two decimal places, is displayed in the store's currency.
    Example: 8.00
  • total_outstanding_setobject
    The total unpaid amount, displayed in both the buyer's currency and the store's currency.
  • presentment_moneyobject
    Buyer's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • shop_moneyobject
    Store's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • total_shipping_price_setobject
    The total shipping fee for the order, displayed in both the buyer's currency and the store's currency.
  • presentment_moneyobject
    Buyer's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • shop_moneyobject
    Store's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • total_tax string
    The total tax amount, rounded to two decimal places, is displayed in the store's currency.
    Example: 8.00
  • total_tax_setobject
    The total tax amount, displayed in both the buyer's currency and the store's currency.
  • presentment_moneyobject
    Buyer's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • shop_moneyobject
    Store's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • total_tip_received string
    The tip amount, rounded to two decimal places, is displayed in the store's currency.
    Example: 8.00
  • total_tip_received_setobject
    The tip amount, displayed in both the store's currency and the buyer's currency.
  • presentment_moneyobject
    Buyer's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • shop_moneyobject
    Store's currency.
  • amount string
    The value is rounded to two decimal places.
    Example: 8.00
  • currency_code string
    A three-letter currency code that follows the ISO 4217 standard. For example, USD.
    Example: USD
  • total_weight double
    Total product weight, unit: g.
    Example: 100
  • updated_at string
    The date and time when the order was updated. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
    Example: 2022-11-04T10:18:46+00:00
  • user_id string
    Buyer ID.
    Example: 4201057495
  • utm_parameters string
    Advertising business specific parameters.
    Example: -
Response
After receiving a webhook notification from SHOPLINE, you must respond with the following format:
HTTP/1.1 200 OK
For more information about how to subscribe to webhooks and webhook response rules, refer to Webhook overview.
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.