blog

Retrieve a blog post

get/blog/posts/{id}

Retrieves the details of an existing blog post. You need only supply the unique model identifier that was returned upon model creation.

Path Parameters

nametyperequireddescriptionexample
idstringrequiredThe identifier of the blog post to be retrieved.507f191e810c19729de860ea

Responses

200 : Success

{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"meta_title": {
"type": "string"
},
"excerpt": {
"type": "string"
},
"meta_description": {
"type": "string"
},
"content": {
"type": "string"
},
"image": {
"type": "object",
"properties": {
"pico": {
"type": "string"
},
"icon": {
"type": "string"
},
"thumb": {
"type": "string"
},
"small": {
"type": "string"
},
"compact": {
"type": "string"
},
"medium": {
"type": "string"
},
"large": {
"type": "string"
},
"grande": {
"type": "string"
},
"mucho_grande": {
"type": "string"
},
"huge": {
"type": "string"
},
"original": {
"type": "string"
},
"is_featured": {
"type": "boolean"
},
"is_default": {
"type": "boolean"
}
}
},
"slug": {
"type": "string"
},
"is_published": {
"type": "boolean"
},
"created_time": {
"format": "date-time",
"type": "string"
},
"updated_time": {
"format": "date-time",
"type": "string"
},
"tags": {
"type": "string"
}
}
}

Update a blog post

put/blog/posts/{id}

Update an existing blog post.

Path Parameters

nametyperequireddescriptionexample
idstringrequiredThe identifier of the blog post to be updated.507f191e810c19729de860ea

Body Parameters

namerequireddescription
blogpostoptionalThe fields to update

Responses

200 : Success

{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"meta_title": {
"type": "string"
},
"excerpt": {
"type": "string"
},
"meta_description": {
"type": "string"
},
"content": {
"type": "string"
},
"image": {
"type": "object",
"properties": {
"pico": {
"type": "string"
},
"icon": {
"type": "string"
},
"thumb": {
"type": "string"
},
"small": {
"type": "string"
},
"compact": {
"type": "string"
},
"medium": {
"type": "string"
},
"large": {
"type": "string"
},
"grande": {
"type": "string"
},
"mucho_grande": {
"type": "string"
},
"huge": {
"type": "string"
},
"original": {
"type": "string"
},
"is_featured": {
"type": "boolean"
},
"is_default": {
"type": "boolean"
}
}
},
"slug": {
"type": "string"
},
"is_published": {
"type": "boolean"
},
"created_time": {
"format": "date-time",
"type": "string"
},
"updated_time": {
"format": "date-time",
"type": "string"
},
"tags": {
"type": "string"
}
}
}

Delete a blog post

delete/blog/posts/{id}

Permanently deletes a blog post. It cannot be undone

Path Parameters

nametyperequireddescriptionexample
idstringrequiredThe identifier of the blog post to be deleted.507f191e810c19729de860ea

Responses

List all blog posts

get/blog/posts

Returns a list of your blog posts. The blog posts are returned sorted by creation date, with the most recent blog posts appearing first.

Query Parameters

nametyperequireddescriptionexample
limitintegeroptionalA limit on the number of objects to be returned. Limit can range between 1 and 100 items. (default is 10)
starting_afterstringoptionalA cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.53fabc07b7987212a01acffc
ending_beforestringoptionalA cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.54c85cceb79872183cee5f3b

Responses

200 : Success

{
"type": "object",
"properties": {
"limit": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"has_more": {
"type": "boolean",
"readOnly": true
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"meta_title": {
"type": "string"
},
"excerpt": {
"type": "string"
},
"meta_description": {
"type": "string"
},
"content": {
"type": "string"
},
"image": {
"type": "object",
"properties": {
"pico": {
"type": "string"
},
"icon": {
"type": "string"
},
"thumb": {
"type": "string"
},
"small": {
"type": "string"
},
"compact": {
"type": "string"
},
"medium": {
"type": "string"
},
"large": {
"type": "string"
},
"grande": {
"type": "string"
},
"mucho_grande": {
"type": "string"
},
"huge": {
"type": "string"
},
"original": {
"type": "string"
},
"is_featured": {
"type": "boolean"
},
"is_default": {
"type": "boolean"
}
}
},
"slug": {
"type": "string"
},
"is_published": {
"type": "boolean"
},
"created_time": {
"format": "date-time",
"type": "string"
},
"updated_time": {
"format": "date-time",
"type": "string"
},
"tags": {
"type": "string"
}
}
}
}
}
}

Create a blog post

post/blog/posts

Creates a new blog post object.

Body Parameters

namerequireddescription
blogpostoptional

Responses

200 : Success

{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"title": {
"type": "string"
},
"meta_title": {
"type": "string"
},
"excerpt": {
"type": "string"
},
"meta_description": {
"type": "string"
},
"content": {
"type": "string"
},
"image": {
"type": "object",
"properties": {
"pico": {
"type": "string"
},
"icon": {
"type": "string"
},
"thumb": {
"type": "string"
},
"small": {
"type": "string"
},
"compact": {
"type": "string"
},
"medium": {
"type": "string"
},
"large": {
"type": "string"
},
"grande": {
"type": "string"
},
"mucho_grande": {
"type": "string"
},
"huge": {
"type": "string"
},
"original": {
"type": "string"
},
"is_featured": {
"type": "boolean"
},
"is_default": {
"type": "boolean"
}
}
},
"slug": {
"type": "string"
},
"is_published": {
"type": "boolean"
},
"created_time": {
"format": "date-time",
"type": "string"
},
"updated_time": {
"format": "date-time",
"type": "string"
},
"tags": {
"type": "string"
}
}
}

Add blog post hero image

post/blog/posts/{id}/image

Add an image to a blog post hero

Path Parameters

nametyperequireddescriptionexample
idstringrequiredThe identifier of the blog post.507f191e810c19729de860ea

Body Parameters

namerequireddescription
imageoptional

Responses

Remove blog post hero image

delete/blog/posts/{id}/image

Remove the hero image from a blog post

Path Parameters

nametyperequireddescriptionexample
idstringrequiredThe identifier of the blog post.507f191e810c19729de860ea

Responses

categories

Retrieve a category

get/categories/{id}

Retrieves the details of an existing category. You need only supply the unique model identifier that was returned upon model creation.

Path Parameters

nametyperequireddescriptionexample
idstringrequiredThe identifier of the category to be retrieved.507f191e810c19729de860ea

Responses

200 : Success

{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"parent_id": {
"type": "string"
},
"title": {
"type": "string"
},
"meta_title": {
"type": "string"
},
"description": {
"type": "string"
},
"meta_description": {
"type": "string"
},
"image": {
"type": "object",
"properties": {
"pico": {
"type": "string"
},
"icon": {
"type": "string"
},
"thumb": {
"type": "string"
},
"small": {
"type": "string"
},
"compact": {
"type": "string"
},
"medium": {
"type": "string"
},
"large": {
"type": "string"
},
"grande": {
"type": "string"
},
"mucho_grande": {
"type": "string"
},
"huge": {
"type": "string"
},
"original": {
"type": "string"
},
"is_featured": {
"type": "boolean"
},
"is_default": {
"type": "boolean"
}
}
},
"slug": {
"type": "string"
},
"sort_type": {
"enum": [
"Unknown",
"Manual",
"AlphaAsc",
"AlphaDesc",
"CreatedAsc",
"CreatedDesc",
"PriceAsc",
"PriceDesc"
],
"type": "string"
},
"is_published": {
"type": "boolean"
},
"created_time": {
"format": "date-time",
"type": "string"
},
"updated_time": {
"format": "date-time",
"type": "string"
}
}
}

Update a category

put/categories/{id}

Update an existing category.

Path Parameters

nametyperequireddescriptionexample
idstringrequiredThe identifier of the category to be updated.507f191e810c19729de860ea

Body Parameters

namerequireddescription
categoryoptionalThe fields to update

Responses

200 : Success

{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"parent_id": {
"type": "string"
},
"title": {
"type": "string"
},
"meta_title": {
"type": "string"
},
"description": {
"type": "string"
},
"meta_description": {
"type": "string"
},
"image": {
"type": "object",
"properties": {
"pico": {
"type": "string"
},
"icon": {
"type": "string"
},
"thumb": {
"type": "string"
},
"small": {
"type": "string"
},
"compact": {
"type": "string"
},
"medium": {
"type": "string"
},
"large": {
"type": "string"
},
"grande": {
"type": "string"
},
"mucho_grande": {
"type": "string"
},
"huge": {
"type": "string"
},
"original": {
"type": "string"
},
"is_featured": {
"type": "boolean"
},
"is_default": {
"type": "boolean"
}
}
},
"slug": {
"type": "string"
},
"sort_type": {
"enum": [
"Unknown",
"Manual",
"AlphaAsc",
"AlphaDesc",
"CreatedAsc",
"CreatedDesc",
"PriceAsc",
"PriceDesc"
],
"type": "string"
},
"is_published": {
"type": "boolean"
},
"created_time": {
"format": "date-time",
"type": "string"
},
"updated_time": {
"format": "date-time",
"type": "string"
}
}
}

Delete a category

delete/categories/{id}

Permanently deletes a category. It cannot be undone

Path Parameters

nametyperequireddescriptionexample
idstringrequiredThe identifier of the category to be deleted.507f191e810c19729de860ea

Responses

List all categories

get/categories

Returns a list of your categories. The categories are returned sorted by creation date, with the most recent categories appearing first.

Query Parameters

nametyperequireddescriptionexample
limitintegeroptionalA limit on the number of objects to be returned. Limit can range between 1 and 100 items. (default is 10)
starting_afterstringoptionalA cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.53fabc07b7987212a01acffc
ending_beforestringoptionalA cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.54c85cceb79872183cee5f3b

Responses

200 : Success

{
"type": "object",
"properties": {
"limit": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"has_more": {
"type": "boolean",
"readOnly": true
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"parent_id": {
"type": "string"
},
"title": {
"type": "string"
},
"meta_title": {
"type": "string"
},
"description": {
"type": "string"
},
"meta_description": {
"type": "string"
},
"image": {
"type": "object",
"properties": {
"pico": {
"type": "string"
},
"icon": {
"type": "string"
},
"thumb": {
"type": "string"
},
"small": {
"type": "string"
},
"compact": {
"type": "string"
},
"medium": {
"type": "string"
},
"large": {
"type": "string"
},
"grande": {
"type": "string"
},
"mucho_grande": {
"type": "string"
},
"huge": {
"type": "string"
},
"original": {
"type": "string"
},
"is_featured": {
"type": "boolean"
},
"is_default": {
"type": "boolean"
}
}
},
"slug": {
"type": "string"
},
"sort_type": {
"enum": [
"Unknown",
"Manual",
"AlphaAsc",
"AlphaDesc",
"CreatedAsc",
"CreatedDesc",
"PriceAsc",
"PriceDesc"
],
"type": "string"
},
"is_published": {
"type": "boolean"
},
"created_time": {
"format": "date-time",
"type": "string"
},
"updated_time": {
"format": "date-time",
"type": "string"
}
}
}
}
}
}

Create a category

post/categories

Creates a new category object.

Body Parameters

namerequireddescription
categoryoptional

Responses

200 : Success

{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"parent_id": {
"type": "string"
},
"title": {
"type": "string"
},
"meta_title": {
"type": "string"
},
"description": {
"type": "string"
},
"meta_description": {
"type": "string"
},
"image": {
"type": "object",
"properties": {
"pico": {
"type": "string"
},
"icon": {
"type": "string"
},
"thumb": {
"type": "string"
},
"small": {
"type": "string"
},
"compact": {
"type": "string"
},
"medium": {
"type": "string"
},
"large": {
"type": "string"
},
"grande": {
"type": "string"
},
"mucho_grande": {
"type": "string"
},
"huge": {
"type": "string"
},
"original": {
"type": "string"
},
"is_featured": {
"type": "boolean"
},
"is_default": {
"type": "boolean"
}
}
},
"slug": {
"type": "string"
},
"sort_type": {
"enum": [
"Unknown",
"Manual",
"AlphaAsc",
"AlphaDesc",
"CreatedAsc",
"CreatedDesc",
"PriceAsc",
"PriceDesc"
],
"type": "string"
},
"is_published": {
"type": "boolean"
},
"created_time": {
"format": "date-time",
"type": "string"
},
"updated_time": {
"format": "date-time",
"type": "string"
}
}
}

Add category image

post/categories/{id}/image

Add an image to a category

Path Parameters

nametyperequireddescriptionexample
idstringrequiredThe identifier of the category.507f191e810c19729de860ea

Body Parameters

namerequireddescription
imageoptional

Responses

Remove category image

delete/categories/{id}/image

Remove the image from a category

Path Parameters

nametyperequireddescriptionexample
idstringrequiredThe identifier of the category.507f191e810c19729de860ea

Responses

customers

Retrieve a customer

get/customers/{id}

Retrieves the details of an existing customer. You need only supply the unique model identifier that was returned upon model creation.

Path Parameters

nametyperequireddescriptionexample
idstringrequiredThe identifier of the customer to be retrieved.507f191e810c19729de860ea

Responses

200 : Success

{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"created_time": {
"format": "date-time",
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email": {
"type": "string"
},
"accepts_marketing": {
"type": "boolean"
},
"company": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"city": {
"type": "string"
},
"post_code": {
"type": "string"
},
"state_code": {
"type": "string"
},
"country_code": {
"type": "string"
}
}
},
"billing_address": {
"type": "object",
"properties": {
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"city": {
"type": "string"
},
"post_code": {
"type": "string"
},
"state_code": {
"type": "string"
},
"country_code": {
"type": "string"
}
}
}
}
}

Update a customer

put/customers/{id}

Update an existing customer.

Path Parameters

nametyperequireddescriptionexample
idstringrequiredThe identifier of the customer to be updated.507f191e810c19729de860ea

Body Parameters

namerequireddescription
customeroptionalThe fields to update

Responses

200 : Success

{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"created_time": {
"format": "date-time",
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email": {
"type": "string"
},
"accepts_marketing": {
"type": "boolean"
},
"company": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"city": {
"type": "string"
},
"post_code": {
"type": "string"
},
"state_code": {
"type": "string"
},
"country_code": {
"type": "string"
}
}
},
"billing_address": {
"type": "object",
"properties": {
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"city": {
"type": "string"
},
"post_code": {
"type": "string"
},
"state_code": {
"type": "string"
},
"country_code": {
"type": "string"
}
}
}
}
}

Delete a customer

delete/customers/{id}

Permanently deletes a customer. It cannot be undone

Path Parameters

nametyperequireddescriptionexample
idstringrequiredThe identifier of the customer to be deleted.507f191e810c19729de860ea

Responses

List all customers

get/customers

Returns a list of your customers. The customers are returned sorted by creation date, with the most recent customers appearing first.

Query Parameters

nametyperequireddescriptionexample
emailstringoptional
limitintegeroptionalA limit on the number of objects to be returned. Limit can range between 1 and 100 items. (default is 10)
starting_afterstringoptionalA cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.53fabc07b7987212a01acffc
ending_beforestringoptionalA cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.54c85cceb79872183cee5f3b

Responses

200 : Success

{
"type": "object",
"properties": {
"limit": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"has_more": {
"type": "boolean",
"readOnly": true
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"created_time": {
"format": "date-time",
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email": {
"type": "string"
},
"accepts_marketing": {
"type": "boolean"
},
"company": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"city": {
"type": "string"
},
"post_code": {
"type": "string"
},
"state_code": {
"type": "string"
},
"country_code": {
"type": "string"
}
}
},
"billing_address": {
"type": "object",
"properties": {
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"city": {
"type": "string"
},
"post_code": {
"type": "string"
},
"state_code": {
"type": "string"
},
"country_code": {
"type": "string"
}
}
}
}
}
}
}
}

Create a customer

post/customers

Creates a new customer object.

Body Parameters

namerequireddescription
customeroptional

Responses

200 : Success

{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"created_time": {
"format": "date-time",
"type": "string"
},
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email": {
"type": "string"
},
"accepts_marketing": {
"type": "boolean"
},
"company": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"city": {
"type": "string"
},
"post_code": {
"type": "string"
},
"state_code": {
"type": "string"
},
"country_code": {
"type": "string"
}
}
},
"billing_address": {
"type": "object",
"properties": {
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"city": {
"type": "string"
},
"post_code": {
"type": "string"
},
"state_code": {
"type": "string"
},
"country_code": {
"type": "string"
}
}
}
}
}

discounts

Retrieve a discount

get/discounts/{id}

Retrieves the details of an existing discount. You need only supply the unique model identifier that was returned upon model creation.

Path Parameters

nametyperequireddescriptionexample
idstringrequiredThe identifier of the discount to be retrieved.507f191e810c19729de860ea

Responses

200 : Success

{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"code": {
"type": "string"
},
"short_url": {
"type": "string"
},
"type": {
"enum": [
"Product",
"Category",
"Order",
"Invalid"
],
"type": "string"
},
"target_id": {
"type": "string"
},
"minimum_value": {
"format": "double",
"type": "number"
},
"free_shipping": {
"type": "boolean"
},
"value_off": {
"format": "double",
"type": "number"
},
"percent_off": {
"format": "int32",
"type": "integer"
},
"currency_code": {
"type": "string"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"valid_from": {
"format": "date-time",
"type": "string"
},
"valid_to": {
"format": "date-time",
"type": "string"
},
"is_published": {
"type": "boolean"
},
"created_time": {
"format": "date-time",
"type": "string"
},
"updated_time": {
"format": "date-time",
"type": "string"
}
}
}

Update a discount

put/discounts/{id}

Update an existing discount.

Path Parameters

nametyperequireddescriptionexample
idstringrequiredThe identifier of the discount to be updated.507f191e810c19729de860ea

Body Parameters

namerequireddescription
discountoptionalThe fields to update

Responses

200 : Success

{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"code": {
"type": "string"
},
"short_url": {
"type": "string"
},
"type": {
"enum": [
"Product",
"Category",
"Order",
"Invalid"
],
"type": "string"
},
"target_id": {
"type": "string"
},
"minimum_value": {
"format": "double",
"type": "number"
},
"free_shipping": {
"type": "boolean"
},
"value_off": {
"format": "double",
"type": "number"
},
"percent_off": {
"format": "int32",
"type": "integer"
},
"currency_code": {
"type": "string"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"valid_from": {
"format": "date-time",
"type": "string"
},
"valid_to": {
"format": "date-time",
"type": "string"
},
"is_published": {
"type": "boolean"
},
"created_time": {
"format": "date-time",
"type": "string"
},
"updated_time": {
"format": "date-time",
"type": "string"
}
}
}

Delete a discount

delete/discounts/{id}

Permanently deletes a discount. It cannot be undone

Path Parameters

nametyperequireddescriptionexample
idstringrequiredThe identifier of the discount to be deleted.507f191e810c19729de860ea

Responses

List all discounts

get/discounts

Returns a list of your discounts. The discounts are returned sorted by creation date, with the most recent discounts appearing first.

Query Parameters

nametyperequireddescriptionexample
discount_codestringoptional
limitintegeroptionalA limit on the number of objects to be returned. Limit can range between 1 and 100 items. (default is 10)
starting_afterstringoptionalA cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.53fabc07b7987212a01acffc
ending_beforestringoptionalA cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.54c85cceb79872183cee5f3b

Responses

200 : Success

{
"type": "object",
"properties": {
"limit": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"has_more": {
"type": "boolean",
"readOnly": true
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"code": {
"type": "string"
},
"short_url": {
"type": "string"
},
"type": {
"enum": [
"Product",
"Category",
"Order",
"Invalid"
],
"type": "string"
},
"target_id": {
"type": "string"
},
"minimum_value": {
"format": "double",
"type": "number"
},
"free_shipping": {
"type": "boolean"
},
"value_off": {
"format": "double",
"type": "number"
},
"percent_off": {
"format": "int32",
"type": "integer"
},
"currency_code": {
"type": "string"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"valid_from": {
"format": "date-time",
"type": "string"
},
"valid_to": {
"format": "date-time",
"type": "string"
},
"is_published": {
"type": "boolean"
},
"created_time": {
"format": "date-time",
"type": "string"
},
"updated_time": {
"format": "date-time",
"type": "string"
}
}
}
}
}
}

Create a discount

post/discounts

Creates a new discount object.

Body Parameters

namerequireddescription
discountoptional

Responses

200 : Success

{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"code": {
"type": "string"
},
"short_url": {
"type": "string"
},
"type": {
"enum": [
"Product",
"Category",
"Order",
"Invalid"
],
"type": "string"
},
"target_id": {
"type": "string"
},
"minimum_value": {
"format": "double",
"type": "number"
},
"free_shipping": {
"type": "boolean"
},
"value_off": {
"format": "double",
"type": "number"
},
"percent_off": {
"format": "int32",
"type": "integer"
},
"currency_code": {
"type": "string"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"valid_from": {
"format": "date-time",
"type": "string"
},
"valid_to": {
"format": "date-time",
"type": "string"
},
"is_published": {
"type": "boolean"
},
"created_time": {
"format": "date-time",
"type": "string"
},
"updated_time": {
"format": "date-time",
"type": "string"
}
}
}

orders

Retrieve an Order

get/orders/{id}

Retrieves the details of an existing Order. You need only supply the unique model identifier that was returned upon model creation.

Path Parameters

nametyperequireddescriptionexample
idstringrequiredThe identifier of the Order to be retrieved.507f191e810c19729de860ea

Responses

200 : Success

{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"reference_id": {
"type": "string"
},
"customer": {
"type": "object",
"properties": {
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email": {
"type": "string"
},
"accepts_marketing": {
"type": "boolean"
},
"company": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"city": {
"type": "string"
},
"post_code": {
"type": "string"
},
"state_code": {
"type": "string"
},
"country_code": {
"type": "string"
}
}
},
"billing_address": {
"type": "object",
"properties": {
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"city": {
"type": "string"
},
"post_code": {
"type": "string"
},
"state_code": {
"type": "string"
},
"country_code": {
"type": "string"
}
}
}
}
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"product_id": {
"type": "string"
},
"product_title": {
"type": "string"
},
"product_sku": {
"type": "string"
},
"product_variant_id": {
"type": "string"
},
"product_variant_title": {
"type": "string"
},
"product_variant_sku": {
"type": "string"
},
"discount_code": {
"type": "string"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"unit_price": {
"format": "double",
"type": "number"
},
"currency": {
"type": "string"
}
}
}
},
"currency": {
"type": "string"
},
"total_price": {
"format": "double",
"type": "number"
},
"total_shipping": {
"format": "double",
"type": "number"
},
"total_tax": {
"format": "double",
"type": "number"
},
"price_includes_tax": {
"type": "boolean"
},
"status": {
"enum": [
"Incomplete",
"Processed",
"Failed",
"Completed",
"Refunded",
"Pending",
"Disputed"
],
"type": "string"
},
"created_time": {
"format": "date-time",
"type": "string"
},
"tracking_id": {
"type": "string"
},
"custom_fields": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}

List all Orders

get/orders

Returns a list of your Orders. The Orders are returned sorted by creation date, with the most recent Orders appearing first.

Query Parameters

nametyperequireddescriptionexample
customer_emailstringoptional
limitintegeroptionalA limit on the number of objects to be returned. Limit can range between 1 and 100 items. (default is 10)
starting_afterstringoptionalA cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.53fabc07b7987212a01acffc
ending_beforestringoptionalA cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.54c85cceb79872183cee5f3b

Responses

200 : Success

{
"type": "object",
"properties": {
"limit": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"has_more": {
"type": "boolean",
"readOnly": true
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"reference_id": {
"type": "string"
},
"customer": {
"type": "object",
"properties": {
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email": {
"type": "string"
},
"accepts_marketing": {
"type": "boolean"
},
"company": {
"type": "string"
},
"delivery_address": {
"$ref": "#/definitions/AddressModel"
},
"billing_address": {
"$ref": "#/definitions/AddressModel"
}
}
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"product_id": {
"type": "string"
},
"product_title": {
"type": "string"
},
"product_sku": {
"type": "string"
},
"product_variant_id": {
"type": "string"
},
"product_variant_title": {
"type": "string"
},
"product_variant_sku": {
"type": "string"
},
"discount_code": {
"type": "string"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"unit_price": {
"format": "double",
"type": "number"
},
"currency": {
"type": "string"
}
}
}
},
"currency": {
"type": "string"
},
"total_price": {
"format": "double",
"type": "number"
},
"total_shipping": {
"format": "double",
"type": "number"
},
"total_tax": {
"format": "double",
"type": "number"
},
"price_includes_tax": {
"type": "boolean"
},
"status": {
"enum": [
"Incomplete",
"Processed",
"Failed",
"Completed",
"Refunded",
"Pending",
"Disputed"
],
"type": "string"
},
"created_time": {
"format": "date-time",
"type": "string"
},
"tracking_id": {
"type": "string"
},
"custom_fields": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
}
}
}

Update an order to complete status

put/orders/{id}/complete

Update an existing order status to complete.

Path Parameters

nametyperequireddescriptionexample
idstringrequiredThe identifier of the order to be updated.507f191e810c19729de860ea

Responses

200 : Success

{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"reference_id": {
"type": "string"
},
"customer": {
"type": "object",
"properties": {
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email": {
"type": "string"
},
"accepts_marketing": {
"type": "boolean"
},
"company": {
"type": "string"
},
"delivery_address": {
"type": "object",
"properties": {
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"city": {
"type": "string"
},
"post_code": {
"type": "string"
},
"state_code": {
"type": "string"
},
"country_code": {
"type": "string"
}
}
},
"billing_address": {
"type": "object",
"properties": {
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"city": {
"type": "string"
},
"post_code": {
"type": "string"
},
"state_code": {
"type": "string"
},
"country_code": {
"type": "string"
}
}
}
}
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"product_id": {
"type": "string"
},
"product_title": {
"type": "string"
},
"product_sku": {
"type": "string"
},
"product_variant_id": {
"type": "string"
},
"product_variant_title": {
"type": "string"
},
"product_variant_sku": {
"type": "string"
},
"discount_code": {
"type": "string"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"unit_price": {
"format": "double",
"type": "number"
},
"currency": {
"type": "string"
}
}
}
},
"currency": {
"type": "string"
},
"total_price": {
"format": "double",
"type": "number"
},
"total_shipping": {
"format": "double",
"type": "number"
},
"total_tax": {
"format": "double",
"type": "number"
},
"price_includes_tax": {
"type": "boolean"
},
"status": {
"enum": [
"Incomplete",
"Processed",
"Failed",
"Completed",
"Refunded",
"Pending",
"Disputed"
],
"type": "string"
},
"created_time": {
"format": "date-time",
"type": "string"
},
"tracking_id": {
"type": "string"
},
"custom_fields": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}

products

Retrieve a product

get/products/{id}

Retrieves the details of an product. You need only supply the unique model identifier that was returned upon model creation.

Path Parameters

nametyperequireddescriptionexample
idstringrequiredThe identifier of the product to be retrieved.507f191e810c19729de860ea

Responses

200 : Success

{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"sku": {
"type": "string"
},
"title": {
"type": "string"
},
"slug": {
"type": "string"
},
"description": {
"type": "string"
},
"short_url": {
"type": "string"
},
"product_type": {
"enum": [
"Physical",
"Digital",
"Service"
],
"type": "string"
},
"currency_code": {
"type": "string"
},
"price": {
"format": "double",
"type": "number"
},
"regular_price": {
"format": "double",
"type": "number"
},
"is_price_flexible": {
"type": "boolean"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"variants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"sku": {
"type": "string"
},
"title": {
"type": "string"
},
"price_regular": {
"format": "double",
"type": "number"
},
"price": {
"format": "double",
"type": "number"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"options": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"variant_attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
}
},
"images": {
"type": "array",
"items": {
"type": "object",
"properties": {
"pico": {
"type": "string"
},
"icon": {
"type": "string"
},
"thumb": {
"type": "string"
},
"small": {
"type": "string"
},
"compact": {
"type": "string"
},
"medium": {
"type": "string"
},
"large": {
"type": "string"
},
"grande": {
"type": "string"
},
"mucho_grande": {
"type": "string"
},
"huge": {
"type": "string"
},
"original": {
"type": "string"
},
"is_featured": {
"type": "boolean"
},
"is_default": {
"type": "boolean"
}
}
}
},
"featured_image": {
"type": "object",
"properties": {
"pico": {
"type": "string"
},
"icon": {
"type": "string"
},
"thumb": {
"type": "string"
},
"small": {
"type": "string"
},
"compact": {
"type": "string"
},
"medium": {
"type": "string"
},
"large": {
"type": "string"
},
"grande": {
"type": "string"
},
"mucho_grande": {
"type": "string"
},
"huge": {
"type": "string"
},
"original": {
"type": "string"
},
"is_featured": {
"type": "boolean"
},
"is_default": {
"type": "boolean"
}
}
},
"media_type": {
"enum": [
"YouTube",
"Video",
"Audio",
"Vimeo"
],
"type": "string"
},
"media_url": {
"type": "string"
},
"media_cover": {
"type": "object",
"properties": {
"pico": {
"type": "string"
},
"icon": {
"type": "string"
},
"thumb": {
"type": "string"
},
"small": {
"type": "string"
},
"compact": {
"type": "string"
},
"medium": {
"type": "string"
},
"large": {
"type": "string"
},
"grande": {
"type": "string"
},
"mucho_grande": {
"type": "string"
},
"huge": {
"type": "string"
},
"original": {
"type": "string"
},
"is_featured": {
"type": "boolean"
},
"is_default": {
"type": "boolean"
}
}
},
"is_published": {
"type": "boolean"
},
"created_time": {
"format": "date-time",
"type": "string"
}
}
}

Update a product

put/products/{id}

Update an existing product.

Path Parameters

nametyperequireddescriptionexample
idstringrequiredThe identifier of the product to be updated.507f191e810c19729de860ea

Body Parameters

namerequireddescription
productoptionalThe fields to update

Responses

200 : Success

{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"sku": {
"type": "string"
},
"title": {
"type": "string"
},
"slug": {
"type": "string"
},
"description": {
"type": "string"
},
"short_url": {
"type": "string"
},
"product_type": {
"enum": [
"Physical",
"Digital",
"Service"
],
"type": "string"
},
"currency_code": {
"type": "string"
},
"price": {
"format": "double",
"type": "number"
},
"regular_price": {
"format": "double",
"type": "number"
},
"is_price_flexible": {
"type": "boolean"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"variants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"sku": {
"type": "string"
},
"title": {
"type": "string"
},
"price_regular": {
"format": "double",
"type": "number"
},
"price": {
"format": "double",
"type": "number"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"options": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"variant_attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
}
},
"images": {
"type": "array",
"items": {
"type": "object",
"properties": {
"pico": {
"type": "string"
},
"icon": {
"type": "string"
},
"thumb": {
"type": "string"
},
"small": {
"type": "string"
},
"compact": {
"type": "string"
},
"medium": {
"type": "string"
},
"large": {
"type": "string"
},
"grande": {
"type": "string"
},
"mucho_grande": {
"type": "string"
},
"huge": {
"type": "string"
},
"original": {
"type": "string"
},
"is_featured": {
"type": "boolean"
},
"is_default": {
"type": "boolean"
}
}
}
},
"featured_image": {
"type": "object",
"properties": {
"pico": {
"type": "string"
},
"icon": {
"type": "string"
},
"thumb": {
"type": "string"
},
"small": {
"type": "string"
},
"compact": {
"type": "string"
},
"medium": {
"type": "string"
},
"large": {
"type": "string"
},
"grande": {
"type": "string"
},
"mucho_grande": {
"type": "string"
},
"huge": {
"type": "string"
},
"original": {
"type": "string"
},
"is_featured": {
"type": "boolean"
},
"is_default": {
"type": "boolean"
}
}
},
"media_type": {
"enum": [
"YouTube",
"Video",
"Audio",
"Vimeo"
],
"type": "string"
},
"media_url": {
"type": "string"
},
"media_cover": {
"type": "object",
"properties": {
"pico": {
"type": "string"
},
"icon": {
"type": "string"
},
"thumb": {
"type": "string"
},
"small": {
"type": "string"
},
"compact": {
"type": "string"
},
"medium": {
"type": "string"
},
"large": {
"type": "string"
},
"grande": {
"type": "string"
},
"mucho_grande": {
"type": "string"
},
"huge": {
"type": "string"
},
"original": {
"type": "string"
},
"is_featured": {
"type": "boolean"
},
"is_default": {
"type": "boolean"
}
}
},
"is_published": {
"type": "boolean"
},
"created_time": {
"format": "date-time",
"type": "string"
}
}
}

Delete a product

delete/products/{id}

Permanently deletes a product. It cannot be undone

Path Parameters

nametyperequireddescriptionexample
idstringrequiredThe identifier of the product to be deleted.507f191e810c19729de860ea

Responses

List all products

get/products

Returns a list of your products. The products are returned sorted by creation date, with the most recent products appearing first.

Query Parameters

nametyperequireddescriptionexample
product_typestringoptional
limitintegeroptionalA limit on the number of objects to be returned. Limit can range between 1 and 100 items. (default is 10)
starting_afterstringoptionalA cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.53fabc07b7987212a01acffc
ending_beforestringoptionalA cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.54c85cceb79872183cee5f3b

Responses

200 : Success

{
"type": "object",
"properties": {
"limit": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"has_more": {
"type": "boolean",
"readOnly": true
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"sku": {
"type": "string"
},
"title": {
"type": "string"
},
"slug": {
"type": "string"
},
"description": {
"type": "string"
},
"short_url": {
"type": "string"
},
"product_type": {
"enum": [
"Physical",
"Digital",
"Service"
],
"type": "string"
},
"currency_code": {
"type": "string"
},
"price": {
"format": "double",
"type": "number"
},
"regular_price": {
"format": "double",
"type": "number"
},
"is_price_flexible": {
"type": "boolean"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"variants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"sku": {
"type": "string"
},
"title": {
"type": "string"
},
"price_regular": {
"format": "double",
"type": "number"
},
"price": {
"format": "double",
"type": "number"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"options": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"variant_attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"$ref": "#/definitions/VariantOptionModel"
}
}
}
}
},
"images": {
"type": "array",
"items": {
"type": "object",
"properties": {
"pico": {
"type": "string"
},
"icon": {
"type": "string"
},
"thumb": {
"type": "string"
},
"small": {
"type": "string"
},
"compact": {
"type": "string"
},
"medium": {
"type": "string"
},
"large": {
"type": "string"
},
"grande": {
"type": "string"
},
"mucho_grande": {
"type": "string"
},
"huge": {
"type": "string"
},
"original": {
"type": "string"
},
"is_featured": {
"type": "boolean"
},
"is_default": {
"type": "boolean"
}
}
}
},
"featured_image": {
"type": "object",
"properties": {
"pico": {
"type": "string"
},
"icon": {
"type": "string"
},
"thumb": {
"type": "string"
},
"small": {
"type": "string"
},
"compact": {
"type": "string"
},
"medium": {
"type": "string"
},
"large": {
"type": "string"
},
"grande": {
"type": "string"
},
"mucho_grande": {
"type": "string"
},
"huge": {
"type": "string"
},
"original": {
"type": "string"
},
"is_featured": {
"type": "boolean"
},
"is_default": {
"type": "boolean"
}
}
},
"media_type": {
"enum": [
"YouTube",
"Video",
"Audio",
"Vimeo"
],
"type": "string"
},
"media_url": {
"type": "string"
},
"media_cover": {
"type": "object",
"properties": {
"pico": {
"type": "string"
},
"icon": {
"type": "string"
},
"thumb": {
"type": "string"
},
"small": {
"type": "string"
},
"compact": {
"type": "string"
},
"medium": {
"type": "string"
},
"large": {
"type": "string"
},
"grande": {
"type": "string"
},
"mucho_grande": {
"type": "string"
},
"huge": {
"type": "string"
},
"original": {
"type": "string"
},
"is_featured": {
"type": "boolean"
},
"is_default": {
"type": "boolean"
}
}
},
"is_published": {
"type": "boolean"
},
"created_time": {
"format": "date-time",
"type": "string"
}
}
}
}
}
}

Create a product

post/products

Creates a new product object.

Body Parameters

namerequireddescription
productoptional

Responses

200 : Success

{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"sku": {
"type": "string"
},
"title": {
"type": "string"
},
"slug": {
"type": "string"
},
"description": {
"type": "string"
},
"short_url": {
"type": "string"
},
"product_type": {
"enum": [
"Physical",
"Digital",
"Service"
],
"type": "string"
},
"currency_code": {
"type": "string"
},
"price": {
"format": "double",
"type": "number"
},
"regular_price": {
"format": "double",
"type": "number"
},
"is_price_flexible": {
"type": "boolean"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"variants": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"sku": {
"type": "string"
},
"title": {
"type": "string"
},
"price_regular": {
"format": "double",
"type": "number"
},
"price": {
"format": "double",
"type": "number"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"options": {
"type": "array",
"items": {
"type": "string"
}
}
}
}
},
"variant_attributes": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"options": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
}
}
}
},
"images": {
"type": "array",
"items": {
"type": "object",
"properties": {
"pico": {
"type": "string"
},
"icon": {
"type": "string"
},
"thumb": {
"type": "string"
},
"small": {
"type": "string"
},
"compact": {
"type": "string"
},
"medium": {
"type": "string"
},
"large": {
"type": "string"
},
"grande": {
"type": "string"
},
"mucho_grande": {
"type": "string"
},
"huge": {
"type": "string"
},
"original": {
"type": "string"
},
"is_featured": {
"type": "boolean"
},
"is_default": {
"type": "boolean"
}
}
}
},
"featured_image": {
"type": "object",
"properties": {
"pico": {
"type": "string"
},
"icon": {
"type": "string"
},
"thumb": {
"type": "string"
},
"small": {
"type": "string"
},
"compact": {
"type": "string"
},
"medium": {
"type": "string"
},
"large": {
"type": "string"
},
"grande": {
"type": "string"
},
"mucho_grande": {
"type": "string"
},
"huge": {
"type": "string"
},
"original": {
"type": "string"
},
"is_featured": {
"type": "boolean"
},
"is_default": {
"type": "boolean"
}
}
},
"media_type": {
"enum": [
"YouTube",
"Video",
"Audio",
"Vimeo"
],
"type": "string"
},
"media_url": {
"type": "string"
},
"media_cover": {
"type": "object",
"properties": {
"pico": {
"type": "string"
},
"icon": {
"type": "string"
},
"thumb": {
"type": "string"
},
"small": {
"type": "string"
},
"compact": {
"type": "string"
},
"medium": {
"type": "string"
},
"large": {
"type": "string"
},
"grande": {
"type": "string"
},
"mucho_grande": {
"type": "string"
},
"huge": {
"type": "string"
},
"original": {
"type": "string"
},
"is_featured": {
"type": "boolean"
},
"is_default": {
"type": "boolean"
}
}
},
"is_published": {
"type": "boolean"
},
"created_time": {
"format": "date-time",
"type": "string"
}
}
}

Add product image

post/products/{id}/image

Add an image to a product

Path Parameters

nametyperequireddescriptionexample
idstringrequiredThe identifier of the product.507f191e810c19729de860ea

Body Parameters

namerequireddescription
imageoptional

Responses

Remove product images

delete/products/{id}/images

Remove images from a product

Path Parameters

nametyperequireddescriptionexample
idstringrequiredThe identifier of the product.507f191e810c19729de860ea

Responses

Verify a license key

post/products/{id}/licenses/verify

Retrieves the details of a license key and the order associated with it.

Path Parameters

nametyperequireddescriptionexample
idstringrequiredthe product id507f191e810c19729de860ea

Body Parameters

namerequireddescription
licenseverifyoptional

Responses

200 : Success

{
"type": "object",
"properties": {
"is_active": {
"type": "boolean"
},
"usage_count": {
"format": "int32",
"type": "integer"
},
"order": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"reference_id": {
"type": "string"
},
"customer": {
"type": "object",
"properties": {
"first_name": {
"type": "string"
},
"last_name": {
"type": "string"
},
"email": {
"type": "string"
},
"accepts_marketing": {
"type": "boolean"
},
"company": {
"type": "string"
},
"delivery_address": {
"$ref": "#/definitions/AddressModel"
},
"billing_address": {
"$ref": "#/definitions/AddressModel"
}
}
},
"items": {
"type": "array",
"items": {
"type": "object",
"properties": {
"product_id": {
"type": "string"
},
"product_title": {
"type": "string"
},
"product_sku": {
"type": "string"
},
"product_variant_id": {
"type": "string"
},
"product_variant_title": {
"type": "string"
},
"product_variant_sku": {
"type": "string"
},
"discount_code": {
"type": "string"
},
"quantity": {
"format": "int32",
"type": "integer"
},
"unit_price": {
"format": "double",
"type": "number"
},
"currency": {
"type": "string"
}
}
}
},
"currency": {
"type": "string"
},
"total_price": {
"format": "double",
"type": "number"
},
"total_shipping": {
"format": "double",
"type": "number"
},
"total_tax": {
"format": "double",
"type": "number"
},
"price_includes_tax": {
"type": "boolean"
},
"status": {
"enum": [
"Incomplete",
"Processed",
"Failed",
"Completed",
"Refunded",
"Pending",
"Disputed"
],
"type": "string"
},
"created_time": {
"format": "date-time",
"type": "string"
},
"tracking_id": {
"type": "string"
},
"custom_fields": {
"type": "object",
"additionalProperties": {
"type": "object"
}
}
}
}
}
}

Assign to category

post/products/{id}/category

Allows you to assign a category to a specified product.

Path Parameters

nametyperequireddescriptionexample
idstringrequiredthe product id507f191e810c19729de860ea

Body Parameters

namerequireddescription
categoryproductoptional

Responses

200 : Success

{
"required": [
"category_id"
],
"type": "object",
"properties": {
"category_id": {
"type": "string"
}
}
}

Remove from category

delete/products/{id}/category/{category_id}

Allows you to remove a category from a specified product.

Path Parameters

nametyperequireddescriptionexample
idstringrequiredthe product id507f191e810c19729de860ea
category_idstringrequiredthe category id
category_idstringrequired

Responses

List categories

get/products/{id}/categories

Allows you to retrieve information about categories assigned to the specified product.

Path Parameters

nametyperequireddescriptionexample
idstringrequired507f191e810c19729de860ea

Query Parameters

nametyperequireddescriptionexample
product_idstringoptional
limitintegeroptionalA limit on the number of objects to be returned. Limit can range between 1 and 100 items. (default is 10)
starting_afterstringoptionalA cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.53fabc07b7987212a01acffc
ending_beforestringoptionalA cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.54c85cceb79872183cee5f3b

Responses

200 : Success

{
"type": "object",
"properties": {
"limit": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"has_more": {
"type": "boolean",
"readOnly": true
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"parent_id": {
"type": "string"
},
"title": {
"type": "string"
},
"meta_title": {
"type": "string"
},
"description": {
"type": "string"
},
"meta_description": {
"type": "string"
},
"image": {
"type": "object",
"properties": {
"pico": {
"type": "string"
},
"icon": {
"type": "string"
},
"thumb": {
"type": "string"
},
"small": {
"type": "string"
},
"compact": {
"type": "string"
},
"medium": {
"type": "string"
},
"large": {
"type": "string"
},
"grande": {
"type": "string"
},
"mucho_grande": {
"type": "string"
},
"huge": {
"type": "string"
},
"original": {
"type": "string"
},
"is_featured": {
"type": "boolean"
},
"is_default": {
"type": "boolean"
}
}
},
"slug": {
"type": "string"
},
"sort_type": {
"enum": [
"Unknown",
"Manual",
"AlphaAsc",
"AlphaDesc",
"CreatedAsc",
"CreatedDesc",
"PriceAsc",
"PriceDesc"
],
"type": "string"
},
"is_published": {
"type": "boolean"
},
"created_time": {
"format": "date-time",
"type": "string"
},
"updated_time": {
"format": "date-time",
"type": "string"
}
}
}
}
}
}

store

Retrieve store details

get/store

Get details of the store

Responses

200 : Success

{
"type": "object",
"properties": {
"name": {
"type": "string"
},
"logo": {
"type": "string"
},
"owner": {
"type": "object",
"properties": {
"full_name": {
"type": "string"
},
"email": {
"type": "string"
},
"biography": {
"type": "string"
},
"avatar": {
"type": "string"
},
"address": {
"type": "object",
"properties": {
"line1": {
"type": "string"
},
"line2": {
"type": "string"
},
"city": {
"type": "string"
},
"post_code": {
"type": "string"
},
"state_code": {
"type": "string"
},
"country_code": {
"type": "string"
}
}
},
"culture_name": {
"type": "string"
},
"time_zone": {
"type": "string"
}
}
},
"icon": {
"type": "string"
},
"display_name": {
"type": "string"
},
"domain": {
"type": "string"
},
"created_time": {
"format": "date-time",
"type": "string"
}
}
}

webhooks

Retrieve a webhook

get/webhooks/{id}

Retrieves the details of an existing webhook. You need only supply the unique model identifier that was returned upon model creation.

Path Parameters

nametyperequireddescriptionexample
idstringrequiredThe identifier of the webhook to be retrieved.507f191e810c19729de860ea

Responses

200 : Success

{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"url": {
"type": "string"
},
"event_type": {
"type": "string"
},
"created_time": {
"format": "date-time",
"type": "string"
}
}
}

Update a webhook

put/webhooks/{id}

Update an existing webhook.

Path Parameters

nametyperequireddescriptionexample
idstringrequiredThe identifier of the webhook to be updated.507f191e810c19729de860ea

Body Parameters

namerequireddescription
webhookoptionalThe fields to update

Responses

200 : Success

{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"url": {
"type": "string"
},
"event_type": {
"type": "string"
},
"created_time": {
"format": "date-time",
"type": "string"
}
}
}

Delete a webhook

delete/webhooks/{id}

Permanently deletes a webhook. It cannot be undone

Path Parameters

nametyperequireddescriptionexample
idstringrequiredThe identifier of the webhook to be deleted.507f191e810c19729de860ea

Responses

List all webhooks

get/webhooks

Returns a list of your webhooks. The webhooks are returned sorted by creation date, with the most recent webhooks appearing first.

Query Parameters

nametyperequireddescriptionexample
event_typestringoptional
limitintegeroptionalA limit on the number of objects to be returned. Limit can range between 1 and 100 items. (default is 10)
starting_afterstringoptionalA cursor for use in pagination. starting_after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include starting_after=obj_foo in order to fetch the next page of the list.53fabc07b7987212a01acffc
ending_beforestringoptionalA cursor for use in pagination. ending_before is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, starting with obj_bar, your subsequent call can include ending_before=obj_bar in order to fetch the previous page of the list.54c85cceb79872183cee5f3b

Responses

200 : Success

{
"type": "object",
"properties": {
"limit": {
"format": "int32",
"type": "integer",
"readOnly": true
},
"has_more": {
"type": "boolean",
"readOnly": true
},
"data": {
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"url": {
"type": "string"
},
"event_type": {
"type": "string"
},
"created_time": {
"format": "date-time",
"type": "string"
}
}
}
}
}
}

Create a webhook

post/webhooks

Creates a new webhook object.

Body Parameters

namerequireddescription
webhookoptional

Responses

200 : Success

{
"type": "object",
"properties": {
"id": {
"type": "string"
},
"key": {
"type": "string"
},
"url": {
"type": "string"
},
"event_type": {
"type": "string"
},
"created_time": {
"format": "date-time",
"type": "string"
}
}
}