Skip to main content

Create a location

Create a location

Authorizations:Token, JWT
Request Body Schema:
The new Location resource
namestring[1 .. 255] charactersExample: "Sale"
typestring[1 .. 32] charactersEnum: "warehouse""company_address""internal_warehouse""pickup_point"Example: "warehouse"
locationCodestring[1 .. 32] charactersExample: "NY10001"
phoneNumberstring<= 64 charactersExample: "555-867-5309"
emailstring<= 255 charactersExample: "warehouse@example.com"
staffNotesstring<= 255 charactersExample: "Please use the back entrance for all deliveries."

Responses

201Location resource created
Response schema:
Location resource created
namestring[1 .. 255] charactersExample: "Sale"
typestring[1 .. 32] charactersEnum: "warehouse""company_address""internal_warehouse""pickup_point"Example: "warehouse"
locationCodestring[1 .. 32] charactersExample: "NY10001"
phoneNumberstring<= 64 charactersExample: "555-867-5309"
emailstring<= 255 charactersExample: "warehouse@example.com"
staffNotesstring<= 255 charactersExample: "Please use the back entrance for all deliveries."
idinteger or null>= 1
400Invalid input
401Unauthorized
Response schema:
Unauthorized
typestringExample: "https://tools.ietf.org/html/rfc2616#section-10"
titlestringExample: "An error occurred"
detailstring or nullExample: "Cannot find entity"
instancestring or null
422Unprocessable entity
500Internal error
Response schema:
Internal error
typestringExample: "https://tools.ietf.org/html/rfc2616#section-10"
titlestringExample: "An error occurred"
detailstring or nullExample: "Cannot find entity"
instancestring or null