Explore

Retrieve all custom fields

GET/store/customfields

Gets information about all custom fields within your store configuration.

Querystring	count	The number of records to return
Querystring	offset	The number of records from a collection to skip

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "total": 9,
  "count": 2,
  "offset": 0,
  "results": [
    {
      "id": "5639aac746fc52088841f4c0",
      "name": "Product Type",
      "dataformat": "text",
      "values": []
    },
    {
      "id": "5639aad946fc52088841f4c1",
      "name": "Sash",
      "dataformat": "dropdown",
      "values": [
        "3 for 2",
        "Buy 1 get 1 Half Price",
        "Clearance",
        "Coming soon",
        "Free gift with purchase",
        "Multibuy offer",
        "Sale",
        "Special offer",
        "Black friday"
      ]
    }
  ]
}

Lookup a specific custom field

GET/store/customfields/{id}

Gets information about a specific custom field within your store configuration.

Parameters

The unique id for the custom field

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "5639aad946fc52088841f4c1",
  "name": "Sash",
  "dataformat": "dropdown",
  "values": [
    "3 for 2",
    "Buy 1 get 1 Half Price",
    "Clearance",
    "Coming soon",
    "Free gift with purchase",
    "Multibuy offer",
    "Sale",
    "Special offer",
    "Black friday"
  ]
}

Create a new custom field

POST/store/customfields

Creates a new custom field within your store configuration.

Request body

Custom Field

Example request

Content-Type: application/json; charset=utf-8

{
  "name": "Gender",
  "dataformat": "dropdown",
  "values": [
    "Male",
    "Female"
  ]
}

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "5aba959b9b04b30944fd11df",
  "name": "Gender",
  "dataformat": "dropdown",
  "values": [
    "Male",
    "Female"
  ]
}

Update a custom field

PUT/store/customfields/{id}

Updates the settings for a specific custom field.

Parameters	id	The unique id for the custom field
Request body	Custom Field

Example request

Content-Type: application/json; charset=utf-8

{
  "name": "Gender",
  "dataformat": "dropdown",
  "values": [
    "Male",
    "Female",
    "Unisex"
  ]
}

Example response

HTTP/1.1 200 OK
Content-Type: application/json; charset=utf-8

{
  "id": "5aba959b9b04b30944fd11df",
  "name": "Gender",
  "dataformat": "dropdown",
  "values": [
    "Male",
    "Female",
    "Unisex"
  ]
}

Delete a custom field

DELETE/store/customfields/{id}

Deletes a custom field from your store configuration.

Parameters

The unique id for the custom field

Example response

HTTP/1.1 204 No Content
Content-Type: application/json; charset=utf-8