Create a Stock Location

Create a Stock Location.

{ "stock_location": { "id": "sloc_51G4ZW853Y6TFXWPG5ENJ81X42", "address_id": "laddr_05B2ZE853Y6FTXWPW85NJ81A44", "name": "Main Warehouse", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "metadata": { "car": "white" }, "address": { "id": "laddr_51G4ZW853Y6TFXWPG5ENJ81X42", "address_1": "35, Jhon Doe Ave", "address_2": "apartment 4432", "company": "Medusa", "city": "Mexico city", "country_code": "MX", "phone": "+1 555 61646", "postal_code": "HD3-1G8", "province": "Sinaloa", "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "metadata": { "car": "white" } }, "sales_channels": { "id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A", "name": "Market", "description": "Multi-vendor market", "is_disabled": false, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z", "metadata": { "car": "white" }, "locations": [ { "id": "scloc_01G8X9A7ESKAJXG2H0E6F1MW7A", "sales_channel_id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A", "location_id": "string", "sales_channel": {}, "created_at": "2019-08-24T14:15:22Z", "updated_at": "2019-08-24T14:15:22Z", "deleted_at": "2019-08-24T14:15:22Z" } ] } } }

Request

Query Params

expand

string

optional

Comma-separated relations that should be expanded in the returned stock location.

fields

string

optional

Comma-separated fields that should be included in the returned stock location.

Body Params application/json

name

string

required

the name of the stock location

address_id

string

optional

the ID of an existing stock location address to associate with the stock location. Only required if address is not provided.

metadata

object

optional

An optional key-value map with additional details

Example:

{"car":"white"}

address

object (Stock Location Address Input)

optional

Represents a Stock Location Address Input

address_1

string

required

Stock location address

Example:

35, Jhon Doe Ave

address_2

string

optional

Stock location address' complement

Example:

apartment 4432

city

string

optional

Stock location address' city

Example:

Mexico city

country_code

string

required

Stock location address' country

Example:

phone

string

optional

Stock location address' phone number

Example:

+1 555 61646

postal_code

string

optional

Stock location address' postal code

Example:

HD3-1G8

province

string

optional

Stock location address' province

Example:

Sinaloa

metadata

object

optional

An optional key-value map with additional details

Example:

{"car":"white"}

Examples

Responses

🟢200OK

application/json

Body

stock_location

object (StockLocationExpandedDTO)

required

Represents a Stock Location

string

required

The stock location's ID

Example:

sloc_51G4ZW853Y6TFXWPG5ENJ81X42

address_id

string

required

Stock location address' ID

Example:

laddr_05B2ZE853Y6FTXWPW85NJ81A44

name

string

required

The name of the stock location

Example:

Main Warehouse

created_at

string <date-time>

required

The date with timezone at which the resource was created.

updated_at

string <date-time>

required

The date with timezone at which the resource was updated.

deleted_at

string <date-time>

optional

The date with timezone at which the resource was deleted.

metadata

object

optional

An optional key-value map with additional details

Example:

{"car":"white"}

address

object

optional

The Address of the Stock Location

sales_channels

object

Sales Channel

optional

A Sales Channel is a method a business offers its products for purchase for the customers. For example, a Webshop can be a sales channel, and a mobile app can be another.

🟠400Client Error or Multiple Errors

🟠401User is not authorized. Must log in first

🟠404Not Found Error

🟠409Invalid State Error

🟠422Invalid Request Error

🔴500Server Error