Create drop point location

POST

/drop_points/{id}/locations

const url = 'https://example.com/drop_points/example/locations';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: '{"external_id":"example","name":"example","shipping_address":{"street":"example","postal_code":"example","city":"example","region":"example","country":"example","latitude":"Infinity","longitude":"Infinity"},"billing_address":{"street":"example","postal_code":"example","city":"example","region":"example","country":"example","latitude":"Infinity","longitude":"Infinity"},"address":{"street":"example","postal_code":"example","city":"example","region":"example","country":"example","latitude":"Infinity","longitude":"Infinity"},"barcodes":["example"],"opening_hours":{"monday":{"opens_at":"example","closes_at":"example"},"tuesday":{"opens_at":"example","closes_at":"example"},"wednesday":{"opens_at":"example","closes_at":"example"},"thursday":{"opens_at":"example","closes_at":"example"},"friday":{"opens_at":"example","closes_at":"example"},"saturday":{"opens_at":"example","closes_at":"example"},"sunday":{"opens_at":"example","closes_at":"example"}},"opening_hours_notes":"example","settings":{"acceptable_skus":["example"],"unlisted":true},"drop_point_fk":"example","latitude":"Infinity","longitude":"Infinity"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://example.com/drop_points/example/locations \
  --header 'Content-Type: application/json' \
  --data '{ "external_id": "example", "name": "example", "shipping_address": { "street": "example", "postal_code": "example", "city": "example", "region": "example", "country": "example", "latitude": "Infinity", "longitude": "Infinity" }, "billing_address": { "street": "example", "postal_code": "example", "city": "example", "region": "example", "country": "example", "latitude": "Infinity", "longitude": "Infinity" }, "address": { "street": "example", "postal_code": "example", "city": "example", "region": "example", "country": "example", "latitude": "Infinity", "longitude": "Infinity" }, "barcodes": [ "example" ], "opening_hours": { "monday": { "opens_at": "example", "closes_at": "example" }, "tuesday": { "opens_at": "example", "closes_at": "example" }, "wednesday": { "opens_at": "example", "closes_at": "example" }, "thursday": { "opens_at": "example", "closes_at": "example" }, "friday": { "opens_at": "example", "closes_at": "example" }, "saturday": { "opens_at": "example", "closes_at": "example" }, "sunday": { "opens_at": "example", "closes_at": "example" } }, "opening_hours_notes": "example", "settings": { "acceptable_skus": [ "example" ], "unlisted": true }, "drop_point_fk": "example", "latitude": "Infinity", "longitude": "Infinity" }'

Parameters

Path Parameters

required

string

Request Body^required

application/json

object

external_id

Any of:

unknown
null

Any of:

string
null

string

name

required

string

shipping_address

Any of:

object
null

Any of:

object

street

Any of:

unknown
null

Any of:

string
null

string

postal_code

Any of:

unknown
null

Any of:

string
null

string

city

Any of:

unknown
null

Any of:

string
null

string

region

Any of:

unknown
null

Any of:

string
null

string

country

Any of:

unknown
null

Any of:

string
null

string

latitude

Any of:

unknown
null

Any of:

unknown
null

Any of:

number
string

number

longitude

Any of:

unknown
null

Any of:

unknown
null

Any of:

number
string

number

billing_address

Any of:

object
null

Any of:

object

street

Any of:

unknown
null

Any of:

string
null

string

postal_code

Any of:

unknown
null

Any of:

string
null

string

city

Any of:

unknown
null

Any of:

string
null

string

region

Any of:

unknown
null

Any of:

string
null

string

country

Any of:

unknown
null

Any of:

string
null

string

latitude

Any of:

unknown
null

Any of:

unknown
null

Any of:

number
string

number

longitude

Any of:

unknown
null

Any of:

unknown
null

Any of:

number
string

number

address

Any of:

object
null

Any of:

object

street

Any of:

unknown
null

Any of:

string
null

string

postal_code

Any of:

unknown
null

Any of:

string
null

string

city

Any of:

unknown
null

Any of:

string
null

string

region

Any of:

unknown
null

Any of:

string
null

string

country

Any of:

unknown
null

Any of:

string
null

string

latitude

Any of:

unknown
null

Any of:

unknown
null

Any of:

number
string

number

longitude

Any of:

unknown
null

Any of:

unknown
null

Any of:

number
string

number

barcodes

Any of:

unknown
null

Any of:

Array<string>
null

Array<string>

opening_hours

Any of:

object
null

Any of:

object
null

object

monday

Any of:

object
null

Any of:

object
null

object

opens_at

Any of:

unknown
null

Any of:

string
null

string

closes_at

Any of:

unknown
null

Any of:

string
null

string

tuesday

Any of:

object
null

Any of:

object
null

object

opens_at

Any of:

unknown
null

Any of:

string
null

string

closes_at

Any of:

unknown
null

Any of:

string
null

string

wednesday

Any of:

object
null

Any of:

object
null

object

opens_at

Any of:

unknown
null

Any of:

string
null

string

closes_at

Any of:

unknown
null

Any of:

string
null

string

thursday

Any of:

object
null

Any of:

object
null

object

opens_at

Any of:

unknown
null

Any of:

string
null

string

closes_at

Any of:

unknown
null

Any of:

string
null

string

friday

Any of:

object
null

Any of:

object
null

object

opens_at

Any of:

unknown
null

Any of:

string
null

string

closes_at

Any of:

unknown
null

Any of:

string
null

string

saturday

Any of:

object
null

Any of:

object
null

object

opens_at

Any of:

unknown
null

Any of:

string
null

string

closes_at

Any of:

unknown
null

Any of:

string
null

string

sunday

Any of:

object
null

Any of:

object
null

object

opens_at

Any of:

unknown
null

Any of:

string
null

string

closes_at

Any of:

unknown
null

Any of:

string
null

string

opening_hours_notes

Any of:

unknown
null

Any of:

string
null

string

settings

Any of:

object
null

object

acceptable_skus

Any of:

unknown
null

Any of:

Array<string>
null

Array<string>

unlisted

Any of:

unknown
null

Any of:

boolean
null

boolean

drop_point_fk

Any of:

unknown
null

Any of:

string
null

string

latitude

Any of:

unknown
null

Any of:

unknown
null

Any of:

number
string

number

longitude

Any of:

unknown
null

Any of:

unknown
null

Any of:

number
string

number

Responses

201

application/json

object

required

string

drop_point_id

required

Any of:

string
null

string

external_id

required

Any of:

string
null

string

name

required

Any of:

string
null

string

shipping_address

required

object

street

required

Any of:

string
null

string

postal_code

required

Any of:

string
null

string

city

required

Any of:

string
null

string

region

required

Any of:

string
null

string

country

required

Any of:

string
null

string

latitude

required

Any of:

unknown
null

Any of:

number
string

number

longitude

required

Any of:

unknown
null

Any of:

number
string

number

billing_address

required

object

street

required

Any of:

string
null

string

postal_code

required

Any of:

string
null

string

city

required

Any of:

string
null

string

region

required

Any of:

string
null

string

country

required

Any of:

string
null

string

latitude

required

Any of:

unknown
null

Any of:

number
string

number

longitude

required

Any of:

unknown
null

Any of:

number
string

number

opening_hours

required

object

monday

required

Any of:

object
null

object

opens_at

required

Any of:

string
null

string

closes_at

required

Any of:

string
null

string

tuesday

required

Any of:

object
null

object

opens_at

required

Any of:

string
null

string

closes_at

required

Any of:

string
null

string

wednesday

required

Any of:

object
null

object

opens_at

required

Any of:

string
null

string

closes_at

required

Any of:

string
null

string

thursday

required

Any of:

object
null

object

opens_at

required

Any of:

string
null

string

closes_at

required

Any of:

string
null

string

friday

required

Any of:

object
null

object

opens_at

required

Any of:

string
null

string

closes_at

required

Any of:

string
null

string

saturday

required

Any of:

object
null

object

opens_at

required

Any of:

string
null

string

closes_at

required

Any of:

string
null

string

sunday

required

Any of:

object
null

object

opens_at

required

Any of:

string
null

string

closes_at

required

Any of:

string
null

string

opening_hours_notes

required

Any of:

string
null

string

created_at

required

Any of:

string
null

string

updated_at

required

Any of:

string
null

string

deleted_at

required

Any of:

string
null

string

billing_email

required

Any of:

string
null

string

shipping_email

required

Any of:

string
null

string

settings

required

object

acceptable_skus

required

Any of:

Array<string>
null

Array<string>

unlisted

required

When true the location is excluded from the public nearby search (and so from the map), but still resolves by barcode — scanning its QR code on site works as normal.

boolean

review_state

required

Whether this location is publicly visible. Only approved locations appear in the nearby search, resolve by barcode, or accept scans. No owner-facing route can write this field.

string

Allowed values: approved pending rejected

barcodes

required

Array<string>

latitude

required

Any of:

unknown
null

Any of:

number
string

number

longitude

required

Any of:

unknown
null

Any of:

number
string

number

drop_point_fk

required

Any of:

string
null

string

address

required

Deprecated: renamed to shipping_address (with billing_address added).

object

street

required

Any of:

string
null

string

postal_code

required

Any of:

string
null

string

city

required

Any of:

string
null

string

region

required

Any of:

string
null

string

country

required

Any of:

string
null

string

latitude

required

Any of:

unknown
null

Any of:

number
string

number

longitude

required

Any of:

unknown
null

Any of:

number
string

number

Example

{
  "shipping_address": {
    "latitude": "Infinity",
    "longitude": "Infinity"
  },
  "billing_address": {
    "latitude": "Infinity",
    "longitude": "Infinity"
  },
  "review_state": "approved",
  "latitude": "Infinity",
  "longitude": "Infinity",
  "address": {
    "latitude": "Infinity",
    "longitude": "Infinity"
  }
}

Create drop point location

Parameters

Path Parameters

Request Bodyrequired

Responses

201

Example

Request Body^required