Order created

Event GroupEvent Identification
ordersorders/create
Occurs whenever an order is created.
Request Headers
  • Content-Type string required
    The field must be set to the fixed value application/json; charset=utf-8.
  • X-Shopline-Topic string required
    The unique identifier for the event.
    Example: orders/edited
  • X-Shopline-Hmac-Sha256 string required
    The signature of the request. Upon receiving the request, you must verify the signature to confirm the authenticity and integrity of the data.
    Example: XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM=
  • X-Shopline-Shop-Domain string required
    The store domain.
    Example: example.myshopline.com
  • X-Shopline-Shop-Id string required
    The store ID.
    Example: 1610418123456
  • X-Shopline-Merchant-Id string required
    The merchant ID.
    Example: 2000001234
  • X-Shopline-API-Version string required
    The API version.
    Example: v20250601
  • X-Shopline-Webhook-Id string required
    The ID of this Webhook event.
    Example: b54557e48a5fbf7d70bcd043
Request Body
  • adjust_price string
    The amount discrepancy due to rounding adjustments in POS transactions, expressed in the store currency.
  • adjust_price_setobject
    The amount discrepancy due to rounding adjustments in POS transactions, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The amount displayed to the buyer.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount recorded by the merchant.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    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.
  • address2 string
    The second line of the address. This typically includes information such as apartment, suite, or unit number.
  • city string
    The city in the address.
  • company string
    The company name of the billing recipient.
  • country string
    The country or region in the address.
  • 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.
    Example: US
  • first_name string
    The first name of the billing recipient.
  • last_name string
    The last name of the billing recipient.
  • name string
    The full name of the billing recipient.
  • phone string
    The phone number of the billing recipient.
  • province string
    The province in the address.
  • province_code string
    The code for the province or region in the address, automatically generated by the system.
  • standard_province_code string
    The code for the province or region in an address, represented by the last two or three characters of the ISO 3166-2 standard, such as RI or ENG.
  • zip string
    The postal code information of the address.
  • browser_ip string
    The IP address of the customer's browser used during order placement.
  • buyer_note string
    Buyer's message.
  • cancel_reason string
    Merchant's reason for cancellation.
  • cancelled_at string
    The date and time when the order was canceled. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
  • cart_token string
    The unique identifier for shopping cart data.
  • checkout_id string
    Abandoned checkout ID.
  • checkout_token string
    The unique identifier for abandoned checkout data. After a customer initiates the checkout process, an abandoned checkout is generated.
  • client_detailsobject
    Client details.
  • browser_ip string
    The IP address of the customer's browser used during order placement.
  • session_hash string
    Member session encrypted information.
  • user_agent string
    User agent.
  • uuid string
    The customer's client-side ID, provided by SHOPLINE.
  • companyobject
    The buyer's company information as presented at the time the order was placed.
  • id string
    Company ID.
  • location_id string
    Location ID.
  • tax_registration_id string
    Tax registration ID.
  • contract_seq string
    Subscription contract ID.
  • created_at string
    The date and time when the order was created. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08: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.
  • is_credit_limit boolean
    Indicates whether the order used credit payment.
    • true: used
    • false: not used
  • outstanding_credit_limit string
    The current occupied credit amount, initially equal to total_credit_limit. This value decreases with actions like repayments.
  • total_credit_limit string
    The total credit amount used to pay for this order.
  • currency string
    The transaction currency. The value of this parameter is a three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • current_subtotal_price string
    The total amount of products, calculated by multiplying the unit price by the quantity and displayed in the store currency.
  • current_subtotal_price_setobject
    The total amount of products, calculated by multiplying the unit price by the quantity and displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The amount displayed to the buyer.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount recorded by the merchant.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • current_total_discounts string
    The total discount amount in the store currency. It is calculated by adding marketing discounts and custom discounts, with the resulting amount rounded to two decimal places.
  • current_total_discounts_setobject
    The total discount amount displayed in both the buyer currency and the store currency. It is calculated by adding marketing discounts and custom discounts, with the resulting amount rounded to two decimal places.
  • presentment_moneyobject
    The amount displayed to the buyer.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount recorded by the merchant.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • current_total_duties_setobject
    The total customs duties for the products, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The amount displayed to the buyer.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount recorded by the merchant.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • current_total_price string
    The total order amount, displayed in the store currency.
  • current_total_price_setobject
    The total order amount, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The amount displayed to the buyer.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount recorded by the merchant.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • current_total_tax string
    The total tax amount, displayed in the store currency.
  • current_total_tax_setobject
    The total tax amount, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The amount displayed to the buyer.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount recorded by the merchant.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • customerobject
    Buyer information.
  • addressesobject
    Buyer address information.
  • address1 string
    The first line of the address. This typically includes information such as the street address or a post office box number.
  • address2 string
    The second line of the address. This typically includes information such as apartment, suite, or unit number.
  • city string
    The city in the address.
  • country string
    The country or region in the address.
  • 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.
    Example: US
  • first_name string
    The first name of the buyer.
  • last_name string
    The last name of the buyer.
  • name string
    The full name of the buyer.
  • phone string
    The phone number of the buyer.
  • province string
    The province in the address.
  • province_code string
    The code for the province or region in the address, automatically generated by the system.
  • zip string
    The postal code information of the address.
  • area_code string
    The international dialing code for the buyer's phone number.
  • created_at string
    The date and time when the buyer information was created. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
  • currency string
    A three-letter currency code that follows the ISO 4217 standard.
  • email string
    The email of the buyer.
  • first_name string
    The first name of the buyer.
  • id string
    Buyer's ID.
  • last_name string
    The last name of the buyer.
  • phone string
    The phone number of the buyer.
  • customer_locale string
    Formed by combining a language code (ISO 639) with a country or region code (ISO 3166-1), for example,enUS.
    Only the country or region code is returned if language information is unavailable, for example, US.
  • deduct_member_point_amount string
    The amount deducted from the order using member points, displayed in the store currency and rounded to two decimal places.
  • deduct_member_point_amount_setobject
    The amount deducted from the order using member points, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The amount displayed to the buyer.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount recorded by the merchant.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • discount_applicationsobject[]
    Discount information.
  • allocation_method string
    The discount scope. Valid values are:
    • across: The discount is applied to the total product amount.
    • each: The discount is applied to each product individually.
    For example, for a purchase of three identical products with a discount amount value of 10 dollars. If the allocation_method is across, the total amount of the three products is reduced by 10 dollars. If the allocation_method is each, the amount of each product is individually reduced by 10 dollars.
  • code string
    Discount code.
  • description string
    Custom discount description.
  • target_selection string
    Discount allocation method for line items. Valid values are:
    • explicit: The discount is allocated only to the explicitly specified line items.
    • all: The discount is allocated to all line items.
    • entitled: The discount is allocated only to the line items that are entitled to use the discount.
  • target_type string
    Discount target type. Valid values are:
    • line_item: discount applied to the product
    • shipping_line: discount applied to the shipping fee
  • title string
    Automatic discount title.
  • type string
    Discount type. Valid values are:
    • manual: manual discount
    • automatic: automatic discount
    • discount_code: discount applied through a discount code
  • value string
    The specific value of the discount, in the store currency.
    • When value_type is fix_amount, this field value represents a specific discount amount. For example, if the value is 10 and the store currency is USD, it means a discount of 10 dollars.
    • When value_type is percentage, the value of this field represents a specific discount percentage. For example, 10 means 10% off of the order amount.
  • value_type string
    The type of discount value. Valid values are:
    • fix_amount: Fixed amount discount. For example, if value is 10 in USD, it means a discount of 10 dollars.
    • percentage: Percentage-based discount. For example, if value is 10, it means 10% off of the order amount.
  • discount_codesobject[]
    A list of promo code information.
  • amount string
    Discount amount in the store currency. The value is rounded to two decimal places.
  • amount_setobject
    The discount amount, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The amount displayed to the buyer.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount recorded by the merchant.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • code string
    Promo code.
  • type string
    Type of discount. Valid values are:
    • 减金额: amount reduction
    • 打折: offer a discount
    • 免运费: free shipping
    • 加价品: add-on purchase deal
    • 任意N件优惠价: discount for purchasing any N items
    • A+B组合优惠价: discount for purchasing the product A and B combo
    • 赠品: free gift
    • 固定售价: fixed price
    • 最低价商品免费: lowest-priced product free
    • 打包价: package price
    • 第N件打折: discount on the Nth item
    • 买x送y: buy x and get y free
    • 自定义: custom discount
    DEPRECATED: The returned enum values are in Chinese. This parameter is deprecated from API version v20250601.
  • draft_order_seq string
    The draft order ID.
  • email string
    Buyer's email.
  • exist_subscription boolean
    Whether the order includes items from the selling plan.
    • true: includes
    • false: does not include
  • 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 refunded
    • refunded: order refunded
  • fulfillment_status string
    Shipping status. Valid values are:
    • fulfilled: order shipped
    • partial: order partially shipped
    • null: order not shipped
  • fulfillmentsobject[]
    A list of fulfillment information.
  • created_at string
    The date and time when the fulfillment was created. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
  • id string
    Fulfillment ID.
  • line_itemsobject[]
    Product list.
  • attribute string
    The option information of the product variant, composed of the variant name and the option value.
    Example: color - red
  • bundle_parent_variant_id string
    Parent product variant ID associated with the bundle component product.
  • fulfillable_quantity integer
    The remaining quantity of the product that can be shipped.
  • fulfillment_quantity integer
    The quantity of the product shipped in this fulfillment.
  • fulfillment_service string
    Logistics company name.
  • fulfillment_status string
    Shipping status. Valid values are:
    • fulfilled: order shipped
    • partial: order partially shipped
    • null: order not shipped
  • grams double
    The weight of the product in grams(g).
  • id string
    The ID of the line item snapshot table, generated by the system. Combined with the order ID, it uniquely identifies a line item.
  • image_url string
    The URL address that stores the product image.
  • is_bundle boolean
    Whether the product is a bundle product.
    • true：It is a bundle product.
    • false：It is not a bundle product.
  • is_bundle_component boolean
    Whether the product is a bundle component product.
    • true：It is a bundle component product.
    • false：It is not a bundle component product.
  • location_id string
    Local delivery location number or standard delivery location number.
  • name string
    SKU title, same as title.
  • price string
    The product price in the store currency. The value is rounded to two decimal places.
  • priceSetobject
    The product price, displayed in both the store currency and the buyer currency.
  • presentment_moneyobject
    The amount displayed to the buyer.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount recorded by the merchant.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • product_id string
    The unique identifier for the product corresponding to the variant.
  • quantity integer
    Quantity of products in the order.
  • requires_shipping boolean
    Indicates whether the product is subject to shipping.
    • true：Shipping is required.
    • false：Shipping is not required.
  • sku string
    The product SKU.
  • tax_linesobject[]
    Tax information.
  • price string
    Tax in the store currency. The value is rounded to two decimal places.
  • price_setobject
    The tax amount, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The amount displayed to the buyer.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount recorded by the merchant.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • rate double
    The tax rate as a decimal value, rounded to four decimal places. For example, a 2% tax rate is represented as 0.0200. This field value is for display only.
  • title string
    Tax name.
  • taxable boolean
    Whether the product is subject to tax.
    • true: Tax is required.
    • false: No tax is required.
  • title string
    Product title.
  • variant_id string
    The unique identifier for the variant.
  • variant_title string
    Product variant value. Multiple values are separated by /.
  • vendor string
    Supplier.
  • order_id string
    Order number.
  • shipment_status string
    Fulfillment shipping status. Valid values are:
    • out_for_delivery: out for delivery
    • delivered: delivered
    • faliure: delivery failed
    • picked_up: picked up
  • status string
    Fulfillment status. Valid values are:
    • success: shipment dispatched
    • cancelled: shipment canceled
  • tracking_company string
    Logistics service provider.
    DEPRECATED： This parameter is deprecated from API version v20250601. Refer to tracking_info_list.
  • tracking_info_listobject[]
    A list of tracking information.
  • tracking_company string
    Logistics service provider.
  • tracking_number string
    The tracking number provided by the logistics service provider.
  • tracking_url string
    The domain name of the logistics company.
  • tracking_number string
    The delivery tracking number provided by the logistics service provider.
    DEPRECATED：This parameter is deprecated from API version v20250601. Refer to tracking_info_list.
  • tracking_url string
    The domain name of the logistics company.
    DEPRECATED: This parameter is deprecated from API version v20250601. Refer to tracking_info_list.
  • updated_at string
    The date and time when the fulfillment was updated. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
  • hidden_order boolean
    Indicates whether it is an archived order. Valid values are:
    • true: archived order
    • false: unarchived order
  • id string
    Order ID, system-defined number.
  • landing_site string
    Link to record complete order attribution landing page information.
  • line_itemsobject[]
    A list of order product snapshots.
  • attribute string
    The option information of the product variant, composed of the variant name and the option value.
    Example: color - red
  • bundle_parent_variant_id string
    Parent product variant ID associated with the bundle component product.
  • discount_allocationsobject[]
    The discount amount, displayed in both the buyer currency and the store currency.
  • amount string
    The discount amount. The value is rounded to two decimal places.
  • amount_setobject
    The discount amount, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The amount displayed to the buyer.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount recorded by the merchant.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • discount_application_index integer
    The position of the discount applied to the product within the discount_applications list.
  • dutiesobject[]
    A list of duty information.
  • country_code_of_origin string
    Country or region code indicating the place of origin or shipping origin. Format: ISO 3166-1.
    Example: US
  • harmonized_system_code string
    Harmonized system code, used to categorize a product in international trade.
  • id string
    Tariff number.
  • priceobject
    The duty amount, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The amount displayed to the buyer.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount recorded by the merchant.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • tax_linesobject[]
    A list of tax information.
  • price_setobject
    The tax amount, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The amount displayed to the buyer.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount recorded by the merchant.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • rate double
    The tax rate as a decimal value, rounded to four decimal places. For example, a 2% tax rate is represented as 0.0200. This field value is for display only.
  • rate_percentage double
    The tax rate as a percentage numerical value, rounded to two decimal places. For example, a 2% tax rate is represented as 2.00. This field value is for display only.
  • title string
    Tax name.
  • fulfillable_quantity integer
    The remaining quantity of the product that can be shipped.
  • fulfillment_service string
    Logistics company name.
  • fulfillment_status string
    Shipping status. Valid values are:
    • fulfilled: order shipped
    • partial: order partially shipped
    • null: order not shipped
  • giftCard boolean
    Whether the product is a gift card.
    • true：gift card
    • false：not a gift card
  • grams double
    The weight of the product in grams(g).
  • id string
    The ID of the line item snapshot table, generated by the system. Combined with the order ID, it uniquely identifies a line item.
  • image_url string
    The URL address that stores the product image.
  • is_bundle boolean
    Whether the product is a bundle product.
    • true：It is a bundle product.
    • false：It is not a bundle product.
  • is_bundle_component boolean
    Whether the product is a bundle component product.
    • true：It is a bundle component product.
    • false：It is not a bundle component product.
  • location_id string
    Local delivery location number or standard delivery location number.
  • name string
    SKU title, same as title.
  • price string
    The product price in the store currency. The value is rounded to two decimal places.
  • price_setobject
    The product price, displayed in both the store currency and the buyer currency.
  • presentment_moneyobject
    The amount displayed to the buyer.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount recorded by the merchant.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • product_id string
    The unique identifier for the product corresponding to the variant.
  • propertiesobject[]
    A list of product customization information.
  • additional string
    Additional custom fields for products. For example, if name is text, additional can include attributes such as font size, font style, and color.
  • name string
    Custom attribute name.
  • type string
    Custom information type. Valid values are:
    • text: text type
    • picture: picture type
    • link: hyperlink type
  • urls array
    URL list.
    If type is picture, thumbnails are retrieved via the urls values.
    If type is link, the hyperlink is the first URL in the urls values.
  • value string
    Custom attribute value.
  • quantity integer
    Quantity of products in the order.
  • requires_shipping boolean
    Indicates whether the product is subject to shipping.
    • true：Shipping is required.
    • false：Shipping is not required.
  • sku string
    The product SKU.
  • tags string
    Product tags. Multiple tags are separated by commas.
  • tax_linesobject[]
    Tax details list.
  • price string
    Tax in the store currency. The value is rounded to two decimal places.
  • price_setobject
    The tax amount, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The amount displayed to the buyer.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount recorded by the merchant.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • rate double
    The tax rate as a decimal value, rounded to four decimal places. For example, a 2% tax rate is represented as 0.0200. This field value is for display only.
  • title string
    Tax name.
  • type string
    Tax type. Valid values are:
    • product_tax: product tax
    • shipping_tax: shipping tax
  • taxable boolean
    Whether the product is subject to tax.
    • true: Tax is required.
    • false: No tax is required.
  • title string
    Product title.
  • variant_id string
    The unique identifier for the variant.
  • variant_title string
    Product variant value. Multiple values are separated by /.
  • vendor string
    Supplier.
  • locationsobject[]
    A list of product pickup location addresses.
  • location_id string
    Unique code of the pickup location.
  • name string
    Pickup location name.
  • type string
    Location type. Valid values are:
    • posLocation: The store location where this order was created through the POS channel. It is recommended to use pos_location_id, as this field will be deprecated.
    • pickupLocation: When the order's fulfillment method is self-pickup, this indicates the store location for pickup.
    • productLocation: The inventory location of the items in the order. It is recommended to use the location_id information in the line items, as this field will be deprecated.
  • name string
    Store custom order number, starting from 1001. You can set a prefix for this value, such as test1001.
  • note string
    Merchant notes.
  • note_attributesobject[]
    A list of merchant note logs.
  • create_time string
    Note creation time. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
  • name string
    Merchant ID, indicating the note source.
  • value string
    Notes.
  • order_at string
    Order completion time. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
  • order_source string
    The order source channel handle. The handle is a semantic identifier.
  • order_status_url string
    Order status page URL.
  • payment_detailsobject[]
    A list of order payment information.
  • create_time string
    The date and time when the payment was created. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
  • pay_amount double
    Payment amount in the store currency. The value is rounded to two decimal places.
  • pay_channel_deal_id string
    Payment serial number from the external channel.
  • pay_seq string
    Payment order number.
  • pay_status string
    Payment status. Valid values are:
    • unpaid: unpaid
    • pending: payment in process
    • risking: under risk control
    • paid：paid
    • paid_overtime: payment timeout
    • paid_failed: payment failed
  • payment_channel string
    Payment channel.
  • payment_method string
    Payment method.
  • processed_at string
    Actual payment time. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
  • status_code string
    Payment gateway standard status code.
  • status_msg string
    The description of status_code.
  • payment_gateway_names array
    Payment method list. Valid values are:
    • SLpayments
    • Paypal
    • Oceanpay
    • TwoCheckout
    • AsiaBill
    • Stripe
    • Pacypay
    • WorldPay
    • COD
    • CUSTOM
    • adjustPay
    • Xendit
    • XenditOther
  • payment_termsobject
    Payment terms and payment information.
  • created_at string
    The date and time when the payment terms were created.
    Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
  • due_in_days integer
    The number of days between the invoice date and the due date, as defined in the selected payment terms template. Provided when the payment_terms_type is NET.
  • id string
    The unique identifier for the payment terms.
  • overdue boolean
    Indicates whether the payment terms have expired.
    • true: Expired
    • false: Not expired
  • payment_schedulesobject[]
    A set of schedules associated with the payment terms.
  • completed_at string
    The date and time when the payment completion is recorded.
  • due_at string
    The date and time when the payment terms are due.
    When the value of payment_terms_type is FIXED, due_at must have a value.
    When the value of payment_terms_type is NET, the value of due_at is equal to issued_at plus due_in_days.
    When the value of payment_terms_type is FULFILLMENT, it has a value only when the order is shipped.
  • issued_at string
    The date and time when the payment terms take effect.
    When the value of payment_terms_type is FIXED, if issued_at is empty, then issued_at equals due_at.
    When the value of payment_terms_type is NET, issued_at must have a value.
    When the value of payment_terms_type is FULFILLMENT, it has a value only when the order is shipped.
    When the value of payment_terms_type is RECEIPT, it has a value only when the invoice is sent.
    Example: 2024-08-31T02:20:26+08:00
  • payment_terms_name string
    The name of the payment terms template used to create the payment terms.
  • payment_terms_type string
    The type of payment terms template used to create the payment terms. Valid values are:
    • FIXED: Full payment by the specified date.
    • FULFILLMENT: Full payment when the order is fulfilled.
    • RECEIPT: Full payment when the invoice is sent.
    • NET: NET.
  • updated_at string
    The date and time when the payment terms were last updated.
    Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
  • phone string
    Buyer's mobile phone number.
  • po_number string
    Purchase order number for a B2B order.
  • pos_location_id string
    POS trading location ID.
  • presentment_currency string
    Buyer currency, the same as the store currency. A three-letter currency code that follows the ISO 4217 standard.
    Example: USD
  • processed_at string
    Order completion time. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
  • processed_user_id string
    The ID of the order creator.
  • referring_site string
    Attribution URL, used to record how the buyer was redirected to the online store.
  • refundsobject[]
    Refund list.
  • created_at string
    The date and time when the refund was created. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
  • id string
    Refund ID.
  • note string
    Merchant's refund notes.
  • order_id string
    Order number.
  • processed_at string
    Refund initiation time. Format: ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
  • user_id string
    Buyer ID.
  • serivce string
    Shipping method type. Valid values are:
    • Pickup: pick up in store
    • null: other shipping methods
  • 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.
  • address2 string
    The second line of the address. This typically includes information such as apartment, suite, or unit number.
  • city string
    The city in the address.
  • company string
    The company name of the recipient.
  • country string
    The country or region in the address.
  • 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.
  • delivery_store_code string
    Store ID.
  • delivery_store_name string
    Store name.
  • district string
    The district of the shipping address.
  • district_code string
    The code for the district in the shipping address, custom identifier.
  • first_name string
    The first name of the recipient.
  • last_name string
    The last name of the recipient.
  • latitude string
    The latitude where the address is located.
  • longitude string
    The longitude where the address is located.
  • name string
    The full name of the recipient.
  • phone string
    The phone number of the recipient.
  • province string
    The province in the shipping address.
  • province_code string
    The code for the province or region in the address, automatically generated by the system.
  • standard_province_code string
    The code for the province or region in an address, represented by the last two or three characters of the ISO 3166-2 standard, such as RI or ENG.
  • zip string
    The postal code information of the address.
  • shipping_linesobject[]
    A list of shipping fees.
  • code string
    Only local delivery shipping methods will return a value, displayed as Local delivery .
  • discount_allocationsobject[]
    A list of discount details.
  • amount string
    The discount amount in the store currency. The value is rounded to two decimal places.
  • amount_setobject
    The discount amount, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The amount displayed to the buyer.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount recorded by the merchant.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • discount_application_index integer
    The position of the discount applied to the product within the discount_applications list.
  • discounted_price string
    Discount amount. The value is rounded to two decimal places and displayed in the store currency.
  • discounted_price_setobject
    The discount amount, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The amount displayed to the buyer.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount recorded by the merchant.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • phone string
    The phone number of the buyer.
  • price string
    The shipping fee amount in the store currency. The value is rounded to two decimal places.
  • price_setobject
    The shipping fee amount, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The amount displayed to the buyer.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount recorded by the merchant.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shipping_price string
    The original shipping fee in the store currency, excluding any discounts. The value is rounded to two decimal places.
  • source string
    Logistics carrier type. Valid values are:
    • Shipper: Shipper logistics
    • Oneship: Oneship logistics
    • Api: logistics carriers added via open API capabilities
    • null: system logistics or custom logistics
  • tax_linesobject[]
    A list of tax information.
  • price string
    Tax in the store currency. The value is rounded to two decimal places.
  • price_setobject
    The tax amount, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The amount displayed to the buyer.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount recorded by the merchant.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • rate double
    The tax rate as a decimal value, rounded to four decimal places. For example, a 2% tax rate is represented as 0.0200. This field value is for display only.
  • title string
    Tax name.
  • title string
    Logistics company name.
  • source_identifier string
    The marketing referral code carried by the store link through which the customer accesses the store. The field value is extracted from the URL parameter ref, resource, or r. For example, if the customer visits the URL myshopline.com/products/slide?ref=22dd9dctg, then the value of this field is 22dd9dctg.
  • source_name string
    Indicates the category of the app that initiated this API. Valid values are:
    • sales_plugin_of: The distribution app in the marketing system
    • member_plugin_referral: The referral app in the membership system
  • source_url string
    Attribution URL, used to record how the buyer was redirected to the online store.
  • status string
    Order status. Valid values are:
    • open: The order is processing
    • cancelled: The order is cancelled
  • store_id string
    Store ID.
  • subtotal_price string
    The final price after discounts, calculated as the total product price minus any marketing discounts and custom discounts. The amount is displayed in the store currency.
  • subtotal_price_setobject
    The final price after discounts, calculated as the total product price minus any marketing discounts and custom discounts. This field contains amounts displayed in both the buyer and store currencies.
  • presentment_moneyobject
    The amount displayed to the buyer.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount recorded by the merchant.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • tags string
    Order tags.
  • tax_linesobject[]
    A list of tax information.
  • price string
    Tax in the store currency. The value is rounded to two decimal places.
  • price_setobject
    The tax amount, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The amount displayed to the buyer.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount recorded by the merchant.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • rate double
    The tax rate as a decimal value, rounded to four decimal places. For example, a 2% tax rate is represented as 0.0200. This field value is for display only.
  • title string
    Tax name.
  • tax_number string
    Tax ID.
  • tax_type string
    The type of tax applicable to the order. Valid values are:
    • product_tax: product tax
    • shipping_tax: shipping tax
  • taxes_included boolean
    Indicates whether this order includes taxes.
    • true: including taxes
    • false: excluding taxes
  • total_discounts string
    The total order discount, calculated as the sum of marketing discounts and custom discounts. The amount is rounded to two decimal places and displayed in the store currency.
    DEPRECATED：This parameter is deprecated from API version v20210901.
    Example: 3.25
  • total_discounts_setobject
    The total order discount, calculated as the sum of marketing discounts and custom discounts. This field contains amounts displayed in both the buyer and store currencies.
    DEPRECATED：This parameter is deprecated from API version v20210901.
  • presentment_moneyobject
    The amount displayed to the buyer.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount recorded by the merchant.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • total_line_items_price string
    The total original price of the products, rounded to two decimal places and displayed in the store currency.
  • total_line_items_price_setobject
    The total original price of the products, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The amount displayed to the buyer.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount recorded by the merchant.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • total_outstanding string
    The total unpaid amount in the store currency. The value is rounded to two decimal places.
  • total_outstanding_setobject
    Unpaid amount, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The amount displayed to the buyer.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount recorded by the merchant.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • total_shipping_price_setobject
    The total shipping fee for the order, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The amount displayed to the buyer.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount recorded by the merchant.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • total_tax string
    The total tax amount in the store currency. The value is rounded to two decimal places.
  • total_tax_setobject
    The total tax amount, displayed in both the buyer currency and the store currency.
  • presentment_moneyobject
    The amount displayed to the buyer.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount recorded by the merchant.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • total_tip_received string
    The tip amount in the store currency. The value is rounded to two decimal places.
  • total_tip_received_setobject
    The tip amount, displayed in both the store currency and the buyer currency.
  • presentment_moneyobject
    The amount displayed to the buyer.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • shop_moneyobject
    The amount recorded by the merchant.
  • amount string
    The monetary value, rounded to two decimal places.
  • currency_code string
    A three-letter currency code following the ISO 4217 standard.
    Example: USD
  • total_weight double
    The total weight of products in grams(g).
  • updated_at string
    The date and time when the order was updated. Format：ISO 8601.
    Example: 2024-08-31T02:20:26+08:00
  • user_id string
    Buyer ID.
  • utm_parameters string
    Parameters specifically designed for the advertising business, used for ad attribution calculation.
Status Codes
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.