Menu Close

Get Support From ShopWired Close

All systems fully operational

Subscribe To Updates
Prefer To Live Chat? Chat directly with ShopWired support Quickest response time
Send A Message
Response within 24 hours

Menu Close

Menu

Product Customisation Fields

This is used to view, create, update and delete product customisation fields.

Product Customisation Field Properties
id { "id" : 255 }
The unique ID of the product customisation field
label { "label" : "Enter your text" }
The field label
type { "type" : 1 }
Either 1 (for text input) or 2 (for text area)

What you can do with product customisation fields

GET /v1/products/ID/customization-fields

Receive a list of all customisation fields


POST /v1/products/ID/customization-fields

Create a new product customisation field


PUT /v1/products/ID/customization-fields/ID

Update a product customisation field


DELETE /v1/products/ID/customization-fields/ID

Delete a product customisation field


GET /v1/products/ID/customization-fields

Returns a list of product customisation fields assigned to a product.

GET /v1/products/1/customization-fields
HTTP/1.1 200 OK
[
	{
		"id": 1,
		"label": "Enter your text",
		"type": 1
	}
]
        

POST /v1/products/ID/customization-fields

Creates a new product customisation field.

POST /v1/products/1/customization-fields
POST /v1/products/1/customization-fields
{
	"label": "Enter your text",
	"type": 1
}
        
POST /v1/products/1/customization-fields
HTTP/1.1 201 Created
{
	"id": 1,
	"label": "Enter your text",
	"type": 1
}
        

PUT /v1/products/ID/customization-fields/ID

Update a product customisation field.

PUT /v1/products/1/customization-fields/1
PUT /v1/products/1/customization-fields/1
{
    "label": "Enter your text (no more than 30 characters)"
}
        
PUT /v1/products/ID/extras/ID
HTTP/1.1 200 OK
{
	"id": 1,
	"label": "Enter your text (no more than 30 characters)",
	"type": 1
}
        

DELETE /v1/products/ID/customization-fields/ID

Deletes an existing product customisation field.

Returns 204 No Content on success.