Skip to main content
POST
/
location
/
attribute
Create location attribute
curl --request POST \
  --url https://prod01.oms.fabric.inc/api/v2/location/attribute \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'x-site-context: <x-site-context>' \
  --data '{
  "code": "isBopis",
  "name": "isBopis",
  "description": "To check the status of the BOPIS(Buy-Online-Pickup-In-Store)",
  "type": "BOOLEAN",
  "required": true
}'
{
  "id": "622786ae0bdb19221a24fb61",
  "code": "isBopis",
  "name": "Is Bopis",
  "description": "To check the status of the BOPIS (Buy-Online_Pickup-In-Store)",
  "type": "BOOLEAN",
  "required": true
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

​
x-site-context
string
required

The x-site-context header is a JSON object that contains information about the source you wish to pull from. The mandatory account is the 24 character identifier found in Copilot. The channel (Sales channel ID), stage (environment name), and date attributes can be used to further narrow the scope of your data source.

Example:

"{\"date\": \"2023-01-01T00:00:00.000Z\", \"channel\": 12, \"account\": \"1234abcd5678efgh9ijklmno\",\"stage\":\"production\"}"

Body

application/json
​
code
string

Location attribute code

Example:

"isBopis"

​
name
string

Location attribute name

Example:

"isBopis"

​
description
string

Detailed description of the attribute

Example:

"To check the status of the BOPIS(Buy-Online-Pickup-In-Store)"

​
type
enum<string>

Data type of an attribute

Available options:
BOOLEAN,
INTEGER,
NUMBER,
STRING
​
required
boolean

Flag to define the attribute as mandatory while creating location. If it's configured as true, this attribute is mandatory while creating location.

Example:

true

Response

OK

​
id
string

Location attribute ID that is generated automatically for the location

Example:

"622786ae0bdb19221a24fb61"

​
code
string

Location attribute code

Example:

"isBopis"

​
name
string

Location attribute name

Example:

"Is Bopis"

​
description
string

Detailed description about attribute

Example:

"To check the status of the BOPIS (Buy-Online_Pickup-In-Store)"

​
type
enum<string>

Data type of an attribute

Available options:
BOOLEAN,
INTEGER,
NUMBER,
STRING
​
required
boolean

Flag to define the attribute as mandatory while creating location. If it's configured as true, this attribute is needed while creating location

Example:

true