Order update

Event GroupEvent Identification
ordersorders/updated
Order update
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
    Adjust the amount, the balance amount caused by the rounding of the amount in the POS scenario
    Example: 8.00
  • adjust_price_setobject
    Adjustment amount calculated in store currency and transaction currency
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Amount information on the seller’s side
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • billing_addressobject
    billing address
  • address1 string
    Detailed address 1
    Example: Address 1
  • address2 string
    Detailed address 2, optional
    Example: Address 2
  • city string
    City
    Example: New York
  • company string
    Company Name
    Example: New company name
  • country string
    country / region
    Example: USA
  • country_code string
    Country code
    Example: US
  • first_name string
    First name
    Example: Tom
  • last_name string
    Last name
    Example: Washington
  • name string
    Name
    Example: Tom Washington
  • phone string
    Phone
    Example: 18723465843
  • province string
    Provincial/secondary address
    Example: California
  • province_code string
    Provincial/secondary address coding
    Example: 4200006
  • zip string
    Postal code
    Example: 54213
  • browser_ip string
    browser ip
    Example: 157.119.232.35
  • buyer_note string
    Buyer notes
    Example: Notes
  • cancel_reason string
    Reason for order cancellation
    Example: I don't want to buy it.
  • cancelled_at string
    Cancellation time
    Example: 2012-05-01T14:22:25-04:00
  • cart_token string
    Shopping cart token
    Example: c2c4a58186b9d96395d7e6b5c2969577
  • checkout_id string
    The abandoned order id associated with the current order
    Example: 2404785166526352972864
  • checkout_token string
    Checkout page token
    Example: c2c4a58186b9d96395d7e6b5c2969577
  • client_detailsobject
    Client information
  • browser_ip string
    Browser IP
    Example: 157.119.232.35
  • session_hash string
    Member session encryption information
    Example: c2c4a58186b9d96395d7e6b5c2969577
  • 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
    uuid
    Example: 432354345
  • companyobject
    Company info
  • id string
    Company id
    Example: 1005619945158043247856
  • location_id string
    Location id
    Example: 3005619945158043247856
  • tax_registration_id string
    Tax registration id
    Example: 213213
  • created_at string
    Create order time
    Example: 2021-08-16T08:27:57+00:00
  • credit_limitobject
    credit payment
  • credit_limit_currency string
    Currency of the credit limit, currently in store currency
    Example: USD
  • is_credit_limit boolean
    Whether the order used credit payment true: Used false: Not used
    Example: true
  • outstanding_credit_limit string
    Total credit limit occupied by the order
    Example: 1.00
  • total_credit_limit string
    Total credit limit used for the order
    Example: 1.00
  • currency string
    Settlement currency
    Example: USD
  • current_subtotal_price string
    Current Product sum , Product total quantity
    Example: 8.00
  • current_subtotal_price_setobject
    Multi-currency information of the current commodity sum, the buyer's and seller's currency and the amount are the same
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • current_total_discounts string
    Sum of discounts, precision 2, marketing offers + artificial discounts
    Example: 8.00
  • current_total_discounts_setobject
    Discount sum multi-currency information, there is no multi-currency, so the currency and amount of the buyer and seller are the same
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • current_total_duties_setobject
    Current total tariff on goods
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount
    Example: 8.88
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount
    Example: 8.88
  • currency_code string
    Currency
    Example: USD
  • current_total_price string
    Current order total, value logic: total merchandise amount - total discount amount + shipping fee + tax
    Example: 8.00
  • current_total_price_setobject
    Multi-currency information of the current order total, the buyer's and seller‘s currency and the amount are the same
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • current_total_tax string
    Total tax , product tax + shipping tax
    Example: 8.00
  • current_total_tax_setobject
    Multi-currency information of the sum of taxes, the currency and amount of buyers and sellers are the same
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • customerobject
    Buyer information
  • addressesobject
    address
  • address1 string
    Detailed address 1
    Example: Address 1
  • address2 string
    Detailed address 2, optional
    Example: Address 2
  • city string
    City
    Example: New York
  • country string
    country / region
    Example: USA
  • country_code string
    Country code
    Example: US
  • first_name string
    First name
    Example: Tom
  • last_name string
    Last name
    Example: Washington
  • name string
    Full name
    Example: Tom Washington
  • phone string
    Phone
    Example: 13100000000
  • province string
    Province
    Example: California
  • province_code string
    Provincial encoding
    Example: 4200006
  • zip string
    Postal code
    Example: 98734
  • area_code string
    Phone area code
    Example: +86
  • created_at string
    Buyer creation time
    Example: 2022-11-04T10:18:46+00:00
  • currency string
    Currency
    Example: USD
  • email string
    User mailbox
    Example: test1001@Gmail.com
  • first_name string
    First name
    Example: Tom
  • id string
    User ID
    Example: 4201057495
  • last_name string
    Last name
    Example: Washington
  • phone string
    User mobile phone number
    Example: 13100000000
  • customer_locale string
    Buyer’s country language code + country name abbreviation
    Example: enCN
  • deduct_member_point_amount string
    Member points deduction amount for current order
    Example: 8.00
  • deduct_member_point_amount_setobject
    Current order member points deduction amount, multi-currency information
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount
    Example: 8.88
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount
    Example: 8.88
  • currency_code string
    Currency
    Example: USD
  • discount_applicationsobject[]
    All discount information applied to this order
  • allocation_method string
    Active discount application range 1) across (the value is distributed across all authorization lines) 2) each (the value applies to each authorization line)
    Example: across
  • code string
    Discount code
    Example: 1Q3UMQM8RBP5
  • description string
    Detailed description of the activity
    Example: Detailed description of the activity
  • target_selection string
    The specific objects for the active discount application are 1) explicit (discounts are allocated to explicitly selected product lines or freight lines) 2) all (discounts are allocated to all product lines or freight lines) 3) ENTITLED (discounts are only allocated to products that they are entitled to use) line or freight line)
    Example: all
  • target_type string
    Active discount application objects 1) line_item 2) shipping_line
    Example: line_item
  • title string
    Title for automatic discount
    Example: Detailed description of the activity
  • type string
    Activity discount type 1) manual (custom type) 2) automatic (automatic discount type) 3) discount_code (discount code type)
    Example: manual
  • value string
    Event discount value
    Example: 20
  • value_type string
    The discount value type of the activity, including percentage and fixed amount.
    Example: fixed_amount
  • discount_codesobject[]
    Promo code information
  • amount string
    Discount amount , accuracy 2
    Example: 8.00
  • amount_setobject
    Amount , multi-currency information
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount
    Example: 8.00
  • currency_code string
    Currency
    Example: currency_code
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • code string
    Promo code
    Example: KIN4GNAB2FRH
  • type string
    Types of discounts, 1-amount reduction; 2-discount; 3-free shipping; 8-fixed price; 9-lowest priced item free; 10-package price; 11-discount on the Nth item;
    Example: Reduction amount
  • email string
    Buyer's email
    Example: test001@Gmail.com
  • financial_status string
    Payment status : unpaid- not paid ; authorized- authorized ; pending- payment ; partially_paid- partial payment ; paid- paid ;Partially_refunded- part refund ; refunded- refunded ;
    Example: unpaid
  • fulfillment_status string
    Shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped; Note: the returned enum value is different from the query enumeration value of the input parameter
    Example: fulfilled
  • fulfillmentsobject[]
    Package information
  • created_at string
    Creation time (see IOS8601 for the format)
    Example: 2022-11-04T10:18:46+00:00
  • id string
    Package number
    Example: 22046737798141702810214336
  • line_itemsobject[]
    Product list
  • attribute string
    Product attributes: name - attribute value. Multiple separated by comma ", ". For example: color - red, size - X
    Example: big
  • fulfillable_quantity integer
    Available quantity
    Example: 1
  • fulfillment_quantity integer
    The number of shipments
    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, shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped;
    Example: fulfilled
  • grams double
    Weight ( grams )
    Example: 100
  • id string
    The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number
    Example: 412
  • image_url string
    product picture
    Example: https://d2n979dmt31clo.cloudfront.net/image/store/4211449909/1667384795847/63928f08a7174ab2958c6a969
  • location_id string
    Location ID
    Example: 5445886274929439997
  • name string
    Sku title
    Example: test-002
  • price string
    Product selling price , accuracy 2
    Example: 8.00
  • price_setobject
    Product selling price , multi-currency information
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • product_id string
    SPU serial number
    Example: 16056761559984840457934011
  • quantity integer
    Quantity of items in the order
    Example: 3
  • requires_shipping boolean
    Shipping or not
    Example: true
  • sku string
    Product yards
    Example: 18056761559987524812644011
  • tax_linesobject[]
    Tax information
  • price string
    Price
    Example: 8.00
  • price_setobject
    Multi-currency information of tax
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • rate double
    Tax rate
    Example: 1
  • title string
    Tax name
    Example: Tax
  • taxable boolean
    Tax or not？
    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 " / ", such as: "155 / red / large"
    Example: big
  • vendor string
    Supplier
    Example: Supplier
  • name string
    Shipping short
    Example: 1032-F2
  • order_id string
    Order number
    Example: 21056577640603870897253153
  • shipment_status string
    Package tracking
    Example: fulfilled
  • status string
    Logistics delivery status, success-shipped; cancelled-cancelled;
    Example: success
  • tracking_company string
    Logistics company name
    Example: Sf international
  • tracking_number string
    Third party tracking number
    Example: yun0001
  • tracking_url string
    Logistics company URL
    Example: https://www.sf-international.com/
  • updated_at string
    Update time (see IOS8601 for the format)
    Example: 2022-11-04T10:18:46+00:00
  • hidden_order boolean
    Whether it is an archived order, true=archived order, false=unarchived order
    Example: true
  • id string
    System order number
    Example: 21056577640603870897253153
  • line_itemsobject[]
    Order product snapshot information
  • attribute string
    Product attributes: name - attribute value. Multiple separated by comma ", ". For example: color - red, size - X
    Example: red
  • discount_allocationsobject[]
    Discount details in multiple currencies
  • amount string
    Discount detailed amount
    Example: 8.00
  • amount_setobject
    Discount details in multiple currencies
  • presentment_moneyobject
    Payment currency
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Store currency
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • discount_application_index integer
    Indicate the position in the discount details
    Example: 1
  • dutiesobject[]
    Tariff information
  • country_code_of_origin string
    Country code of origin/shipping point
  • harmonized_system_code string
    Customs code
  • id string
    Tariff number
  • priceobject
    Tariff multi-currency information
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount
    Example: 8.88
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount
    Example: 8.88
  • currency_code string
    Currency
    Example: USD
  • tax_linesobject[]
    Tax details list
  • price_setobject
    Multi-currency information of tax
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount
    Example: 8.88
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount
    Example: 8.88
  • currency_code string
    Currency
    Example: USD
  • rate double
    Tax rate
  • rate_percentage double
    Tax rate (percentage value, i.e. rate * 100)
  • title string
    Tax title
  • fulfillable_quantity integer
    Available quantity
    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, shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped;
    Example: yun0001
  • gift_card boolean
    Wei or not for gift cards
  • grams double
    Weight ( grams )
    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
  • location_id string
    Location ID
    Example: 5327026538935748524
  • name string
    Sku title
    Example: Product title
  • price string
    Commodity price, precision 2
    Example: 8.00
  • price_setobject
    Product selling price , multi-currency amount information
  • presentment_moneyobject
    Payment currency
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Store currency
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • product_id string
    SPU serial number
    Example: 16056761559984840457934011
  • propertiesobject[]
    Product customization information
  • additional string
    Custom Product add-on field
    Example: Attach
  • name string
    Custom attribute name
    Example: Custom properties
  • type string
    Attribute type, text-character, the display format is name: value; picture-picture, the display type is name: get the rendered thumbnail through URLs; link-hyperlink, the display type is name: value, supports clicking on the link to jump to urls First
    Example: text
  • urls array
    URL resource list
    Example: https://www.url.com
  • value string
    Custom attribute values
    Example: Custom attribute values
  • quantity integer
    Quantity of items in the order
    Example: 1
  • requires_shipping boolean
    Shipping or not
    Example: true
  • sku string
    Product yards
    Example: 18056761559987524812644011
  • tags string
    Product tags (multiple commas separated)
    Example: watch
  • tax_linesobject[]
    Tax information
  • price string
    Price
    Example: 8.00
  • price_setobject
    Multi-currency information of tax
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    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. The enumeration value is as follows product_tax: commodity tax shipping_tax: freight tax
    Example: shipping_tax
  • taxable boolean
    Tax or not？
    Example: true
  • title string
    Product title
    Example: Nice looking skirt
  • variant_id string
    Product SKU serial number
    Example: 18056761559987524812644011
  • variant_title string
    Commodity attribute value, multiple divided by " / ", such as: "155 / red / large"
    Example: big
  • vendor string
    Supplier
    Example: Supplier
  • locationsobject[]
    Location information
  • location_id string
    Location ID
    Example: 5327026538935748524
  • name string
    Location name
    Example: us.street
  • type string
    1.posLocation: The store location where the order was created through the POS channel (it is recommended to use posLocationId, which will be abandoned later) 2.pickupLocation: When the delivery method of the order is self-pickup, the store location for self-pickup 3.productLocation: The inventory location of the goods in the order (It is recommended to use the location information in the product line, which will be abandoned later)
    Example: posLocation
  • name string
    Custom order number (will change)
    Example: test001
  • note string
    Merchant remark content, multiple separated by commas
    Example: Notes
  • note_attributesobject[]
    Merchant note log, date content
  • create_time string
    Remark creation time (see IOS8601 for the format)
    Example: 2022-11-04T10:18:46+00:00
  • name string
    Remark source (seller ID)
    Example: Note source
  • value string
    Notes
    Example: Content
  • order_at string
    Order completion time
    Example: 2021-08-16T08:27:57+00:00
  • order_source string
    The order source channel. Currently, this field only has a value for the POS channel, and the value is empty for other channels.
    Example: pos
  • order_status_url string
    Order status page URL
    Example: https://shoptest.myshopline.com/trade/thank_you?mainOrderMark=xxx&mainOrderSeq=200565776406008509
  • payment_detailsobject[]
    Payment slip information
  • create_time string
    Payment slip creation time
    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 status
    Example: unpaid
  • processed_at string
    Payment creation time , format : 2023-04-12T22 : 59 : 52+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
    Example: Paypal
  • payment_termsobject
    Payment terms
  • created_at string
    Create time
    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 (ID) that identifies this payment term
    Example: 6497210673894431747
  • overdue boolean
    Is the payment term overdue: true/false
    Example: true
  • payment_schedulesobject[]
    A set of schedules associated with the payment terms
  • completed_at string
    Payment completion date
    Example: 2024-06-05 08:00:00
  • due_at string
    Expected payment date
    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: FIXED: Merchant specified date FULFILLMENT: Fulfillment (Shipment) completion date NET: Fixed condition date RECEIPT: Billing sent date UNKNOWN: Unknown type
    Example: RECEIPT
  • updated_at string
    Update time
    Example: 2024-06-05 08:00:00
  • phone string
    Buyer contact information
    Example: 13100000000
  • po_number string
    Purchase order number recorded on the order in B2B scenarios
  • pos_location_id string
    pos trading location
    Example: 5227248679317408779
  • presentment_currency string
    Buy side currency
    Example: USD
  • processed_at string
    Order time , format : 2023-04-12T22 : 59 : 52+08 : 00 2023-04-12T22 : 59 : 52+08 : 00
    Example: 2023-04-12T22:59:52+08:00
  • processed_user_id string
    Order creator
    Example: 4201057495
  • refundsobject[]
    Refund list
  • created_at string
    Refund form creation time (see IOS8601 for the format)
    Example: 2021-08-16T08:27:57+00:00
  • id string
    Refund ID
    Example: 2605659027312156877634
  • note string
    Refund Notes
    Example: Notes
  • order_id string
    Order number
    Example: 21056577640603870897253153
  • processed_at string
    Update time
    Example: 2021-08-16T08:27:57+00:00
  • refund_line_itemsobject[]
    Refund Product
  • id string
    Refund order number
    Example: 2605659027312156877634
  • line_item_id string
    The ID of the product snapshot table, generated by the system, uniquely confirms a product with the order number
    Example: 101
  • quantity string
    Quantity, quantity of goods
    Example: 1
  • restock_type string
    Inventory return type , no_restock- is not returned , cancel- is cancelled , return- is returned
    Example: no_restock
  • subtotal string
    Total refund amount, precision 2
    Example: 1.00
  • subtotal_setobject
    Total refund amount, multi-currency information, same on seller and buyer side
  • presentment_moneyobject
    Buy side currency
  • amount string
    Amount, Precision 2
    Example: 1.00
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount, Precision 2
    Example: 1.00
  • currency_code string
    Currency
    Example: USD
  • total_tax_setobject
    Total tax amount, multi-currency information
  • presentment_moneyobject
    Buy side currency
  • amount string
    Amount, Precision 2
    Example: 1.00
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount, Precision 2
    Example: 1.00
  • currency_code string
    Currency
    Example: USD
  • user_id string
    User ID
    Example: 4201057495
  • shipping_addressobject
    Shipping address
  • address1 string
    Detailed address 1
    Example: Address 1
  • address2 string
    Detailed address 2, optional
    Example: Address 2
  • city string
    City
    Example: New York
  • company string
    Company Name
    Example: new company
  • country string
    Country
    Example: USA
  • country_code string
    Country code
    Example: US
  • delivery_store_code string
    Store ID
    Example: 1001
  • delivery_store_name string
    Store name
    Example: Store
  • district string
    District
    Example: Panyu district
  • district_code string
    District code
    Example: 5213300
  • first_name string
    First name
    Example: Tom
  • last_name string
    Last name
    Example: Washington
  • latitude string
    Address latitude
    Example: 23.35773
  • longitude string
    address longitude
    Example: 116.4151
  • name string
    Full name
    Example: Tom Washington
  • phone string
    Phone
    Example: 13100000000
  • province string
    Province
    Example: California
  • province_code string
    Province code
    Example: 4200006
  • zip string
    Postal code
    Example: 521000
  • shipping_linesobject[]
    Logistics information
  • code string
    Logistics number
    Example: SF1232344456776
  • discount_allocationsobject[]
    Discount details multi-currency display
  • amount string
    Discount amount, precision 2
    Example: 8.00
  • amount_setobject
    Discount multi-currency amounts
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Store side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • discount_application_index integer
    position in discount details
    Example: 1
  • discounted_price string
    Discount amount, precision 2
    Example: 8.00
  • discounted_price_setobject
    Discount multi-currency amounts
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Store side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • phone string
    Phone
    Example: 13100000000
  • price string
    Logistics shipping , double type string
    Example: 8.00
  • price_setobject
    Logistics freight multi-resource information
  • presentment_moneyobject
    Currency amount on buyer’s side
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Currency amount on seller side
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • shipping_price string
    Original freight amount (non-discount amount)
    Example: 8.00
  • source string
    Logistics type
    Example: SHOPLINE
  • tax_linesobject[]
    Logistics tax information
  • price string
    Price
    Example: 8.00
  • price_setobject
    Multi-currency information of tax
  • presentment_moneyobject
    Currency amount on buyer’s side
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Currency amount on seller side
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • rate double
    Tax rate
    Example: 1
  • title string
    Tax name
    Example: Tax
  • title string
    Logistics name
    Example: Sf international
  • status string
    Order status, open-processing, canceled-cancelled
    Example: open
  • store_id string
    Store id
    Example: 1644828244663
  • subtotal_price string
    Total product price after discount, total product price - marketing discount - artificial discount
    Example: 8.00
  • subtotal_price_setobject
    Multi-currency information of total product price after discount
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • tags string
    order label
    Example: watch
  • tax_linesobject[]
    Tax information
  • price string
    Price
    Example: 8.00
  • price_setobject
    Multi-currency amount information
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • rate double
    Tax rate
    Example: 1
  • title string
    Tax name
    Example: Tax
  • tax_number string
    TIN
    Example: 11111
  • tax_type string
    Types of tax ID
    Example: Type
  • taxes_included boolean
    Does the total include tax?
    Example: true
  • total_discounts string
    Total discount, marketing discount + artificial discount
    Example: 8.00
  • total_discounts_setobject
    Multi-currency information of discount total
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • total_line_items_price string
    Sum of original prices of goods, precision 2
    Example: 8.00
  • total_line_items_price_setobject
    Total original price of goods, multi-currency information
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • total_outstanding string
    Sum of unpaid amount, precision 2
    Example: 8.00
  • total_outstanding_setobject
    Total unpaid amount, multi-currency information
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount
    Example: 8.88
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount
    Example: 8.88
  • currency_code string
    Currency
    Example: USD
  • total_shipping_price_setobject
    Order shipping sum, multi-currency information
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • total_tax string
    Sum of taxes, precision 2, commodity tax + shipping tax
    Example: 8.00
  • total_tax_setobject
    Total taxes and fees, multi-currency information
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Amount information on the seller’s side
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • total_tip_received string
    Tip, precision 2
    Example: 8.00
  • total_tip_received_setobject
    Tips, multi-currency information
  • presentment_moneyobject
    Buyer side amount information
  • amount string
    Amount
    Example: 8.88
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Sell side amount information
  • amount string
    Amount
    Example: 8.88
  • currency_code string
    Currency
    Example: USD
  • total_weight double
    Total product weight ( g )
  • updated_at string
    Order update time, (see IOS8601 for the format)
    Example: 2021-08-16T08:27:57+00:00
  • user_id string
    Buyer ID
    Example: 4201057495
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.

Error loading component.

Error loading component.