Complete draft order

Requires write_draft_orders access scope.
For more info, refer to:
access permission.
PUT https://{handle}.myshopline.com/admin/openapi/v20260301/orders/draft_orders/:id/complete.json
handle : The store's unique identifier, which is the prefix of the store's domain name. For example, if a store's domain name is open001.myshopline.com , the store handle is open001 .
Push draft single into order
Path Parameters
  • id string required
    Draft order number
    Example: 2505751787769346133516
Request Headers
  • Content-Type string required
    The field must be set to the fixed value application/json; charset=utf-8.
  • Authorization string required
    The access token for the API resource. Refer to App authorizationto obtain the access token, and then pass the obtained token in the Bearer format.
    Example:
    Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw
Status Codes
For the complete list of codes and messages, see Http status code.
Response Headers
  • traceId
    A globally unique identifier for the request. It is used to track the request flow throughout the system, allowing for easy location and debugging when issues arise.
Response Body
  • draft_orderobject
    Draft order
  • billing_addressobject
    Billing address information
  • address1 string
    Detailed address information 1 , used as complementary information
    Example: 8899 Garfield Street
  • address2 string
    Detailed address information 2 , used as complementary information
    Example: Apartment 5
  • area string
    Administrative region name
    Example: East town
  • area_code string
    Administrative district encoding , custom number
    Example: 4200006
  • city string
    City name
    Example: Riverside
  • city_code string
    City coding , custom number
    Example: 4200006
  • company string
    Company Name
    Example: SHOPLINE
  • country string
    Country name
    Example: 美国
  • country_code string
    Country or region code , two ISO-3166-1
    Example: US
  • email string
    User mailbox
    Example: test@shoplineapp.com
  • first_name string
    User name
    Example: Tom
  • last_name string
    User last name
    Example: Washington
  • phone string
    Contact number
    Example: 13100000000
  • province string
    State or provincial name
    Example: 加利福尼亚州
  • province_code string
    State or provincial code , custom number
    Example: 4200006
  • same_as_receiver boolean
    Same as receiving information : true、false
    Example: true
  • standard_province_code string
    The code for the province in the billing address, which is a two-digit ISO 3166-2 international code.This differs from province_code - the province_code response field uses a custom code.
  • street_name string
    Street name
    Example: Street
  • street_number string
    Street encoding , custom numbering
    Example: 4200006
  • zip string
    Shipping address postal number
    Example: 92503
  • 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
  • create_at long
    Create time , time stamp format
    Example: 1667638652832
  • currency string
    Store currency
    Example: USD
  • customerobject
    Buyer information
  • area_code string
    Contact area id
    Example: 0000
  • email string
    User mailbox
    Example: xxx@gmail.com
  • first_name string
    User name
    Example: Xiaoliu
  • id string
    User ID
    Example: 2200000611
  • last_name string
    User's last name
    Example: Wang
  • phone string
    User mobile phone number
    Example: 1888888888888
  • discount_amount_ext string
    Order Discount amount , double type string for accuracy 2 , eg : " 12.41 "
    Example: 12.41
  • discount_amount_ext_name string
    Order Discount name
    Example: Order Discount name
  • discount_amount_ext_setobject
    Order Discount amount , 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
  • id string
    Draft order number
    Example: 2505659131831930856670
  • invoice_url string
    Invoice link
    Example: https://xxxxx.myshopline.com/invoices/xxxx?secret=xxxx
  • line_itemsobject[]
    Listing list
  • applied_discountobject
    Product custom discount information
  • amount string
    Discount amount , double type string for accuracy 2 , eg : " 12.41 "
    Example: 1.00
  • amount_setobject
    Discount amount , 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
  • before_amount string
    Product selling price , double type string for precision 2 , eg : " 12.41 "
    Example: 3.00
  • before_amount_setobject
    Zhekou selling price before discount , 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
  • description string
    Discount description
    Example: 满两件减5元
  • title string
    Discount name
    Example: 满减
  • value long
    Discount amount, discount value, when the discount type is DISCOUNT_AMOUNT_PERCENTAGE, the minimum value is 0 and the maximum value is 100 by default
    Example: 1
  • value_type string
    Discount type : fixed_amount ( fixed amount ) 、percentage ( % )
    Example: fixed_amount
  • gift_card boolean
    Wei for gift cards or not : true、false
    Example: true
  • id string
    Product line id , unique confirm a Product line
    Example: 123123
  • image_url string
    picture url
    Example: http://www.abc.com/123
  • price string
    Product amount after participating in custom discounts
    Example: 2.00
  • price_setobject
    Product amount after participating in custom discounts , 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
    Product s pu serial number
    Example: 16056577393789045351043258
  • product_source string
    Product source main_site main station product、customize custom product
    Example: main_site
  • quantity integer
    Product quantity
    Example: 1
  • requires_shipping boolean
    Needs physical transportation and delivery or not : true、false
    Example: true
  • tax_linesobject[]
    Tax information
  • name string
    Tax name
    Example: tax
  • price string
    Tax ( store currency amount ) , accuracy 2
    Example: 8.00
  • price_setobject
    Multi-currency information of tax
  • presentment_moneyobject
    Buy side currency
  • amount string
    Amount
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • shop_moneyobject
    Sell side currency
  • amount string
    Amount
    Example: 8.00
  • currency_code string
    Currency
    Example: USD
  • rate double
    Tax rate
    Example: 1
  • 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
  • title string
    Product title
    Example: Product title
  • variant_id string
    Product SKU serial number
    Example: 18056577393793239655103258
  • variant_title string
    Commercial sku title
    Example: Commercial sku title
  • note string
    Draft order note
    Example: 客户想要尽快发货
  • note_attributesobject[]
    Additional information
  • name string
    Name
    Example: xxxx
  • value string
    Value
    Example: 2
  • order_id string
    Order number generated by current draft order
    Example: 21056577640603870897253153
  • payment_termsobject
    Payment information
  • 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
  • pay_channel_id string
    Payment channel id
    Example: 5341701129888599091
  • pay_status string
    Payment slip status : after not paying for the paid draft order and generating the order , the payment slip state will not synchronize the payment status of the order
    Example: unpaid
  • payment_channel_name string
    Payment channel name
    Example: Custom payment --uploadfile
  • 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
  • po_number string
    Purchase order number recorded on the order in B2B scenarios
  • seller_id string
    Merchant id
    Example: 160123123
  • shipping_addressobject
    Logistics information
  • address1 string
    Detailed address information 1 , used as complementary information
    Example: 8899 Garfield Street
  • address2 string
    Detailed address information 2 , used as complementary information
    Example: Apartment 5
  • city string
    City name
    Example: Riverside
  • city_code string
    City coding , custom number
    Example: 4200006
  • company string
    Company Name
    Example: Company Name
  • country string
    Country name
    Example: 美国
  • country_code string
    Country or region code , two ISO-3166-1
    Example: US
  • delivery_store_code string
    Store code , custom number
    Example: 4200006
  • delivery_store_name string
    Store name
    Example: Store name
  • district string
    Administrative region name
    Example: Administrative region name
  • district_code string
    Administrative district encoding , custom number
    Example: 4200006
  • first_name string
    First name
    Example: Tom
  • last_name string
    Last name
    Example: Washington
  • phone string
    Contact number
    Example: 13100000000
  • province string
    Province
    Example: California
  • province_code string
    Province-coding
    Example: 4200006
  • standard_province_code string
    The code for the province in the shipping address, which is a two-digit ISO 3166-2 international code.This differs from province_code - the province_code response field uses a custom code.
  • street_name string
    Street name
    Example: Street
  • street_number string
    Street encoding , custom numbering
    Example: 4200006
  • zip string
    Shipping address postal number
    Example: 92503
  • shipping_linesobject
    Logistics information
  • delivery_id string
    Shipping method id , shipping template id
    Example: 109012039908
  • express_type_source string
    Logistics type system- system logistics ; custom- custom logistics
    Example: system
  • price string
    Logistics shipping , double type string with accuracy 2
    Example: 12.41
  • price_setobject
    Logistics shipping , 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
  • title string
    Shipping template name
    Example: Shipping template name
  • status string
    Draft order status : open 、 complete
    Example: open
  • stock_reserved boolean
    Order dimension inventory reserve mark : true、flase
    Example: true
  • stock_reserved_time long
    Order dimension inventory pre-reserved time
    Example: 1669280400000
  • subtotal_price string
    Order amount , double type string for accuracy 2 , eg : " 12.41 "
    Example: 12.41
  • tags array
    The draft order tag uses separated by ',' between multiple tag rooms , and the shop dimension supports up to 99 tag
    Example: ["shine,bili"]
  • tax_linesobject[]
    Tax information
  • name string
    Tax name
    Example: TAX
  • price string
    Tax ( store currency amount ) , accuracy 2
    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
  • 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
  • total_discounts string
    Total discount amount , double type string for precision 2 , eg : " 12.41 "
    Example: 12.41
  • total_duties_setobject
    Total duty
  • 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_line_items_price string
    Current draft order Product total amount
    Example: 2.00
  • total_line_items_price_setobject
    Current draft order Product total 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_tax string
    Total tax , double type string for precision 2 , eg : " 12.41 "
    Example: 12.41
  • total_tax_setobject
    Total tax , 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
  • update_at long
    Update time , time stamp format
    Example: 1667638652832
API Explorer
https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301

ParamOptions

— path required
— header required

Language

curl --request PUT \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20260301/orders/draft_orders/id/complete.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'
Was this article helpful to you?
SHOPLINE
SHOPLINE
SHOPLINE Enterprise
Legal
Privacy
Terms
Developer Agreement
LinkedInEmail
LinkedInEmail
© Copyright 2013-2025 SHOPLINE Limited.