Fulfillment order create

Event Group	Event Identification
fulfillment_order	fulfillment_order/create

Activity creation of the fulfillment order

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

fulfillment_orderobject

Performance details
assigned_locationobject

Location details assigned
address1 string

Address 1
Example: "Chestnut Street 92"
address2 string

Address 2
Example: "Chestnut Street 92"
city string

City
Example: "Louisville"
country string

Country
Example: "United States"
country_code string

Country code
Example: "US"
location_id string

Address ID
Example: "5327026538935748524"
name string

Name
Example: "Apple API Shipwire"
phone string

Mobile phone
Example: "+1(502)-459-3417"
province string

Province
Example: "Kentucky"
zip string

Postal code
Example: "40202"
assigned_location_id string

Assigned location id
Example: "5327026538935748524"
created_at string

The date and time when the fulfillment order was created. Format: ISO 8601.
delivery_methodobject

Shipping method information for the order
max_delivery_date_time string

Late delivery
Example: "2021-05-26T10:00:00-04:00"
method_type string

Delivery method : local、none、pick_up、retail、shipping
Example: "none"
min_delivery_date_time string

Ship time available
Example: "2021-05-26T10:00:00-04:00"
service_code string

Shipping plan code of the carrier.
shipping_rate_name string

Name of the shipping rate, which is available only when the shipping method is SHIPPING or LOCAL_DELIVERY.
shipping_strategy_name string

The name of the shipping strategy. It has a corresponding value only when the shipping method is SHIPPING or LOCAL_DELIVERY.
destinationobject

Consignee information
address1 string

Address 1
Example: "Chestnut Street 92"
address2 string

Address 2
Example: "Chestnut Street 92"
city string

City
Example: "Louisville"
company string

Company
Example: "Apple inc"
country string

Country
Example: "US"
country_code string

Country code
Example: "US"
delivery_store_code string

Local delivery store id, provided only for local delivery
Example: "A121"
delivery_store_name string

Local delivery store name, provided only for local delivery
Example: "Napo Shop"
email string

Mailbox
Example: "bob.norman@mail.example.com"
first_name string

Name
Example: "Bob"
last_name string

Last name
Example: "Norman"
name string

Name
Example: "Bob Norman"
phone string

Mobile phone
Example: "+1(502)-459-3417"
province string

Province
Example: "Kentucky"
province_code string

The IOS 3166-2 code of state or province
Example: "KY"
zip string

Postal code
Example: "40202"
fulfillment_holdsobject[]

Pause information
reason string

Pause cause
Example: "out of stock"
reason_note string

Pause notes
Example: "customer require"
id string

Performance order id
Example: "4005740193290131085320"
line_itemsobject[]

Product line information
country_code_of_origin string

Country code of origin/shipping point
Example: "US"
fulfillable_quantity string

Available in approximately Product quantities
Example: 1
fulfillment_order_id string

Performance order id
Example: "4005740193290131085320"
harmonized_system_code string

Customs code
Example: "121"
id string

Performance order Product line id
Example: "1039283"
line_item_id string

Product row id
Example: "518995019"
quantity long

Order Product line Product quantity
Example: 1
shop_id string

store ID
Example: "1644828244663"
variant_id string

Product sku
Example: "18055128824718541486811487"
merchant_requestsobject[]

Request shipping information list
kind string

Request type : 1 fulfillment_request 2 cancellation_request
Example: "fulfillment_request"
message string

Notes for the shipping application
Example: "accept"
request_optionsobject

Request parameters
notify_customer boolean

Notify customers whether or not
send_at string

Request time
Example: "2021-05-26T10:00:00-04:00"
order_id string

Order id
Example: "21057401932826316666967110"
request_status string

Performance order request status, including: accepted, cancellation_accepted, cancellation_rejected, cancellation_requested, closed, rejected, submitted, unsubmitted
Example: "submitted"
shop_id string

store ID
Example: "1644828244663"
status string

Map order status , including : open , in_progress , cmos ed , cancelled , incomplete , on_hold , scheduled
Example: "open"
supported_actions array

Operation supported by the appointment order includes : create_fulfillment -- created delivery , move -- moved to a new location , hold -- suspended delivery , release_hold -- ( after pause ) started delivery
Example: ["\"release_hold\""]

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

Legal