Sign in

v1

latestOpenAPI 3.1.0MIT2026-07-243952451019.0 KB
Fulfillments::Location

Create Location

Create Location

post/workspaces/{workspace_id}/fulfillments/locations

Path parameters

workspace_idinteger required

Request body

Example request

{
  "fulfillments_location": {
    "fulfillments_location": {
      "name": "Example Location",
      "address_name": "Example Address",
      "email_address": "myemail1754939677@example.com",
      "phone_number": "(123)-555-4567",
      "archived": false
    }
  }
}

Response

Created

idinteger

Location ID

public_idstring nullable

Public ID

workspace_idinteger

Workspace ID

namestring

Location name

address_namestring

Address name

email_addressstring

Email address

phone_numberstring nullable

Phone number

sort_orderinteger nullable

Sort order

archivedboolean

Indicates if the location is archived

external_appboolean nullable

External app

created_atstring nullable

Added

updated_atstring nullable

Updated

Example response

{
  "id": 2,
  "public_id": "jEvMrK",
  "workspace_id": 42000,
  "name": "Example Location",
  "address_name": "Example Address",
  "email_address": "myemail1754939677@example.com",
  "phone_number": "(123)-555-4567",
  "sort_order": 1,
  "archived": false,
  "external_app": true,
  "created_at": null,
  "updated_at": null,
  "address": {
    "address_one": "3443 W. Bavaria St.",
    "address_two": "Suite 100",
    "city": "Eagle",
    "region": "Idaho",
    "country": "US",
    "postal_code": "83616"
  }
}