Create fulfillment location

Requires write_fulfillment_service access scope.

For more info, refer to:

POST https://{handle}.myshopline.com/admin/openapi/v20261201/fulfillment_service_location/create.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 .

Create location for fulfillment service

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 authorization to obtain the access token, and then pass the obtained token in the Bearer format.
Example:

Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA

Request Body

locationobject required

Location information
address1 string

Detailed address 1
Example: 126 York Street
phone_code string

Phone number international district
Example: 0010
name string required

Location name
Example: Ottawa Store
zip string required

Postal code
Example: A1B 2C3
address2 string

Detailed address 2, optional
Example: Unit 42
city string

City
Example: Ottawa
phone string required

Contact phone number
Example: 18883290139
city_code string

City code
Example: 120100
province string

State / province
Example: Ontario
province_code string

State / provincial encoding
Example: 2400011
country_code string required

Country encoding
Example: CA
country string

Country
Example: Canada

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

locationobject

Location information
address1 string

Detailed address 1
Example: 126 York Street
name string

Location name
Example: Ottawa Store
legacy boolean

Is a location for fulfillment service or not
Example: true
country_code string

National code
Example: CA
phone_code string

Phone number international district
Example: 0010
country string

Country Name
Example: Canada
create_at string

Location created time ( format see IOS8601 )
Example: 2021-08-16T08:27:57+00:00
phone string

Telephone number
Example: 18883290139
city string

City name
Example: Ottawa
is_default boolean

Default location or not
Example: true
update_at string

Location created time ( format see IOS8601 )
Example: 2021-08-16T08:27:57+00:00
zip string

Postal code
Example: A1B 2C3
province_code string

Province code
Example: 2400011
id string

Location id
Example: 5668167071852661850
province string

Province name
Example: Ontario
city_code string

Urban code
Example: 120100
address2 string

Detailed address 2, optional
Example: Unit 42
active boolean

Enable or not
Example: true

API Explorer

Debugger

Base URL

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

ParamOptions

Authorization — header required

Body

Body required

{
  "location": {
    "country": "Canada",
    "country_code": "CA",
    "phone_code": "0010",
    "province": "Ontario",
    "zip": "A1B 2C3",
    "name": "Ottawa Store",
    "phone": "18883290139",
    "province_code": "2400011",
    "address2": "Unit 42",
    "city_code": "120100",
    "city": "Ottawa",
    "address1": "126 York Street"
  }
}

Language

curl --request POST \
     --url https://openapiceshidianpu.myshopline.com/admin/openapi/v20261201/fulfillment_service_location/create.json \
     --header 'Authorization: Bearer eyJhbGciOiJIUzUxMiIsInR5cCI6IkpXVCJ9.eyJhcHBJZCI6MCwiYXBwS2V5IjoiNzU2ZjI1NWE2NjdlZTcwNTk1MzM0ZjVjYzk4NzU5MzBmN2E3NGZjMSIsImV4cCI6MTg3OTQ4MjA3NiwiaXNzIjoieXNvdWwiLCJzZWxsZXJJZCI6IjIwMDAyMzQ4ODAiLCJzdG9yZUlkIjoiMTY3MjM2OTcyOTYwNiIsInRpbWVzdGFtcCI6MTc4NDc4NzY3NjY2MSwidmVyc2lvbiI6IlYyIn0.3ZzbGAH4cLU1QR2VPEvMOQInUDvus-C4amkINSQIPuNVlXsFKj0sAt1c0KnUy9MWUOFV9cHlkf7J90r2y1FzpA' \
     --header 'Content-Type: application/json; charset=utf-8' \
     --header 'accept: application/json'

Was this article helpful to you?

SHOPLINE

Legal