Modify an existing CarrierService

Requires write_shipping access scope.

For more info , refer to:

[]

access permission

PUT https://{handle}.myshopline.com/admin/openapi/v20250601/carrier_services/:carrier_service_id.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 .

Path Parameters

carrier_service_id string required
[]
Carrier service id
[]
Example: 123456

Request Headers

Content-Type required
[]
The value of this field is fixed to application/json; charset=utf-8
Authorization string required
[]
The access token for the API. Please refer to App authorization to obtain the access token, and then put the obtained access token into the API request header in Bearer Token.
Example:
[]
Bearer eyJhbGciOiJIUzUxMiJ9.eyJhcHBLZXkiOiJmMjM3OWQyMTYyOGMzM2QxMWRiMWZkYjY5N2EzZjdjMjZlNGMwYTA5Iiwic2VsbGVySWQiOiIyMDAwMjM0ODgwIiwic3RvcmVJZCI6IjE2NzIzNjk3Mjk2MDYiLCJ2ZXJzaW9uIjoiVjIiLCJkb21haW4iOiJodHRwczovL3NsLW9wZW4tc2cubXlzaG9wbGluZS5jb20iLCJ0aW1lc3RhbXAiOjE2NzUzMTk0OTI0MzksImlzcyI6Inlzb3VsIiwiZXhwIjoxNzY5OTI3NDkyfQ.UwQzomM2veGCUaOZ0paUxq5dpc7DXuhHYFvsQ_uIAKduzWcb_j2E4q_36El83sp145D4cKbpcE5KCeeIz-JNQw

Request Body

carrier_serviceobject
[]
Carrier service information
active boolean
[]
Does the carrier service activate
[]
Example: true
service_name string
[]
Shipping service name
[]
Example: Shipping Rate Provider

Response

[]

For more information about status codes, see Http status code.

Response Headers

traceId
[]
traceId

Response Body

carrier_serviceobject
[]
Carrier service information
active boolean
[]
Does the carrier service activate
[]
Example: true
callback_url string
[]
Url required to request to calculate the shipping fee , must be the official network URL.
[]
Example: http://shipping.example.com
carrier_service_type string
[]
Use to distinguish api shipping and merchant shipping
[]
Example: Api : application participation configuration shipping ; merchant : merchant background configuration
id string
[]
Id for carrier service
[]
Example: "123456"
name string
[]
Shipping service name
[]
Example: Shipping Rate Provider
service_discovery boolean
[]
Does the merchant be able to send virtual data through Shopline background carrier service to see the example of shipping
[]
Example: true

API Explorer

Debugger

Base URL

https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601

ParamOptions

carrier_service_id — path required

Authorization — header required

Body

Body required

{
  "carrier_service": {
    "active": true,
    "service_name": "Shipping Rate Provider"
  }
}

Language

curl --request PUT \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20250601/carrier_services/carrier_service_id.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

Legal