Checkouts creation

[]

Event Group	Event Identification
checkouts	checkouts/create

[]

Triggered when the settlement page is created

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

abandoned_checkout_url string
[]
Discard link
applied_discountsobject[]
[]
Discount on other applications on single stage
amount string
[]
Discount amount
application_type string
[]
Discount type : discount code , automatic discount , manual discount ;
target_selection string
[]
all
target_type string
[]
line_item、shipping_line
title string
[]
Event title
value string
[]
Discount value
value_type string
[]
Fixed amount , percentage
billing_addressobject
[]
Billing address information
address1 string
[]
Address 1
address2 string
[]
Address 2
city string
[]
City
country string
[]
Country
country_code string
[]
Country code
first_name string
[]
Last name
last_name string
[]
First name
name string
[]
Full name
phone string
[]
Mobile phone number
province string
[]
Province
province_code string
[]
Province-coding
zip string
[]
Postal code
buyer_accepts_marketing boolean
[]
Subscribe or not
cart_token string
[]
Shopping cart token
closed_at string
[]
Closed time
completed_at string
[]
Finish time
created_at string
[]
Creation time
currency string
[]
Currency
customerobject
[]
Buyer information
addressesobject
[]
Address information
address1 string
[]
Address 1
address2 string
[]
Address 2
city string
[]
City
country string
[]
Country
country_code string
[]
Country code
first_name string
[]
Last name
last_name string
[]
First name
name string
[]
Full name
phone string
[]
Mobile phone number
province string
[]
Province
province_code string
[]
Province-coding
zip string
[]
Postal code
currency string
[]
Full name
email string
[]
Mailbox
first_name string
[]
Last name
id string
[]
Buyer ID
last_name string
[]
First name
phone string
[]
Mobile phone number
discount_codesobject[]
[]
Discount information
amount double
[]
Discount amount
title string
[]
Discount name
type integer
[]
Discount type 1 = indicate price Discount
email string
[]
Mailbox
id string
[]
checkout token
line_itemsobject[]
[]
Product information
applied_discountsobject[]
[]
Discount for Product line level applications ;
amount string
[]
Discount amount
application_type string
[]
Discount type : discount code , automatic discount , manual discount
target_selection string
[]
explicit, ENTITLED
target_type string
[]
line_item
title string
[]
Event title
value string
[]
Discount value
value_type string
[]
Fixed amount , percentage
gift_card boolean
[]
Wei or not for gift cards
grams double
[]
Weight
line_price double
[]
Rows price
presentment_title string
[]
Current Product title
price double
[]
Selling price
product_id string
[]
Product serial number
propertiesobject[]
[]
Product attributes
name string
[]
Attribute name
show boolean
[]
Show or not
urls array
[]
Properties url
[]
Example: ``
value string
[]
Attribute value
quantity integer
[]
Product quantity
requires_shipping boolean
[]
Request shipping or not
sku string
[]
Product code barCode
tax_linesobject[]
[]
Tax information
price double
[]
Tax price
tax_no string
[]
Tax number
title string
[]
Tax name
type string
[]
Express_tax shipping tax , product_tax merchandise tax
taxable boolean
[]
Tax or not？
title string
[]
Headline
user_id string
[]
User ID
variant_id string
[]
Product SKU serial number
variant_price double
[]
Product original price
name string
[]
Name
note string
[]
Notes
note_attributesobject[]
[]
Additional information
name string
[]
Name
value string
[]
Value
phone string
[]
Mobile phone number
phone_area_code string
[]
Cell phone no .
[]
Example: 86
presentment_currency string
[]
Current currency
shipping_addressobject
[]
Shipping address
address1 string
[]
Address 1
address2 string
[]
Address 2
city string
[]
City
country string
[]
Country
country_code string
[]
Country code
first_name string
[]
Last name
last_name string
[]
First name
name string
[]
Full name
phone string
[]
Mobile phone number
province string
[]
Province
province_code string
[]
Province-coding
zip string
[]
Postal code
shipping_linesobject[]
[]
Shipping information
code string
[]
Shipping method name
delivery_name string
[]
Shipping method name
delivery_seq string
[]
Shipping method
logistics_amount double
[]
Shipping amount
phone string
[]
Phone
sub_total_price double
[]
Sub total
taxes_included boolean
[]
Incl . or not
token string
[]
checkout token
total_discount double
[]
Total discount amount
total_duties string
[]
Total duty
total_price double
[]
Total price
total_tax double
[]
Total tax amount
total_weight double
[]
Total weight
update_at string
[]
Update time
user_id string
[]
User ID

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

Legal