Custom fields

GEThttps://api.sellauth.com/v1/shops/{shopId}/custom-fields

Path parameters

shopId*string

Example: "non"

Response

200

Custom fields retrieved.

Body

application/json

idinteger

Example: 1

shop_idinteger

Example: 1

namestring

Example: "Your Name"

hintnullable string

typestring

Example: "text"

optionsnullable string

is_requiredboolean

Example: true

created_atstring (date-time)

Example: "2024-01-01T00:00:00.000000Z"

updated_atstring (date-time)

Example: "2024-01-01T00:00:00.000000Z"

Request

JavaScriptCurlPython

const response = await fetch('https://api.sellauth.com/v1/shops/{shopId}/custom-fields', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

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"
  }
]

POSThttps://api.sellauth.com/v1/shops/{shopId}/custom-fields

Path parameters

shopId*string

Example: "non"

Body

application/json

name*string

Example: "tempora"

hintstring

Example: "placeat"

type*string

Example: "esse"

optionsstring

Example: "quisquam"

is_requiredboolean

Example: false

Response

200422

Custom field created.

Body

application/json

idinteger

Example: 1

shop_idinteger

Example: 1

namestring

Example: "Your Name"

hintnullable string

typestring

Example: "text"

optionsnullable string

is_requiredboolean

Example: true

created_atstring (date-time)

Example: "2024-01-01T00:00:00.000000Z"

updated_atstring (date-time)

Example: "2024-01-01T00:00:00.000000Z"

Request

JavaScriptCurlPython

const response = await fetch('https://api.sellauth.com/v1/shops/{shopId}/custom-fields', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "tempora",
      "type": "esse"
    }),
});
const data = await response.json();

Response

200422

{
  "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"
}

PUThttps://api.sellauth.com/v1/shops/{shopId}/custom-fields/{customFieldId}

Path parameters

shopId*string

Example: "ex"

customFieldId*string

Example: "consequatur"

Body

application/json

name*string

Example: "est"

hintstring

Example: "sequi"

type*string

Example: "consequatur"

optionsstring

Example: "nihil"

is_requiredboolean

Example: true

Response

200422

Custom field updated.

Body

application/json

idinteger

Example: 1

shop_idinteger

Example: 1

namestring

Example: "Your Name"

hintnullable string

typestring

Example: "text"

optionsnullable string

is_requiredboolean

Example: true

created_atstring (date-time)

Example: "2024-01-01T00:00:00.000000Z"

updated_atstring (date-time)

Example: "2024-01-01T00:00:00.000000Z"

Request

JavaScriptCurlPython

const response = await fetch('https://api.sellauth.com/v1/shops/{shopId}/custom-fields/{customFieldId}', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "name": "est",
      "type": "consequatur"
    }),
});
const data = await response.json();

Response

200422

{
  "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"
}

DELETEhttps://api.sellauth.com/v1/shops/{shopId}/custom-fields/{customFieldId}

Path parameters

shopId*string

Example: "ex"

customFieldId*string

Example: "consequatur"

Response

200

Custom field deleted.

Body

application/json

messagestring

Example: "Custom field deleted successfully"

Request

JavaScriptCurlPython

const response = await fetch('https://api.sellauth.com/v1/shops/{shopId}/custom-fields/{customFieldId}', {
    method: 'DELETE',
    headers: {},
});
const data = await response.json();

Response

200

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