Developers have access to the Kickflip API to retrieve designs, orders, quotes and other data. This section will help you understand which parts of Kickflip you can access and how to work with them.

API access

In order to access orders information within Kickflip Rest API, you must generate an API key. The key should be used following JWT specification.

CAUTION
Do not share the API key with anyone outside your organization.

Generating an API key

An API key is a unique identifier used to authenticate requests to the API. Follow the steps below to create your API key:

Log in to your account
Navigate to Settings > API Keys
Click on the + Create key button
Select the required scopes
Click on the Create button
Copy the key
Use the key in the request. The key should be used with the authorization header like this Authorization: Bearer YOUR_API_KEY_HERE

Pagination

We use pagination to allow you to fetch orders or designs. To fetch the first result, do not include or set lastIndex parameter to 0. To fetch the subsequent results, use the lastIndex number from your previous request in the pagination section. You will reach the last result page when the collectionSize is equal to the lastIndex, or when the resultSize is 0.

Orders

[GET] List Orders

Retrieves a list of all orders with pagination. By default, the list is ordered by orderId in descending order.

Permission Scopes

admin

read

orders:read

Endpoint

https://api.mycustomizer.com/v1/orders

Parameters

Headers
Authorization (REQUIRED)	`string`	API access token (JWT). The header should resemble this : Authorization: Bearer <token>
X-TENANT-ID (REQUIRED)	`string`	Your company / brand name.
Query Parameters
limit (OPTIONAL)	`number`	Specifies the maximum number of results to return in a single response. Min: 1 Max: 100 Default: 25
cursor (OPTIONAL)	`number`	Acts as a pointer to the current position in a paginated list. Use the previous response's lastIndex value. Default: 0
sortOrder (OPTIONAL)	`string`	Determines the order of returned results. Possible values: `ascending`, `descending` Default: `descending`
sortKey (OPTIONAL)	`string`	Specifies the field by which to sort the results. Default: `orderId`
filter (OPTIONAL)	`string`	Specifies to filter by `orderId`, `status` or `eCommerceOrderName`
status (OPTIONAL)	`string[]`	Specifies to filter by status Possible values: `pending`, `cancelled`, `inproduction`, `fulfilled`
paymentStatus (OPTIONAL)	`string[]`	Specifies to filter by payment status Possible values: `unpaid`, `paid`, `authorized`, `partially_refunded`, `partially_paid`, `refunded`
stores (OPTIONAL)	`string`	Specifies to filter by store ID
startDate (OPTIONAL)	`string`	Filter orders with startDate after the specified date
endDate (OPTIONAL)	`string`	Filter orders with endDate before the specified date
various (OPTIONAL)	`string[]`	Filter orders by special filters. Possible values: `isTest`

Response

Response object

{
    "pagination": {
        "collectionSize": 2,
        "resultSize": 1,
        "lastIndex": 0,
        "sortOrder": "ascending",
        "sortKey": "orderId"
    },
    "results": [
        {
            "id": "5e69254b714841168b8d9825",
            "currency": "CAD",
            "status": "pending",
            "paymentStatus": "paid",
            "statusHistory": [
                {
                    "status": "pending",
                    "date": "2019-02-23T17:52:35.202Z"
                }
            ],
            "exchangeRateAtCreation": 0.7276461903834083,
            "transactionFeePercentage": 1.9,
            "trial": false,
            "eCommerceOrderId": "1014154653754",
            "eCommerceOrderName": "#1001",
            "store": "5e55926a61f7b78c20f298f6",
            "items": [
                {
                    "quantity": 1,
                    "design": "5e692525714841158b8d9825"
                }
            ],
            "totalPrice": 234,
            "date": "2019-02-11T17:52:11.776Z",
            "orderId": 2
        }
    ]
}

[GET] Get Order

Retrieve a single order by ID

Permission Scopes

admin

read

orders:read

Endpoint

https://api.mycustomizer.com/v1/orders/{id}

Parameters

Path Parameters
id (REQUIRED)	`string`	The requested order id.
Headers
Authorization (REQUIRED)	`string`	API access token (JWT). The header should resemble this : Authorization: Bearer <token>
X-TENANT-ID (REQUIRED)	`string`	Your company / brand name.

Response

Response object

{
    "id": "5e69254b714841168b8d9825",
    "currency": "CAD",
    "status": "pending",
    "paymentStatus": "paid",
    "statusHistory": [
        {
            "status": "pending",
            "date": "2019-02-23T17:52:35.202Z"
        }
    ],
    "exchangeRateAtCreation": 0.7276461903834083,
    "transactionFeePercentage": 1.9,
    "trial": false,
    "eCommerceOrderId": "1014154653754",
    "eCommerceOrderName": "#1001",
    "store": "5e55926a61f7b78c20f298f6",
    "items": [
        {
            "quantity": 1,
            "design": "5e692525714841158b8d9825"
        }
    ],
    "totalPrice": 234,
    "date": "2019-02-11T17:52:11.776Z",
    "orderId": 2
}

Designs

[GET] List Designs

Retrieves a list of all designs with pagination. By default, the list is ordered by designId in descending order.

Permission Scopes

admin

read

designs:read

Endpoint

https://api.mycustomizer.com/v1/designs

Parameters

Headers
Authentication (REQUIRED)	`string`	API access token (JWT). The header should resemble this : Authorization: Bearer <token>
X-TENANT-ID (REQUIRED)	`string`	Your company / brand name.
Query Parameters
limit (OPTIONAL)	`number`	Specifies the maximum number of results to return in a single response. Min: 1 Max: 100 Default: 25
cursor (OPTIONAL)	`number`	Acts as a pointer to the current position in a paginated list. Use the previous response's lastIndex value. Default: 0
sortOrder (OPTIONAL)	`string`	Determines the order of returned results. Possible values: `ascending`, `descending` Default: `descending`
sortKey (OPTIONAL)	`string`	Specifies the field by which to sort the results. Default: `designId`
filter (OPTIONAL)	`string`	Specifies to filter by `designId` or `productName`
products (OPTIONAL)	`string[]`	Specifies to filter by product IDs
startDate (OPTIONAL)	`string`	Filter designs with startDate after the specified date
endDate (OPTIONAL)	`string`	Filter designs with endDate before the specified date

Response

Response object

{
  "pagination": {
    "collectionSize": 2,
    "resultSize": 1,
    "lastIndex": 1,
    "sortOrder": "descending",
    "sortKey": "designId"
  },
  "results": [
    {
      "productionData": [
        {
          "key": "Body material",
          "value": "Bright Red",
          "ref": {
            "optionId": "OPTION-3yvzws",
            "choiceId": "CHOICE-3z0yrg"
          }
        },
        {
          "key": "Pickguard material",
          "value": "White",
          "ref": {
            "optionId": "OPTION-3yy27g",
            "choiceId": "CHOICE-3zjli5"
          }
        },
        {
          "key": "Controls material",
          "value": "Black",
          "ref": {
            "optionId": "OPTION-3z1sy4",
            "choiceId": "CHOICE-3gkyxt"
          }
        },
        {
          "key": "Pickups material",
          "value": "White",
          "ref": {
            "optionId": "OPTION-3z59m4",
            "choiceId": "CHOICE-3z4m5p"
          }
        },
        {
          "key": "Logo logo",
          "value": "https://cdn1.mczr.co/companyname/5ba28ac92f99bd001016621c.png",
          "ref": {
            "optionId": "OPTION-3zepsg",
            "choiceId": "CHOICE-670j8j"
          }
        },
        {
          "key": "Sticker image",
          "value": "Red heart",
          "ref": {
            "optionId": "OPTION-2rhdgx",
            "choiceId": "CHOICE-2rkgpd"
          }
        },
        {
          "key": "Name font",
          "value": "Bodoni",
          "ref": {
            "optionId": "OPTION-1xxzli",
            "choiceId": "CHOICE-1xniva"
          }
        },
        {
          "key": "Name color",
          "value": "Red",
          "ref": {
            "optionId": "OPTION-1xyd12",
            "choiceId": "CHOICE-1xsnli"
          }
        }
      ],
      "summary": [
        {
          "key": "Body",
          "value": "Bright Red"
        },
        {
          "key": "Pickguard",
          "value": "White"
        },
        {
          "key": "Controls",
          "value": "Black"
        },
        {
          "key": "Pickups",
          "value": "White"
        },
        {
          "key": "Your name"
        },
        {
          "key": "Sticker",
          "value": "Red heart"
        }
      ],
      "designImages": [
        {
          "id": "5e74283608310f001714de62",
          "originalFilename": "topnotchdesignname-1.png",
          "size": 586761,
          "date": "2020-03-20T02:19:34.739Z",
          "filename": "5e74283608310f001714de62.png",
          "url": "https://cdnv2.mycustomizer.com/companyname/5e74283608310f001714de62.png"
        }
      ],
      "id": "5e74283608310f001714de63",
      "price": 123,
      "configuration": {
        "OPTION-3yt018": "CHOICE-3ytdoc",
        "OPTION-3yvwjw": "CHOICE-3ywa70",
        "OPTION-3yvzws": "CHOICE-3z0yrg",
        "OPTION-3yxyuk": "CHOICE-3z0drw",
        "OPTION-3yy27g": "CHOICE-3zjli5",
        "OPTION-3z1pl8": "CHOICE-3z2db0",
        "OPTION-3z1sy4": "CHOICE-3gkyxt",
        "OPTION-3z5698": "CHOICE-3ycmbg",
        "OPTION-3z59m4": "CHOICE-3z4m5p",
        "OPTION-3zemfk": "CHOICE-3zeccw",
        "OPTION-3zepsg": {
          "id": "CHOICE-670j8j",
          "name": "Custom logo",
          "code": "",
          "description": "",
          "thumbnail": null,
          "type": "logo",
          "views": [
            {
              "type": "logo",
              "logo": {
                "id": "5ba28ac92f99bd001016621c",
                "originalFilename": "yourlogo.png",
                "size": 9539,
                "date": "2018-09-19T17:43:37.742Z",
                "filename": "5ba28ac92f99bd001016621c.png",
                "url": "https://cdn1.mczr.co/companyname/5ba28ac92f99bd001016621c.png",
                "id": "5ba28ac92f99bd001016621c"
              }
            }
          ]
        },
        "OPTION-3zet5c": "CHOICE-3zej2o",
        "OPTION-3zewi8": "CHOICE-3zefps",
        "OPTION-2rhdgx": "CHOICE-2rkgpd",
        "OPTION-1xxzli": "CHOICE-1xniva",
        "OPTION-1xy2ye": "CHOICE-1xhsdy",
        "OPTION-1xy6ba": {
          "id": "CHOICE-1xxsvq",
          "type": "text",
          "name": "Default text",
          "views": [
            {
              "type": "text",
              "text": "Your text"
            }
          ]
        },
        "OPTION-1xy9o6": "CHOICE-1xxw8m",
        "OPTION-1xyd12": "CHOICE-1xsnli",
        "OPTION-1yhniv": "CHOICE-1yiedz",
        "OPTION-3fwg80": "CHOICE-3fx734"
      },
      "productId": "5e2a0142c56085001093615b",
      "productName": "Custom Guitar",
      "customizerProductId": "5e2a0142c56085001093615a",
      "designImage": {
        "id": "5e74283608310f001714de62",
        "originalFilename": "topnotchdesignname-1.png",
        "size": 586761,
        "date": "2020-03-20T02:19:34.739Z",
        "filename": "5e74283608310f001714de62.png",
        "url": "https://cdnv2.mycustomizer.com/companyname/5e74283608310f001714de62.png",
      },
      "store": "5e2a0143db252ec325e011f2",
      "createdAt": "2020-03-20T02:19:34.964Z",
      "updatedAt": "2020-03-20T02:19:34.964Z",
      "designId": 2,
    }
  ]
}

[GET] Get Design

Retrieve a single design by ID

*designImages will be populated once you manually open a design in the Kickflip dashboard and click the Download assets button. We are working on generating these in the back-end:

Permission Scopes

admin

read

designs:read

Endpoint

https://api.mycustomizer.com/v1/designs/{id}

Parameters

Path Parameters
id (REQUIRED)	`string`	The requested design id.
Headers
Authorization (REQUIRED)	`string`	API access token (JWT). The header should resemble this : Authorization: Bearer <token>
X-TENANT-ID (REQUIRED)	`string`	Your company / brand name.

Response

Response object

{
      "productionData": [
        {
          "key": "Body material",
          "value": "Bright Red",
          "ref": {
            "optionId": "OPTION-3yvzws",
            "choiceId": "CHOICE-3z0yrg"
          }
        },
        {
          "key": "Pickguard material",
          "value": "White",
          "ref": {
            "optionId": "OPTION-3yy27g",
            "choiceId": "CHOICE-3zjli5"
          }
        },
        {
          "key": "Controls material",
          "value": "Black",
          "ref": {
            "optionId": "OPTION-3z1sy4",
            "choiceId": "CHOICE-3gkyxt"
          }
        },
        {
          "key": "Pickups material",
          "value": "White",
          "ref": {
            "optionId": "OPTION-3z59m4",
            "choiceId": "CHOICE-3z4m5p"
          }
        },
        {
          "key": "Logo logo",
          "value": "https://cdn1.mczr.co/companyname/5ba28ac92f99bd001016621c.png",
          "ref": {
            "optionId": "OPTION-3zepsg",
            "choiceId": "CHOICE-670j8j"
          }
        },
        {
          "key": "Sticker image",
          "value": "Red heart",
          "ref": {
            "optionId": "OPTION-2rhdgx",
            "choiceId": "CHOICE-2rkgpd"
          }
        },
        {
          "key": "Name font",
          "value": "Bodoni",
          "ref": {
            "optionId": "OPTION-1xxzli",
            "choiceId": "CHOICE-1xniva"
          }
        },
        {
          "key": "Name color",
          "value": "Red",
          "ref": {
            "optionId": "OPTION-1xyd12",
            "choiceId": "CHOICE-1xsnli"
          }
        }
      ],
      "summary": [
        {
          "key": "Body",
          "value": "Bright Red"
        },
        {
          "key": "Pickguard",
          "value": "White"
        },
        {
          "key": "Controls",
          "value": "Black"
        },
        {
          "key": "Pickups",
          "value": "White"
        },
        {
          "key": "Your name"
        },
        {
          "key": "Sticker",
          "value": "Red heart"
        }
      ],
      "designImages": [
        {
          "id": "5e74283608310f001714de62",
          "originalFilename": "topnotchdesignname-1.png",
          "size": 586761,
          "date": "2020-03-20T02:19:34.739Z",
          "filename": "5e74283608310f001714de62.png",
          "url": "https://cdnv2.mycustomizer.com/companyname/5e74283608310f001714de62.png"
        }
      ],
      "id": "5e74283608310f001714de63",
      "price": 123,
      "configuration": {
        "OPTION-3yt018": "CHOICE-3ytdoc",
        "OPTION-3yvwjw": "CHOICE-3ywa70",
        "OPTION-3yvzws": "CHOICE-3z0yrg",
        "OPTION-3yxyuk": "CHOICE-3z0drw",
        "OPTION-3yy27g": "CHOICE-3zjli5",
        "OPTION-3z1pl8": "CHOICE-3z2db0",
        "OPTION-3z1sy4": "CHOICE-3gkyxt",
        "OPTION-3z5698": "CHOICE-3ycmbg",
        "OPTION-3z59m4": "CHOICE-3z4m5p",
        "OPTION-3zemfk": "CHOICE-3zeccw",
        "OPTION-3zepsg": {
          "id": "CHOICE-670j8j",
          "name": "Custom logo",
          "code": "",
          "description": "",
          "thumbnail": null,
          "type": "logo",
          "views": [
            {
              "type": "logo",
              "logo": {
                "id": "5ba28ac92f99bd001016621c",
                "originalFilename": "yourlogo.png",
                "size": 9539,
                "date": "2018-09-19T17:43:37.742Z",
                "filename": "5ba28ac92f99bd001016621c.png",
                "url": "https://cdn1.mczr.co/companyname/5ba28ac92f99bd001016621c.png",
              }
            }
          ]
        },
        "OPTION-3zet5c": "CHOICE-3zej2o",
        "OPTION-3zewi8": "CHOICE-3zefps",
        "OPTION-2rhdgx": "CHOICE-2rkgpd",
        "OPTION-1xxzli": "CHOICE-1xniva",
        "OPTION-1xy2ye": "CHOICE-1xhsdy",
        "OPTION-1xy6ba": {
          "id": "CHOICE-1xxsvq",
          "type": "text",
          "name": "Default text",
          "views": [
            {
              "type": "text",
              "text": "Your text"
            }
          ]
        },
        "OPTION-1xy9o6": "CHOICE-1xxw8m",
        "OPTION-1xyd12": "CHOICE-1xsnli",
        "OPTION-1yhniv": "CHOICE-1yiedz",
        "OPTION-3fwg80": "CHOICE-3fx734"
      },
      "productId": "5e2a0142c56085001093615b",
      "productName": "Custom Guitar",
      "customizerProductId": "5e2a0142c56085001093615a",
      "designImage": {
        "id": "5e74283608310f001714de62",
        "originalFilename": "topnotchdesignname-1.png",
        "size": 586761,
        "date": "2020-03-20T02:19:34.739Z",
        "filename": "5e74283608310f001714de62.png",
        "url": "https://cdnv2.Kickflip.com/companyname/5e74283608310f001714de62.png",
      },
      "store": "5e2a0143db252ec325e011f2",
      "createdAt": "2020-03-20T02:19:34.964Z",
      "updatedAt": "2020-03-20T02:19:34.964Z",
      "designId": 2,
    }

Quotes

[GET] List Quotes

Retrieves a list of all orders with pagination. By default, the list is ordered by orderId in descending order.

Permission Scopes

Full read and write access

admin

read

quotes:read

Endpoint

https://api.mycustomizer.com/v1/quotes

Parameters

Headers
Authorization (REQUIRED)	`string`	API access token (JWT). The header should resemble this : Authorization: Bearer <token>
X-TENANT-ID (REQUIRED)	`string`	Your company / brand name.
Query Parameters
limit (OPTIONAL)	`number`	Specifies the maximum number of results to return in a single response. Min: 1 Max: 100 Default: 25
cursor (OPTIONAL)	`number`	Acts as a pointer to the current position in a paginated list. Use the previous response's lastIndex value. Default: 0
sortOrder (OPTIONAL)	`string`	Determines the order of returned results. Possible values: `ascending`, `descending` Default: `descending`
sortKey (OPTIONAL)	`string`	Specifies the field by which to sort the results.
filter (OPTIONAL)	`string`	Specifies to filter by quote ID or customer email
status (OPTIONAL)	`string[]`	Specifies to filter by status. Possible values: `accepted`, `open`, `draft`, `canceled`
stores (OPTIONAL)	`string`	Specifies to filter by store ID
startDate (OPTIONAL)	`string`	Filter quotes with startDate after the specified date
endDate (OPTIONAL)	`string`	Filter quotes with endDate before the specified date
expirationStartDate (OPTIONAL)	`string`	Filter quotes with expirationStartDate after the specified date
expirationEndDate (OPTIONAL)	`string`	Filter quotes with expirationEndDate before the specified date

Response

Response object

{
    "pagination": {
        "collectionSize": 2,
        "resultSize": 1,
        "lastIndex": 0,
        "sortOrder": "ascending",
        "sortKey": "orderId"
    },
    "results": [
        
        {
            "quoteId": "1-1",
            "status": "draft",
            "statusHistory": [
                {
                    "status": "draft",
                    "date": "2025-07-25T17:28:57.058Z",
                    "id": null
                }
            ],
            "customer": {
                "email": "email@example.com",
                "createdAt": "2025-07-25T17:28:56.701Z",
                "customProperties": {},
                "name": "Customer name",
                "updatedAt": "2025-07-25T17:35:50.762Z",
                "id": "6883bed8390305d6bc2e7e78"
            },
            "currency": "CAD",
            "items": [
                {
                    "design": "9723bed8390305d6bc2e7e78",
                    "startingPoint": "1233bed8390305d6bc2e7e78",
                    "quantity": 1
                }
            ],
            "store": {
                "name": "vinny",
                "currency": "CAD",
                "eCommerce": "custom-store",
                "status": "installed",
                "statusHistory": [
                    {
                        "status": "installed",
                        "date": "2025-07-25T17:28:45.146Z"
                    }
                ],
                "domain": "a.com",
                "productsData": {},
                "createdAt": "2025-07-25T17:28:45.143Z",
                "updatedAt": "2025-07-25T17:28:45.147Z",
                "id": "6883becd5c7df273d925b017"
            },
            "expireOn": "2025-08-25T17:28:57.053Z",
            "quoteFrom": {
                "isRevision": false,
                "quote": null,
                "id": "6883bed95c7df273d925b071"
            },
            "formResult": {
                "name": "Customer name",
                "email": "email@example.com",
                "message": "A message"
            },
            "totalPrice": 0,
            "taxes": 0,
            "applyTaxes": false,
            "free": true,
            "createdAt": "2025-07-25T17:28:57.055Z",
            "updatedAt": "2025-07-25T17:28:57.059Z",
            "id": "6883bed95c7df273d925b070"
        }
    ]
}

[GET] Get Quote

Retrieve a single quote by ID

Permission Scopes

admin

read

quotes:read

Endpoint

https://api.mycustomizer.com/v1/quotes/{id}

Parameters

Path Parameters
id (REQUIRED)	`string`	The requested order id.
Headers
Authorization (REQUIRED)	`string`	API access token (JWT). The header should resemble this : Authorization: Bearer <token>
X-TENANT-ID (REQUIRED)	`string`	Your company / brand name.

Response

Response object

{
    "quoteId": "1-1",
    "status": "draft",
    "statusHistory": [
        {
            "status": "draft",
            "date": "2025-07-25T17:28:57.058Z",
            "id": null
        }
    ],
    "customer": {
        "email": "email@example.com",
        "createdAt": "2025-07-25T17:28:56.701Z",
        "customProperties": {},
        "name": "Customer name",
        "updatedAt": "2025-07-25T17:35:50.762Z",
        "id": "6883bed8390305d6bc2e7e78"
    },
    "currency": "CAD",
    "items": [
        {
            "design": {
                "type": "customization",
                "parentDesign": null,
                "productName": "My product",
                "productId": "6883bebd5c7df273d925afb8",
                "customizerProductId": "6883bebd5c7df273d925afb5",
                "summary": [
                    {
                        "key": "Color",
                        "value": "White"
                    }
                ],
                "designImage": {
                    "filename": "name.png",
                    "url": "https://image.png",
                    "size": 35607,
                    "originalFilename": "name.png",
                    "mimetype": "image/png",
                    "date": "2025-07-25T17:28:56.276Z",
                    "id": "6883bed85c7df273d925b055"
                },
                "store": "6883becd5c7df273d925b017",
                "price": 0,
                "configuration": {
                    "QUESTION-1us3at": "ANSWER-1q2fqq"
                },
                "personalisations": {},
                "productionData": [
                    {
                        "key": "Color",
                        "value": "White",
                        "ref": {
                            "questionId": "QUESTION-1us3at",
                            "answerId": "ANSWER-1q2fqq"
                        }
                    }
                ],
                "designImages": [],
                "prints": {},
                "printFilesRequestStatus": "success",
                "printFiles": [],
                "basePrice": 0,
                "basePriceContainsHiddenExtraPrices": false,
                "pricing": {},
                "customExtraPrices": [],
                "createdAt": "2025-07-25T17:28:56.430Z",
                "updatedAt": "2025-07-25T17:28:58.488Z",
                "designId": 1,
                "id": "6883bed85c7df273d925b058"
            },
            "quantity": 1
        }
    ],
    "store": {
        "name": "vinny",
        "currency": "CAD",
        "eCommerce": "custom-store",
        "status": "installed",
        "statusHistory": [
            {
                "status": "installed",
                "date": "2025-07-25T17:28:45.146Z"
            }
        ],
        "domain": "a.com",
        "productsData": {},
        "createdAt": "2025-07-25T17:28:45.143Z",
        "updatedAt": "2025-07-25T17:28:45.147Z",
        "id": "6883becd5c7df273d925b017"
    },
    "expireOn": "2025-08-25T17:28:57.053Z",
    "quoteFrom": {
        "isRevision": false,
        "quote": null,
        "id": "6883bed95c7df273d925b071"
    },
    "formResult": {
        "name": "Customer name",
        "email": "email@example.com",
        "message": "A message"
    },
    "totalPrice": 0,
    "taxes": 0,
    "applyTaxes": false,
    "free": true,
    "createdAt": "2025-07-25T17:28:57.055Z",
    "updatedAt": "2025-07-25T17:28:57.059Z",
    "id": "6883bed95c7df273d925b070"
}

Bad words

[GET] List Bad Words

Retrieve a list of all bad words. This endpoint has no pagination.

Permission Scopes

admin

read

wordfilter:write

wordfilter:read

Endpoint

https://api.mycustomizer.com/v1/wordfilters

Parameters

Headers
Authorization (REQUIRED)	`string`	API access token (JWT). The header should resemble this : Authorization: Bearer <token>
X-TENANT-ID (REQUIRED)	`string`	Your company / brand name.

Response

Response object

{
  isActive: true, 
  words: ["bad-word-1", "bad word 2", "badWord3"] 
}

[POST] Update Bad Words List

Update the bad word list.

Permission Scopes

admin

wordfilter:write

Endpoint

https://api.mycustomizer.com/v1/wordfilters

Parameters

Headers
Authorization (REQUIRED)	`string`	API access token (JWT). The header should resemble this : Authorization: Bearer <token>
X-TENANT-ID (REQUIRED)	`string`	Your company / brand name.
Body
isActive (OPTIONAL)	`boolean`
words (OPTIONAL)	`string[]`	The full list of bad words as an array of strings

Body

Body object

{
  "isActive": true,
  "words": ["word-1", "word-2", "word-3"]
}

Response

Response object

["bad-word-1", "bad word 2", "badWord3"]

Inventory

[GET] Get Default Location

Retrieve the default location that is automatically created for every company account.

Permission Scopes

admin

read

inventory:write

inventory:read

Endpoint

https://api.mycustomizer.com/v1/inventory/locations/default

Parameters

Headers
Authorization (REQUIRED)	`string`	API access token (JWT). The header should resemble this : Authorization: Bearer <token>
X-TENANT-ID (REQUIRED)	`string`	Your company / brand name (`xyz`.gokickflip.com)

Response

Response object

{
  "id": "5e74283608310f001714de62",
  "isDefault": true
}

[GET] Get Inventory Items

Get the inventory items for a specific location. Only items with a SKU will be returned.

Permission Scopes

admin

read

inventory:write

inventory:read

Endpoint

https://api.mycustomizer.com/v1/inventory/locations/{locationId}/items

Parameters

Path Parameters
locationId (REQUIRED)	`string`	The location id
Headers
Authorization (REQUIRED)		API access token (JWT). The header should resemble this : Authorization: Bearer <token>
X-TENANT-ID (REQUIRED)		Your company / brand name.

Response

Response object

[
  { "sku": "ABC", stock: 3, committed: 1 },
  { "sku": "DEF", stock: 10, committed: 0 },
  { "sku": "GHI", stock: 10, committed: 1 }
]

[POST] Update Inventory Items

Update inventory items in bulk. Used to update inventory items stock for a specific location.

Permission Scopes

admin

inventory:write

Endpoint

https://api.mycustomizer.com/v1/inventory/locations/{locationId}/items/bulk

Parameters

Path Parameters
locationId (REQUIRED)	`string`	The location id
Headers
Authorization (REQUIRED)		API access token (JWT). The header should resemble this : Authorization: Bearer <token>
X-TENANT-ID (REQUIRED)		Your company / brand name.
Body
updates (REQUIRED)	`array`
updates.id (OPTIONAL)	`string`	The item id
updates.sku (OPTIONAL)	`string`	The item SKU
updates.stock (REQUIRED)	`number \| null`	The stock value

Body

Each update should provide either the id or the sku. If both are missing, 400 BAD_REQUEST error will be returned.

Body object

{
  "updates": [
    { "sku": "ABC", "stock":  100 },
    { "sku": "DEF", "stock":  200 },
    { "id": "5e74283608310f001714de62", "stock":  100 }
  ]
}

Response

Response object

{}

API access

Generating an API key

Pagination

Orders

[GET] List Orders

Permission Scopes

Endpoint

Parameters

Response

[GET] Get Order

Permission Scopes

Endpoint

Parameters

Response

Designs

[GET] List Designs

Permission Scopes

Endpoint

Parameters

Response

[GET] Get Design

Permission Scopes

Endpoint

Parameters

Response

Quotes

[GET] List Quotes

Permission Scopes

Endpoint

Parameters

Response

[GET] Get Quote

Permission Scopes

Endpoint

Parameters

Response

Bad words

[GET] List Bad Words

Permission Scopes

Endpoint

Parameters

Response

[POST] Update Bad Words List

Permission Scopes

Endpoint

Parameters

Body

Response

Inventory

[GET] Get Default Location

Permission Scopes

Endpoint

Parameters

Response

[GET] Get Inventory Items

Permission Scopes

Endpoint

Parameters

Response

[POST] Update Inventory Items

Permission Scopes

Endpoint

Parameters

Body

Response

Related Articles