Orders deletion

Event GroupEvent Identification
ordersorders/delete
Order delete
Request Headers
  • 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
    Adjust the amount, the balance amount caused by rounding in the POS scenario
    Example: 8.00
  • adjust_price_setobject
    Adjustment amount in store currency and transaction currency
  • presentment_moneyobject
    Amount information on the buyer's side
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Amount information on the seller 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
    Province/Secondary Address Code
    Example: 4200006
  • zip string
    Postal code
    Example: 54213
  • browser_ip string
    Browser IP
    Example: 157.119.232.35
  • buyer_note string
    Buyer's Notes
    Example: Remark
  • cancel_reason string
    Reason for 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
    Settlement 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 information
  • id string
    Company ID
    Example: 1026538935748524
  • location_id string
    Location ID
    Example: 326538935748524
  • tax_registration_id string
    Tax ID Information
    Example: 503002
  • created_at string
    Order creation time
    Example: 2021-08-16T08:27:57+00:00
  • currency string
    Settlement currency
    Example: USD
  • current_subtotal_price string
    Current total of goods, total price*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 and multi-currency information. There is no multi-currency, so the buyer and seller currencies and amounts 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 tariffs 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
    The current order total, value logic: total amount of goods - total discount + 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 taxes, 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
    Province Code
    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 abbreviation
    Example: CN
  • deduct_member_point_amount string
    The current order member points deduction amount
    Example: 8.00
  • deduct_member_point_amount_setobject
    The 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 discounts applied to this order
  • allocation_method string
    The scope of the discount application of the activity 1) across (the value is distributed across all authorization lines) 2) each (the value is applied 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
    Specific objects of the activity discount application 1) explicit (the discount is allocated to the explicitly selected product line or freight line) 2) all (the discount is allocated to all product lines or freight lines) 3) ENTITLED (the discount is only allocated to the product lines or freight lines that the user is entitled to use)
    Example: all
  • target_type string
    The discount is applied to 1) line_item 2) shipping_line
    Example: line_item
  • title string
    Title of 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
    Discount value of the event
    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, precision 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
    Discount type: 1-reduction amount; 2-discount; 3-free shipping; 8-fixed selling price; 9-free lowest priced item; 10-package price; 11-discount for the Nth item;
    Example: Reduction amount
  • email string
    Buyer's Email
    Example: test001@Gmail.com
  • financial_status string
    Payment status: unpaid - unpaid; authorized - authorized; pending - payment; partially_paid - partially paid; paid - paid; partially_refunded - partially refunded; 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 attributes are separated by commas, such as: 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
    The name of the logistics provider. If a product has multiple different delivery service providers, separate them with commas.
    Example: SF Express 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 price, precision 2
    Example: 8.00
  • price_setobject
    Product 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 Code
    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: Taxes
  • 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
    Invoice Short Number
    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 Express 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
    Is it an archived order? true = archived order, false = not archived order
    Example: true
  • id string
    System order number
    Example: 21056577640603870897253153
  • line_itemsobject[]
    Order product snapshot information
  • attribute string
    Product attributes: Name - Attribute value Multiple attributes are separated by commas, such as: Color - Red, Size - X
    Example: red
  • discount_allocationsobject[]
    Discount details amount in multiple currencies
  • amount string
    Discount details amount
    Example: 8.00
  • amount_setobject
    Discount details amount 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 place
  • 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 string
    Tax rate
  • rate_percentage string
    Tax rate (the percentage value, i.e. rate * 100)
  • title string
    Tax Title
  • fulfillable_quantity integer
    Available quantity
    Example: 1
  • fulfillment_service string
    The name of the logistics provider. If a product has multiple different delivery service providers, separate them with commas.
    Example: SF Express International
  • fulfillment_status string
    The shipping status of the product, shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped;
    Example: yun0001
  • gift_card boolean
    Is it a gift card product?
  • 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 price, amount information 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
  • product_id string
    SPU serial number
    Example: 16056761559984840457934011
  • propertiesobject[]
    Product customization information
  • additional string
    Custom product additional fields
    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 Code
    Example: 18056761559987524812644011
  • tags string
    Product tags (separate multiple tags with commas)
    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: Taxes
  • type string
    Tax type, used to distinguish between product tax and shipping tax. The enumeration values ​​are as follows: product_tax: product tax shipping_tax: shipping tax
    Example: shipping_tax
  • taxable boolean
    Tax or not？
    Example: true
  • title string
    Product title
    Example: Nice 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
    Place Name
    Example: us.street
  • type string
    1.posLocation: the store location where the POS channel created the order (it is recommended to use posLocationId, which will be discarded later) 2.pickupLocation: when the delivery method of the order is self-pickup, the store location of the self-pickup 3.productLocation: the inventory location of the product in the order (it is recommended to use the location information in the product line, which will be discarded later)
    Example: posLocation
  • name string
    Custom order number (subject to change)
    Example: test001
  • note string
    Merchant remarks, multiple remarks separated by commas
    Example: Remark
  • 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: Notes Source
  • value string
    Notes
    Example: content
  • order_at string
    Order time
    Example: 2021-08-16T08:27:57+00:00
  • order_source string
    The order source channel. Currently, only the POS channel has this field. Other channels have this field value.
    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 by 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, the payment method list used for this order
    Example: ["Paypal"]
  • phone string
    Buyer contact information
    Example: 13100000000
  • pos_location_id string
    POS transaction 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: Remark
  • order_id string
    Order number
    Example: 21056577640603870897253153
  • processed_at string
    Update time
    Example: 2021-08-16T08:27:57+00:00
  • refund_line_itemsobject[]
    Refund Items
  • 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-not returned, cancel-cancel, return-return
    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 and amounts displayed in multiple currencies
  • amount string
    Discount amount, precision 2
    Example: 8.00
  • amount_setobject
    Discount multi-currency amount
  • 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 amount
  • 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 freight, double type string
    Example: 8.00
  • price_setobject
    Logistics freight multi-resource information
  • presentment_moneyobject
    Buyer's currency amount
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Seller's currency amount
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • shipping_price string
    Original freight amount (not discounted 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
    Buyer's currency amount
  • amount string
    Amount, Precision 2
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Seller's currency amount
  • 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: Taxes
  • title string
    Logistics name
    Example: SF Express International
  • status string
    Order status, open - in process, cancelled - canceled
    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 Tags
    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: Taxes
  • 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 outstanding 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 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
    Tipping, 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
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.