Custom fields

get

Path parameters

shopIdstringrequired

Example: non

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --url 'https://api.sellauth.com/v1/shops/{shopId}/custom-fields'

200

200

[
  {
    "id": 1,
    "shop_id": 1,
    "name": "Your Name",
    "hint": null,
    "type": "text",
    "options": null,
    "is_required": true,
    "created_at": "2024-01-01T00:00:00.000000Z",
    "updated_at": "2024-01-01T00:00:00.000000Z"
  }
]

Custom fields retrieved.

post

Path parameters

shopIdstringrequired

Example: non

Body

namestringrequired

Example: tempora

hintstringoptional

Example: placeat

typestringrequired

Example: esse

optionsstringoptional

Example: quisquam

is_requiredbooleanoptional

Example: false

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request POST \
  --url 'https://api.sellauth.com/v1/shops/{shopId}/custom-fields' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "tempora",
    "hint": "placeat",
    "type": "esse",
    "options": "quisquam",
    "is_required": false
  }'

200

422

200

{
  "id": 1,
  "shop_id": 1,
  "name": "Your Name",
  "hint": null,
  "type": "text",
  "options": null,
  "is_required": true,
  "created_at": "2024-01-01T00:00:00.000000Z",
  "updated_at": "2024-01-01T00:00:00.000000Z"
}

Custom field created.

put

Path parameters

shopIdstringrequired

Example: ex

customFieldIdstringrequired

Example: consequatur

Body

namestringrequired

Example: est

hintstringoptional

Example: sequi

typestringrequired

Example: consequatur

optionsstringoptional

Example: nihil

is_requiredbooleanoptional

Example: true

Responses

application/json

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request PUT \
  --url 'https://api.sellauth.com/v1/shops/{shopId}/custom-fields/{customFieldId}' \
  --header 'Content-Type: application/json' \
  --data '{
    "name": "est",
    "hint": "sequi",
    "type": "consequatur",
    "options": "nihil",
    "is_required": true
  }'

200

422

200

{
  "id": 1,
  "shop_id": 1,
  "name": "Your Name",
  "hint": null,
  "type": "text",
  "options": null,
  "is_required": true,
  "created_at": "2024-01-01T00:00:00.000000Z",
  "updated_at": "2024-01-01T00:00:00.000000Z"
}

Custom field updated.

delete

Path parameters

shopIdstringrequired

Example: ex

customFieldIdstringrequired

Example: consequatur

Responses

application/json

cURL

JavaScript

Python

HTTP

cURL

curl -L \
  --request DELETE \
  --url 'https://api.sellauth.com/v1/shops/{shopId}/custom-fields/{customFieldId}'

200

200

{
  "message": "Custom field deleted successfully"
}

Custom field deleted.