Order partially shipped
Event Group | Event Identification |
---|---|
orders | orders/partially_fulfilled |
Order Partially Shipped
Request Headers
- X-Shopline-Topic string requiredEvent operation identificationExample:
orders/edited
- X-Shopline-Hmac-Sha256 string requiredSignatureExample:
XWmrwMey6OsLMeiZKwP4FppHH3cmAiiJJAweH5Jo4bM=
- X-Shopline-Shop-Domain string requiredShop domainExample:
shophub.myshopline.com
- X-Shopline-Shop-Id string requiredShop IDExample:
1610418123456
- X-Shopline-Merchant-Id string requiredMerchant IDExample:
2000001234
- X-Shopline-API-Version string requiredVersionExample:
v20210901
- X-Shopline-Webhook-Id string requiredMessage IDExample:
b54557e48a5fbf7d70bcd043
Request Body
- adjust_price stringAdjust the amountExample:
8.00
adjust_price_setobject
Adjust the amountpresentment_moneyobject
Buyer side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
shop_moneyobject
Amount information on the seller’s sideamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
billing_addressobject
billing addressaddress1 stringDetailed address 1Example:Address 1
address2 stringDetailed address 2, optionalExample:Address 2 , alternative
city stringCityExample:Guangzhou
company stringCompany NameExample:new company
country stringcountry / regionExample:China
country_code stringCountry codeExample:CHN
first_name stringFirst nameExample:Tom
last_name stringLast nameExample:Washington
name stringNameExample:Tom Washington
phone stringPhoneExample:13100000000
province stringProvincial/secondary addressExample:Guangdong
province_code stringProvincial/secondary address codingExample:4200005
zip stringPostal codeExample:515000
- browser_ip stringbrowser ipExample:
157.119.232.35
- cancel_reason stringReason for order cancellationExample:
I don't want to buy it.
- cancelled_at stringCancellation timeExample:
2012-05-01T14:22:25-04:00
- checkout_id stringThe abandoned order id associated with the current orderExample:
2404785166526352972864
client_detailsobject
Client informationbrowser_ip stringBrowser IPExample:157.119.232.35
session_hash stringMember session encryption informationExample:90c6724a-cf0d-4517-bd61-5c2727c2f886
user_agent stringClient ProxyExample:Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/106.0.0.0 Sa
uuid stringuuidExample:4201057495
- created_at stringCreate order timeExample:
2012-05-01T14:22:25-04:00
- currency stringSettlement currencyExample:
USD
- current_subtotal_price stringCurrent Product totalExample:
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 samepresentment_moneyobject
Buyer side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
shop_moneyobject
Sell side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
- current_total_discounts stringDiscount totalExample:
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 samepresentment_moneyobject
Buyer side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
shop_moneyobject
Sell side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
current_total_duties_setobject
Current total tariff on goodspresentment_moneyobject
Buyer side amount informationamount stringAmountExample:8.88
currency_code stringCurrencyExample:USD
shop_moneyobject
Sell side amount informationamount stringAmountExample:8.88
currency_code stringCurrencyExample:USD
- current_total_price stringTotal current orderExample:
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 samepresentment_moneyobject
Buyer side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
shop_moneyobject
Sell side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
- current_total_tax stringTax totalExample:
8.00
current_total_tax_setobject
Multi-currency information of the sum of taxes, the currency and amount of buyers and sellers are the samepresentment_moneyobject
Buyer side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
shop_moneyobject
Sell side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
customerobject
Buyer informationaddressesobject
addressaddress1 stringDetailed address 1Example:Address 1
address2 stringDetailed address 2, optionalExample:Address 2
city stringCityExample:Guangzhou
country stringcountry / regionExample:China
country_code stringCountry codeExample:CHN
first_name stringFirst nameExample:Tom
last_name stringLast nameExample:Washington
name stringFull nameExample:Tom Washington
phone stringPhoneExample:13100000000
province stringProvinceExample:Guangdong
province_code stringProvincial encodingExample:4200006
zip stringPostal codeExample:521000
area_code stringPhone area codeExample:+86
created_at stringBuyer creation timeExample:2022-11-04T10:18:46+00:00
currency stringCurrencyExample:USD
email stringUser mailboxExample:Washingtontest@gmail.com
first_name stringFirst nameExample:Tom
id stringUser IDExample:4201057495
last_name stringLast nameExample:Washington
phone stringUser mobile phone numberExample:13100000000
- customer_locale stringBuyer’s country language code + country name abbreviationExample:
enCN
- deduct_member_point_amount stringMember points deduction amount for current orderExample:
8.00
deduct_member_point_amount_setobject
Current order member points deduction amount, multi-currency informationpresentment_moneyobject
Buyer side amount informationamount stringAmountExample:8.88
currency_code stringCurrencyExample:USD
shop_moneyobject
Sell side amount informationamount stringAmountExample:8.88
currency_code stringCurrencyExample:USD
discount_applicationsobject[]
All discount information applied to this orderallocation_method stringActive discount application range 1) across (the value is distributed across all authorization lines) 2) each (the value applies to each authorization line)Example:each
code stringDiscount codeExample:1Q3UMQM8RBP5
description stringDetailed description of the activityExample:Detailed description of the activity
target_selection stringThe 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 stringActive discount application objects 1) line_item 2) shipping_lineExample:line_item
title stringTitle for automatic discountExample:Discount title
type stringActivity discount type 1) manual (custom type) 2) automatic (automatic discount type) 3) discount_code (discount code type)Example:manual
value stringEvent discount valueExample:20
value_type stringThe discount value type of the activity, including percentage and fixed amount.Example:fixed_amount
discount_codesobject[]
Promo code informationamount stringDiscount amount , accuracy 2Example:8.00
amount_setobject
Discount amount, multi-currency informationpresentment_moneyobject
Buyer side amount informationamount stringAmountExample:8.00
currency_code stringCurrencyExample:USD
shop_moneyobject
Sell side amount informationamount stringAmountExample:8.00
currency_code stringCurrencyExample:USD
code stringPromo codeExample:KIN4GNAB2FRH
type stringTypes 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 stringBuyer's emailExample:
hok@shoplineapp.com
- financial_status stringPayment status: unpaid-unpaid; pending-pending; partially_paid-partially paid; paid-paid; partially_refunded-partially refunded; refunded-refunded;Example:
unpaid
- fulfillment_status stringShipping status, fulfilled-shipped; partial-partially shipped; null-unshipped; Note: the returned enum value is different from the query enumeration value of the input parameterExample:
fulfilled
fulfillmentsobject[]
Package informationcreated_at stringCreate time ( format see ISO 8601 )Example:2022-11-04T10:18:46+00:00
id stringPackage numberExample:22046737798141702810214336
line_itemsobject[]
Product listattribute stringProduct attributes: name - attribute value. Multiple separated by comma ", ". For example: color - red, size - XExample:big
fulfillable_quantity integerAvailable quantityExample:2
fulfillment_quantity integerThe number of shipmentsExample:1
fulfillment_service stringLogistics business name , if there are multiple different delivery providers in Product , then use separated by ','Example:Sf international
fulfillment_status stringThe shipping status of the product, shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped;Example:fulfilled
grams doubleWeight ( grams )Example:100
id stringThe ID of the product snapshot table, generated by the system, uniquely confirms a product with the order numberExample:415
image_url stringproduct pictureExample:https://d2n979dmt31clo.cloudfront.net/image/store/4211449909/1667384795847/63928f08a7174ab2958c6a969
location_id stringLocation IDExample:5445886274929439997
name stringSku titleExample:test-002
price stringProduct selling priceExample:8.00
price_setobject
Product selling price , multi-currency informationpresentment_moneyobject
Buyer side amount informationamount stringAmountExample:8.00
currency_code stringCurrencyExample:USD
shop_moneyobject
Sell side amount informationamount stringAmountExample:8.00
currency_code stringCurrencyExample:USD
product_id stringSPU serial numberExample:16056761559984840457934011
quantity integerQuantity of items in the orderExample:2
requires_shipping booleanShipping or notExample:true
sku stringProduct yardsExample:18056761559987524812644011
tax_linesobject[]
Tax informationprice stringPriceExample:8.00
price_setobject
Multi-currency information of taxpresentment_moneyobject
Buyer side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
shop_moneyobject
Sell side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
rate doubleTax rateExample:1
title stringTax nameExample:Tax
taxable booleanTax or not?Example:true
title stringProduct titleExample:Beautiful skirt
variant_id stringProduct SKU serial numberExample:18056761559987524812644011
variant_title stringCommodity attribute value, multiple divided by " / ", such as: "155 / red / large"Example:big
vendor stringSupplierExample:Supplier
name stringShipping shortExample:1032-F2
order_id stringOrder numberExample:21056577640603870897253153
shipment_status stringPackage trackingExample:fulfilled
status stringLogistics delivery status, success-shipped; cancelled-cancelled;Example:success
tracking_company stringLogistics company nameExample:fulfilled
tracking_number stringThird party tracking numberExample:yun001
tracking_url stringLogistics company URLExample:https://www.sf-international.com/
updated_at stringUpdate time ( format see ISO 8601 )Example:2022-11-04T10:18:46+00:00
- id stringSystem order numberExample:
21050224312121887324667162
line_itemsobject[]
Order product snapshot informationattribute stringProduct attributes: name - attribute value. Multiple separated by comma ", ". For example: color - red, size - XExample:red
discount_allocationsobject[]
Marketing discount detail amount multi-currencyamount stringDiscount detailed amountExample:8.00
amount_setobject
Discount details in multiple currenciespresentment_moneyobject
Payment currencyamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
shop_moneyobject
Store currencyamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
discount_application_index integerIndicate the position in the discount detailsExample:1
dutiesobject[]
Tariff informationcountry_code_of_origin stringCountry code of origin/shipping pointharmonized_system_code stringCustoms codeid stringTariff numberpriceobject
Tariff multi-currency informationpresentment_moneyobject
Buyer side amount informationamount stringAmountExample:8.88
currency_code stringCurrencyExample:USD
shop_moneyobject
Sell side amount informationamount stringAmountExample:8.88
currency_code stringCurrencyExample:USD
tax_linesobject[]
Tax details listprice_setobject
Multi-currency information of taxpresentment_moneyobject
Buyer side amount informationamount stringAmountExample:8.88
currency_code stringCurrencyExample:USD
shop_moneyobject
Sell side amount informationamount stringAmountExample:8.88
currency_code stringCurrencyExample:USD
rate doubleTax raterate_percentage doubleTax rate (percentage value, i.e. rate * 100)title stringTax titlefulfillable_quantity integerAvailable quantityExample:2
fulfillment_service stringLogistics business name , if there are multiple different delivery providers in Product , then use separated by ','Example:Sf international
fulfillment_status stringThe shipping status of the product, shipping status, fulfilled-shipped; partial-partially shipped; null-unshipped;Example:fulfilled
gift_card booleanWei or not for gift cardsExample:true
grams doubleWeight ( grams )Example:100
id stringThe ID of the product snapshot table, generated by the system, uniquely confirms a product with the order numberExample:415
image_url stringproduct pictureExample:https://d2n979dmt31clo.cloudfront.net/image/store/4211449909/1667384795847/63928f08a7174ab2958c6a969
location_id stringLocation IDExample:5327026538935748524
name stringSku titleExample:test-002
price stringProduct selling priceExample:8.00
price_setobject
Product selling price , multi-currency amount informationpresentment_moneyobject
Payment currencyamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
shop_moneyobject
Store currencyamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
product_id stringSPU serial numberExample:16056761559984840457934011
propertiesobject[]
Product customization informationadditional stringCustom Product add-on fieldExample:Attach
name stringCustom attribute nameExample:Attribute name
type stringAttribute 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 FirstExample:text
urls arrayURL resource listExample:https://www.urls.com
value stringCustom attribute valuesExample:Attribute value
quantity integerQuantity of items in the orderExample:2
requires_shipping booleanShipping or notExample:true
sku stringProduct yardsExample:18056761559987524812644011
tags stringProduct tags (multiple commas separated)Example:Tag
tax_linesobject[]
Tax informationprice stringPriceExample:8.00
price_setobject
Multi-currency information of taxpresentment_moneyobject
Buyer side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
shop_moneyobject
Sell side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
rate doubleTax rateExample:1
title stringTax nameExample:Tax
type stringTax fee type, used to distinguish between commodity tax and freight tax. The enumeration value is as follows product_tax: commodity tax shipping_tax: freight taxExample:shipping_tax
taxable booleanTax or not?Example:true
title stringProduct titleExample:Beautiful skirt
variant_id stringProduct SKU serial numberExample:18056761559987524812644011
variant_title stringCommodity attribute value, multiple divided by " / ", such as: "155 / red / large"Example:big
vendor stringSupplierExample:Supplier
locationsobject[]
Location informationlocation_id stringLocation IDExample:5327026538935748524
name stringLocation nameExample:us.street
type stringLocation type .1.posLocation : pos channels create store locations for this order ( it is recommended to use posLocationId and waste later ) 2.pickupLocation : when the delivery method of the order is self-mentioned ,Place 3.productLocation : Product inventory location in order ( recommended use of location information in Product line , follow-up will be abandoned )Example:posLocation
- name stringCustom order number (will change)Example:
test001
- note stringMerchant remark content, multiple separated by commasExample:
Notes
note_attributesobject[]
Merchant note log, date contentcreate_time stringNote creation time ( format see ISO 8601 )Example:2022-11-04T10:18:46+00:00
name stringRemark source (seller ID)Example:Source
value stringNotesExample:Content
- order_source stringOrder source channelsExample:
pos
- order_status_url stringOrder status page URLExample:
https://shoptest.myshopline.com/trade/thank_you?mainOrderMark=xxx&mainOrderSeq=200565776406008509
payment_detailsobject[]
Payment slip informationcreate_time stringPayment slip creation timeExample:2021-08-16T08:27:57+00:00
pay_amount doublePayment amountExample:8
pay_channel_deal_id stringPayment serial number: the payment number generated by the payment channelExample:pi_3MI897Hezv8FxjBO1uGxMPhX
pay_seq stringPayment network payment order number, the unique number request number of the payment order defined internally in SLExample:23057287797738260472676128
pay_status stringPayment statusExample:unpaid
- payment_gateway_names arrayPayment method list, payment method list used for this orderExample:
Paypal
- phone stringBuyer contact informationExample:
13100000000
- pos_location_id stringPos deal point idExample:
5327026538935748524
- presentment_currency stringBuy side currencyExample:
USD
- processed_user_id stringOrder creatorExample:
4201057495
refundsobject[]
Refund listcreated_at stringRefund order creation time ( format see ISO 8601 )Example:2022-11-04T10:18:46+00:00
id stringRefund IDExample:2605659027312156877634
note stringRefund NotesExample:Notes
order_id stringOrder numberExample:21056577640603870897253153
processed_at stringUpdate timeExample:2022-11-04T10:18:46+00:00
user_id stringUser IDExample:4201057495
shipping_addressobject
Shipping addressaddress1 stringDetailed address 1Example:Address 1
address2 stringDetailed address 2, optionalExample:Address 2
city stringCityExample:Guangzhou
company stringCompany NameExample:Get together
country stringCountryExample:China
country_code stringCountry codeExample:CHN
first_name stringFirst nameExample:Tom
last_name stringLast nameExample:Washington
latitude stringAddress latitudeExample:23.35773
longitude stringaddress longitudeExample:23.35773
name stringFull nameExample:Tom Washington
phone stringPhoneExample:13100000000
province stringProvinceExample:Guangdong
province_code stringProvince codeExample:420006
zip stringPostal codeExample:521000
shipping_linesobject[]
Logistics informationcode stringLogistics numberExample:SF23344365757
discount_allocationsobject[]
Discount detailsamount stringDiscount amount, precision 2Example:8.00
amount_setobject
Discount multi-currency amountspresentment_moneyobject
Buyer side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
shop_moneyobject
Store side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
discount_application_index integerDiscount index information : marked in the position of the discount detailsdiscounted_price stringDiscount amountdiscounted_price_setobject
Discount multi-currency amountspresentment_moneyobject
Buyer side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
shop_moneyobject
Store side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
phone stringPhoneExample:13100000000
price stringLogistics shippingExample:8.00
price_setobject
Logistics freight multi-resource informationpresentment_moneyobject
Currency amount on buyer’s sideamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
shop_moneyobject
Currency amount on seller sideamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
shipping_price stringOriginal freight amount (non-discount amount)Example:8.00
source stringLogistics typeExample:SHOPLINE
tax_linesobject[]
Tax informationprice stringPriceExample:8.00
price_setobject
Multi-currency information of taxpresentment_moneyobject
Currency amount on seller sideamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
shop_moneyobject
Currency amount on buyer’s sideamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
rate doubleTax rateExample:1
title stringTax nameExample:Tax
title stringLogistics nameExample:Sf international
- store_id stringStore idExample:
1644828244663
- subtotal_price stringProduct discount price totalExample:
8.00
subtotal_price_setobject
Multi-currency information of total product price after discountpresentment_moneyobject
Buyer side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
shop_moneyobject
Sell side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
- tags stringorder labelExample:
Tag
tax_linesobject[]
Tax informationprice stringPriceExample:8.00
price_setobject
Multi-currency amount informationpresentment_moneyobject
Buyer side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
shop_moneyobject
Sell side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
rate doubleTax rateExample:1
title stringTax nameExample:Tax
- tax_number stringTINExample:
1111111
- tax_type stringTypes of tax IDExample:
Type
- taxes_included booleanDoes the total include tax?Example:
true
- total_discounts stringDiscount totalExample:
8.00
total_discounts_setobject
Multi-currency information of discount totalpresentment_moneyobject
Buyer side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
shop_moneyobject
Sell side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
- total_line_items_price stringProduct the original price is combinedExample:
8.00
total_line_items_price_setobject
Total original price of goods, multi-currency informationpresentment_moneyobject
Buyer side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
shop_moneyobject
Sell side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
- total_outstanding stringTotal of not paidExample:
8.00
total_outstanding_setobject
totalOutstandingSetpresentment_moneyobject
Buyer side amount informationamount stringAmountExample:8.88
currency_code stringCurrencyExample:USD
shop_moneyobject
Sell side amount informationamount stringAmountExample:8.88
currency_code stringCurrencyExample:USD
total_shipping_price_setobject
Order shipping sum, multi-currency informationpresentment_moneyobject
Buyer side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
shop_moneyobject
Sell side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
- total_tax stringTax totalExample:
8.00
total_tax_setobject
Total taxes and fees, multi-currency informationpresentment_moneyobject
Buyer side amount informationamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
shop_moneyobject
Amount information on the seller’s sideamount stringAmount, Precision 2Example:8.00
currency_code stringCurrencyExample:USD
- total_tip_received stringTipsExample:
8.00
total_tip_received_setobject
Tips, multi-currency informationpresentment_moneyobject
Buyer side amount informationamount stringAmountExample:8.88
currency_code stringCurrencyExample:USD
shop_moneyobject
Sell side amount informationamount stringAmountExample:8.88
currency_code stringCurrencyExample:USD
- total_weight doubleTotal product weight ( g )Example:
100
- updated_at stringOrder update time , ( format see ISO 8601 )Example:
2021-08-16T08:27:57+00:00
- user_id stringBuyer IDExample:
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?