@datafire/jumpseller v5.0.0

@datafire/jumpseller

Client library for Jumpseller API

Installation and Usage

npm install --save @datafire/jumpseller

let jumpseller = require('@datafire/jumpseller').create();

.then(data => {
  console.log(data);
});

Description

Endpoint Structure

All URLs are in the format:

https://api.jumpseller.com/v1/path.json?login=XXXXXX&authtoken=storetoken  

The path is prefixed by the API version and the URL takes as parameters the login (your store specific API login) and your authentication token.

Version

The current version of the API is v1.
If we change the API in backward-incompatible ways, we'll increase the version number and maintain stable support for the old urls.

Authentication

The API uses a token-based authentication with a combination of a login key and an auth token. Both parameters can be found on the left sidebar of the Account section, accessed from the main menu of your Admin Panel. The auth token of the user can be reset on the same page.

The auth token is a 32 characters string.

If you are developing a Jumpseller App, the authentication should be done using OAuth-2. Please read the article Build an App for more information.

Curl Examples

To request all the products at your store, you would append the products index path to the base url to create an URL with the format:

https://api.jumpseller.com/v1/products.json?login=XXXXXX&authtoken=XXXXX

In curl, you can invoque that URL with:

curl -X GET "https://api.jumpseller.com/v1/products.json?login=XXXXXX&authtoken=XXXXX"

To create a product, you will include the JSON data and specify the MIME Type:

curl -X POST -d '{ "product" : {"name": "My new Product!", "price": 100} }' "https://api.jumpseller.com/v1/products.json?login=XXXXXX&authtoken=XXXXX" -H "Content-Type:application/json"

and to update the product identified with 123:

curl -X PUT -d '{ "product" : {"name": "My updated Product!", "price": 99} }' "https://api.jumpseller.com/v1/products/123.json?login=XXXXXX&authtoken=XXXXX" -H "Content-Type:application/json"

or delete it:

curl -X DELETE "https://api.jumpseller.com/v1/products/123.json?login=XXXXXX&authtoken=XXXXX" -H "Content-Type:application/json"

PHP Examples

Create a new Product (POST method)

$url = 'https://api.jumpseller.com/v1/products.json?login=XXXXX&authtoken=XXXXX;
$ch = curl_init($url);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, array('Content-Type: application/json'));

curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST"); //post method
curl_setopt($ch, CURLOPT_POSTFIELDS, '{ "product" : {"name": "My updated Product!", "price": 99} }');

$result = curl_exec($ch);
print_r($result);
curl_close($ch);

Plain JSON only. No XML.

• We only support JSON for data serialization.
• Our node format has no root element.
• We use snake_case to describe attribute keys (like "created_at").
• All empty value are replaced with null strings.
• All API URLs end in .json to indicate that they accept and return JSON.
• POST and PUT methods require you to explicitly state the MIME type of your request's body content as "application/json".

Rate Limit

You can perform a maximum of:

• 240 (two hundred forty) requests per minute and
• 8 (eight) requests per second

If you exceed this limit, you'll get a 403 Forbidden (Rate Limit Exceeded) response for subsequent requests.

The rate limits apply by IP address and by store. This means that multiple requests on different stores are not counted towards the same rate limit.

This limits are necessary to ensure resources are correctly used. Your application should be aware of this limits and retry any unsuccessful request, check the following Ruby stub:

tries = 0; max_tries = 3;
begin
  HTTParty.send(method, uri) # perform an API call.
  sleep 0.5
  tries += 1
rescue
  unless tries >= max_tries
    sleep 1.0 # wait the necessary time before retrying the call again.
    retry
  end
end

Finally, you can review the Response Headers of each request:

Jumpseller-PerMinuteRateLimit-Limit: 60  
Jumpseller-PerMinuteRateLimit-Remaining: 59 # requests available on the per-second interval  
Jumpseller-PerSecondRateLimit-Limit: 2  
Jumpseller-PerSecondRateLimit-Remaining: 1 # requests available on the per-second interval

to better model your application requests intervals.

In the event of getting your IP banned, the Response Header Jumpseller-BannedByRateLimit-Reset informs you the time when will your ban be reseted.

Pagination

By default we will return 50 objects (products, orders, etc) per page. There is a maximum of 100, using a query string &limit=100. If the result set gets paginated it is your responsibility to check the next page for more objects -- you do this by using query strings &page=2, &page=3 and so on.

https://api.jumpseller.com/v1/products.json?login=XXXXXX&authtoken=XXXXX&page=3&limit=100

More

• Jumpseller API wrapper provides a public Ruby abstraction over our API;
• Apps Page showcases external integrations with Jumpseller done by technical experts;
• Imgbb API provides an easy way to upload and temporaly host for images and files.

Actions

categories.json.get

Retrieve all Categories.

jumpseller.categories.json.get({
  "login": "",
  "authtoken": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.

Output

• output Category

categories.json.post

Category's permalink is automatically generated from the given category's name.

jumpseller.categories.json.post({
  "login": "",
  "authtoken": "",
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • body required CategoryEdit

Output

• output Category

categories.count.json.get

Count all Categories.

jumpseller.categories.count.json.get({
  "login": "",
  "authtoken": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.

Output

• output Count

categories.id.json.delete

Delete an existing Category.

jumpseller.categories.id.json.delete({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Category

Output

• output string

categories.id.json.get

Retrieve a single Category.

jumpseller.categories.id.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Category

Output

• output Category

categories.id.json.put

Modify an existing Category.

jumpseller.categories.id.json.put({
  "login": "",
  "authtoken": "",
  "id": 0,
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Category
  • body required CategoryEdit

Output

• output Category

checkout_custom_fields.json.get

Retrieve all Checkout Custom Fields.

jumpseller.checkout_custom_fields.json.get({
  "login": "",
  "authtoken": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • limit integer: List restriction
  • page integer: List page

Output

• output array
  • items CheckoutCustomField

checkout_custom_fields.json.post

Type values can be: input, selection, checkbox, date or text. Area values can be: contact, billing_shipping or other.

jumpseller.checkout_custom_fields.json.post({
  "login": "",
  "authtoken": "",
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • body required CheckoutCustomFieldEdit

Output

• output CheckoutCustomField

checkout_custom_fields.id.json.delete

Delete an existing CheckoutCustomField.

jumpseller.checkout_custom_fields.id.json.delete({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the CheckoutCustomField

Output

• output string

checkout_custom_fields.id.json.get

Retrieve a single CheckoutCustomField.

jumpseller.checkout_custom_fields.id.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the CheckoutCustomField

Output

• output CheckoutCustomField

checkout_custom_fields.id.json.put

Update a CheckoutCustomField.

jumpseller.checkout_custom_fields.id.json.put({
  "login": "",
  "authtoken": "",
  "id": 0,
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the CheckoutCustomField
  • body required CheckoutCustomFieldEdit

Output

• output CheckoutCustomField

countries.json.get

Retrieve all Countries.

jumpseller.countries.json.get({
  "login": "",
  "authtoken": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.

Output

• output array
  • items Country

countries.country_code.json.get

Retrieve a single Country information.

jumpseller.countries.country_code.json.get({
  "login": "",
  "authtoken": "",
  "country_code": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • country_code required string: ISO3166 Country Code

Output

• output Country

countries.country_code.regions.json.get

Retrieve all Regions from a single Country.

jumpseller.countries.country_code.regions.json.get({
  "login": "",
  "authtoken": "",
  "country_code": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • country_code required string: ISO3166 Country Code

Output

• output array
  • items Region

countries.country_code.regions.region_code.json.get

Retrieve a single Region information object.

jumpseller.countries.country_code.regions.region_code.json.get({
  "login": "",
  "authtoken": "",
  "country_code": "",
  "region_code": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • country_code required string: ISO3166 Country Code
  • region_code required string: Region Code

Output

• output Region

custom_fields.json.get

Retrieve all Store's Custom Fields.

jumpseller.custom_fields.json.get({
  "login": "",
  "authtoken": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.

Output

• output array
  • items CustomField

custom_fields.json.post

Create a new Custom Field.

jumpseller.custom_fields.json.post({
  "login": "",
  "authtoken": "",
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • body required CustomFieldEdit

Output

• output CustomField

custom_fields.id.json.delete

Delete an existing CustomField.

jumpseller.custom_fields.id.json.delete({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the CustomField

Output

• output string

custom_fields.id.json.get

Retrieve a single CustomField.

jumpseller.custom_fields.id.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the CustomField

Output

• output CustomField

custom_fields.id.json.put

Update a CustomField.

jumpseller.custom_fields.id.json.put({
  "login": "",
  "authtoken": "",
  "id": 0,
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the CustomField
  • body required CustomFieldEdit

Output

• output CustomField

customer_categories.json.get

Retrieve all Customer Categories.

jumpseller.customer_categories.json.get({
  "login": "",
  "authtoken": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • limit integer: List restriction
  • page integer: List page

Output

• output array
  • items CustomerCategory

customer_categories.json.post

Create a new CustomerCategory.

jumpseller.customer_categories.json.post({
  "login": "",
  "authtoken": "",
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • body required CustomerCategoryEdit

Output

• output CustomerCategory

customer_categories.id.json.delete

Delete an existing CustomerCategory.

jumpseller.customer_categories.id.json.delete({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the CustomerCategory

Output

• output string

customer_categories.id.json.get

Retrieve a single CustomerCategory.

jumpseller.customer_categories.id.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the CustomerCategory

Output

• output CustomerCategory

customer_categories.id.json.put

Update a CustomerCategory.

jumpseller.customer_categories.id.json.put({
  "login": "",
  "authtoken": "",
  "id": 0,
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the CustomerCategory
  • body required CustomerCategoryEdit

Output

• output CustomerCategory

customer_categories.id.customers.json.delete

Delete Customers from an existing CustomerCategory.

jumpseller.customer_categories.id.customers.json.delete({
  "login": "",
  "authtoken": "",
  "id": 0,
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the CustomerCategory
  • body required CustomersToCustomerCategory

Output

• output string

customer_categories.id.customers.json.get

Retrieves the customers in a CustomerCategory.

jumpseller.customer_categories.id.customers.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the CustomerCategory

Output

• output array
  • items Customer

customer_categories.id.customers.json.post

Adds Customers to a CustomerCategory.

jumpseller.customer_categories.id.customers.json.post({
  "login": "",
  "authtoken": "",
  "id": 0,
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the CustomerCategory
  • body required CustomersToCustomerCategory

Output

• output array
  • items Customer

customers.json.get

Retrieve all Customers.

jumpseller.customers.json.get({
  "login": "",
  "authtoken": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • limit integer: List restriction
  • page integer: List page

Output

• output array
  • items Customer

customers.json.post

Create a new Customer.

jumpseller.customers.json.post({
  "login": "",
  "authtoken": "",
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • body required CustomerWithPasswordNoID

Output

• output Customer

customers.count.json.get

Count all Customers.

jumpseller.customers.count.json.get({
  "login": "",
  "authtoken": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.

Output

• output Count

customers.email.email.json.get

Retrieve a single Customer by email.

jumpseller.customers.email.email.json.get({
  "login": "",
  "authtoken": "",
  "email": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • email required string: Email of the Customer

Output

• output Customer

customers.id.json.delete

Delete an existing Customer.

jumpseller.customers.id.json.delete({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Customer

Output

• output string

customers.id.json.get

Retrieve a single Customer by id.

jumpseller.customers.id.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Customer

Output

• output Customer

customers.id.json.put

Update a new Customer.

jumpseller.customers.id.json.put({
  "login": "",
  "authtoken": "",
  "id": 0,
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Customer
  • body required CustomerWithPasswordNoID

Output

• output Customer

customers.id.fields.get

Retrieves the Customer Additional Field of a Customer.

jumpseller.customers.id.fields.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Customer

Output

• output array
  • items CustomerAdditionalField

customers.id.fields.post

Adds Customer Additional Fields to a Customer.

jumpseller.customers.id.fields.post({
  "login": "",
  "authtoken": "",
  "id": 0,
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Customer
  • body required CustomerAdditionalFieldEdit

Output

• output CustomerAdditionalField

customers.id.fields.field_id.delete

Delete a Customer Additional Field.

jumpseller.customers.id.fields.field_id.delete({
  "login": "",
  "authtoken": "",
  "id": 0,
  "field_id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Customer
  • field_id required integer: Id of the Customer Additional Field

Output

• output string

customers.id.fields.field_id.get

Retrieve a single Customer Additional Field.

jumpseller.customers.id.fields.field_id.get({
  "login": "",
  "authtoken": "",
  "id": 0,
  "field_id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Customer
  • field_id required integer: Id of the Customer Additional Field

Output

• output CustomerAdditionalField

customers.id.fields.field_id.put

Update a Customer Additional Field.

jumpseller.customers.id.fields.field_id.put({
  "login": "",
  "authtoken": "",
  "id": 0,
  "field_id": 0,
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Customer
  • field_id required integer: Id of the Customer Additional Field
  • body required CustomerAdditionalFieldEdit

Output

• output CustomerAdditionalField

hooks.json.get

Retrieve all Hooks.

jumpseller.hooks.json.get({
  "login": "",
  "authtoken": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • limit integer: List restriction
  • page integer: List page

Output

• output array
  • items Hook

hooks.json.post

Create a new Hook.

jumpseller.hooks.json.post({
  "login": "",
  "authtoken": "",
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • body required HookEdit

Output

• output Hook

hooks.id.json.delete

Delete an existing Hook.

jumpseller.hooks.id.json.delete({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Hook

Output

• output string

hooks.id.json.get

Retrieve a single Hook.

jumpseller.hooks.id.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Hook

Output

• output Hook

hooks.id.json.put

Update a Hook.

jumpseller.hooks.id.json.put({
  "login": "",
  "authtoken": "",
  "id": 0,
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Hook
  • body required HookEdit

Output

• output Hook

jsapps.json.get

Retrieve all the Store's JSApps

jumpseller.jsapps.json.get({
  "login": "",
  "authtoken": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.

Output

• output App

jsapps.json.post

Create a Store JSApp

jumpseller.jsapps.json.post({
  "login": "",
  "authtoken": "",
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • body required JSAppEdit

Output

• output JSApp

jsapps.code.json.delete

Delete an existing JSApp.

jumpseller.jsapps.code.json.delete({
  "login": "",
  "authtoken": "",
  "code": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • code required string: Code of the App

Output

• output string

jsapps.code.json.get

Retrieve a JSApp

jumpseller.jsapps.code.json.get({
  "login": "",
  "authtoken": "",
  "code": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • code required string: Code of the App

Output

• output JSApp

orders.json.get

Retrieve all Orders.

jumpseller.orders.json.get({
  "login": "",
  "authtoken": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • limit integer: List restriction
  • page integer: List page

Output

• output array
  • items Order

orders.json.post

Create a new Order.

jumpseller.orders.json.post({
  "login": "",
  "authtoken": "",
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • body required OrderCreate

Output

• output Order

orders.after.id.json.get

For example the GET /orders/after/5000 will return Order 5001, 5002, 5003, etc.

jumpseller.orders.after.id.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Order

Output

• output Order

orders.count.json.get

Count all Orders.

jumpseller.orders.count.json.get({
  "login": "",
  "authtoken": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.

Output

• output Count

orders.status.status.json.get

Retrieve orders filtered by status.

jumpseller.orders.status.status.json.get({
  "login": "",
  "authtoken": "",
  "status": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • status required string (values: Abandoned, Canceled, Pending Payment, Paid): Status of the Order used as filter

Output

• output array
  • items Order

orders.id.json.get

Retrieve a single Order.

jumpseller.orders.id.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Order

Output

• output Order

orders.id.json.put

Only status, shipment_status, tracking_number, tracking_company, additional_information and additional_fields are available for update.

jumpseller.orders.id.json.put({
  "login": "",
  "authtoken": "",
  "id": 0,
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Order
  • body required OrderEdit

Output

• output Order

orders.id.history.json.get

Retrieve all Order History.

jumpseller.orders.id.history.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Order

Output

• output array
  • items OrderHistory

orders.id.history.json.post

Create a new Order History Entry.

jumpseller.orders.id.history.json.post({
  "login": "",
  "authtoken": "",
  "id": 0,
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the OrderHistory
  • body required OrderHistoryEdit

Output

• output OrderHistory

payment_methods.json.get

Retrieve all Store's Payment Methods.

jumpseller.payment_methods.json.get({
  "login": "",
  "authtoken": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.

Output

• output array
  • items PaymentMethod

payment_methods.id.json.get

Retrieve a single Payment Method.

jumpseller.payment_methods.id.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Payment Method

Output

• output PaymentMethod

products.json.get

Retrieve all Products.

jumpseller.products.json.get({
  "login": "",
  "authtoken": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • limit integer: List restriction
  • page integer: List page
  • locale string: Locale code of the translation

Output

• output array
  • items Product

products.json.post

Create a new Product.

jumpseller.products.json.post({
  "login": "",
  "authtoken": "",
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • locale string: Locale code of the translation
  • body required ProductEdit

Output

• output Product

products.after.id.json.get

Retrieves Products after the given id.

jumpseller.products.after.id.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Product
  • locale string: Locale code of the translation

Output

• output array
  • items Product

products.category.category_id.json.get

Retrieve Products filtered by category.

jumpseller.products.category.category_id.json.get({
  "login": "",
  "authtoken": "",
  "category_id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • locale string: Locale code of the translation
  • category_id required integer: Category ID of the Product used as filter

Output

• output array
  • items Product

products.category.category_id.count.json.get

Count Products filtered by category.

jumpseller.products.category.category_id.count.json.get({
  "login": "",
  "authtoken": "",
  "category_id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • locale string: Locale code of the translation
  • category_id required integer: Category ID of the Product used as filter

Output

• output Count

products.count.json.get

Count all Products.

jumpseller.products.count.json.get({
  "login": "",
  "authtoken": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.

Output

• output Count

products.search.json.get

Endpoint example:

https://api.jumpseller.com/v1/products/search.json?login=XXXXXX&authtoken=XXXXX&query=test&fields=name,description 

jumpseller.products.search.json.get({
  "login": "",
  "authtoken": "",
  "query": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • locale string: Locale code of the translation
  • query required string: Text to query for the Product
  • fields string (values: sku, barcode, brand, name, description, variants, option_name, custom_fields, custom_fields_selects): Comma separated values of the fields to query for the Product

Output

• output array
  • items Product

products.status.status.json.get

Retrieve Products filtered by status.

jumpseller.products.status.status.json.get({
  "login": "",
  "authtoken": "",
  "status": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • locale string: Locale code of the translation
  • status required string (values: available, not-available, disabled): Status of the Product used as filter

Output

• output array
  • items Product

products.status.status.count.json.get

Count Products filtered by status.

jumpseller.products.status.status.count.json.get({
  "login": "",
  "authtoken": "",
  "status": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • locale string: Locale code of the translation
  • status required string (values: available, not-available, disabled): Status of the Product used as filter

Output

• output Count

products.id.json.delete

Delete an existing Product.

jumpseller.products.id.json.delete({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Product

Output

• output string

products.id.json.get

Retrieve a single Product.

jumpseller.products.id.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • locale string: Locale code of the translation
  • id required integer: ID of the Product

Output

• output Product

products.id.json.put

Modify an existing Product.

jumpseller.products.id.json.put({
  "login": "",
  "authtoken": "",
  "id": 0,
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Product
  • locale string: Locale code of the translation
  • body required ProductEdit

Output

• output Product

products.id.attachments.json.get

Retrieve all Product Attachments.

jumpseller.products.id.attachments.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: ID of the Product

Output

• output array
  • items Attachment

products.id.attachments.json.post

Create a new Product Attachment.

jumpseller.products.id.attachments.json.post({
  "login": "",
  "authtoken": "",
  "id": 0,
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Product
  • body required AttachmentEdit

Output

• output Attachment

products.id.attachments.count.json.get

Count all Product Attachments.

jumpseller.products.id.attachments.count.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: ID of the Product

Output

• output Count

products.id.attachments.attachment_id.json.delete

Delete a Product Attachment.

jumpseller.products.id.attachments.attachment_id.json.delete({
  "login": "",
  "authtoken": "",
  "id": 0,
  "attachment_id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Product
  • attachment_id required integer: Id of the Product Attachment

Output

• output string

products.id.attachments.attachment_id.json.get

Retrieve a single Product Attachment.

jumpseller.products.id.attachments.attachment_id.json.get({
  "login": "",
  "authtoken": "",
  "id": 0,
  "attachment_id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Product
  • attachment_id required integer: Id of the Product Attachment

Output

• output Attachment

products.id.digital_products.json.get

Retrieve all Product DigitalProducts.

jumpseller.products.id.digital_products.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: ID of the Product

Output

• output array
  • items DigitalProduct

products.id.digital_products.json.post

Create a new Product DigitalProduct.

jumpseller.products.id.digital_products.json.post({
  "login": "",
  "authtoken": "",
  "id": 0,
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Product
  • body required DigitalProductEdit

Output

• output DigitalProduct

products.id.digital_products.count.json.get

Count all Product DigitalProducts.

jumpseller.products.id.digital_products.count.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: ID of the Product

Output

• output Count

products.id.digital_products.digital_product_id.json.delete

Delete a Product DigitalProduct.

jumpseller.products.id.digital_products.digital_product_id.json.delete({
  "login": "",
  "authtoken": "",
  "id": 0,
  "digital_product_id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Product
  • digital_product_id required integer: Id of the Product DigitalProduct

Output

• output string

products.id.digital_products.digital_product_id.json.get

Retrieve a single Product DigitalProduct.

jumpseller.products.id.digital_products.digital_product_id.json.get({
  "login": "",
  "authtoken": "",
  "id": 0,
  "digital_product_id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Product
  • digital_product_id required integer: Id of the Product DigitalProduct

Output

• output DigitalProduct

products.id.fields.json.get

Retrieve all Product Custom Fields

jumpseller.products.id.fields.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Product

Output

• output array
  • items ProductCustomField

products.id.fields.json.post

Create a new Product Custom Field.

jumpseller.products.id.fields.json.post({
  "login": "",
  "authtoken": "",
  "id": 0,
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Product
  • body required ProductCustomField

Output

• output Product

products.id.fields.count.json.get

Count all Product Custom Fields.

jumpseller.products.id.fields.count.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: ID of the Product

Output

• output Count

products.id.images.json.get

Retrieve all Product Images.

jumpseller.products.id.images.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: ID of the Product

Output

• output array
  • items Image

products.id.images.json.post

Create a new Product Image.

jumpseller.products.id.images.json.post({
  "login": "",
  "authtoken": "",
  "id": 0,
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Product
  • body required ImageEdit

Output

• output Image

products.id.images.count.json.get

Count all Product Images.

jumpseller.products.id.images.count.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: ID of the Product

Output

• output Count

products.id.images.image_id.json.delete

Delete a Product Image.

jumpseller.products.id.images.image_id.json.delete({
  "login": "",
  "authtoken": "",
  "id": 0,
  "image_id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Product
  • image_id required integer: Id of the Product Image

Output

• output string

products.id.images.image_id.json.get

Retrieve a single Product Image.

jumpseller.products.id.images.image_id.json.get({
  "login": "",
  "authtoken": "",
  "id": 0,
  "image_id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Product
  • image_id required integer: Id of the Product Image

Output

• output Image

products.id.options.json.get

Retrieve all Product Options.

jumpseller.products.id.options.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: ID of the Product

Output

• output array
  • items ProductOption

products.id.options.json.post

Create a new Product Option.

jumpseller.products.id.options.json.post({
  "login": "",
  "authtoken": "",
  "id": 0,
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Product
  • body required ProductOptionEdit

Output

• output ProductOption

products.id.options.count.json.get

Count all Product Options.

jumpseller.products.id.options.count.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: ID of the Product

Output

• output Count

products.id.options.option_id.json.delete

Delete a Product Option.

jumpseller.products.id.options.option_id.json.delete({
  "login": "",
  "authtoken": "",
  "id": 0,
  "option_id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Product
  • option_id required integer: Id of the Product Option

Output

• output string

products.id.options.option_id.json.get

Retrieve a single Product Option.

jumpseller.products.id.options.option_id.json.get({
  "login": "",
  "authtoken": "",
  "id": 0,
  "option_id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Product
  • option_id required integer: Id of the Product Option

Output

• output ProductOption

products.id.options.option_id.json.put

Modify an existing Product Option.

jumpseller.products.id.options.option_id.json.put({
  "login": "",
  "authtoken": "",
  "id": 0,
  "option_id": 0,
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Product
  • option_id required integer: Id of the Product Option
  • body required ProductOptionEdit

Output

• output ProductOption

products.id.options.option_id.values.json.get

Retrieve all Product Option Values.

jumpseller.products.id.options.option_id.values.json.get({
  "login": "",
  "authtoken": "",
  "id": 0,
  "option_id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: ID of the Product
  • option_id required integer: ID of the Product Option

Output

• output array
  • items ProductOptionValue

products.id.options.option_id.values.json.post

Create a new Product Option Value.

jumpseller.products.id.options.option_id.values.json.post({
  "login": "",
  "authtoken": "",
  "id": 0,
  "option_id": 0,
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Product
  • option_id required integer: Id of the Product Option
  • body required ProductOptionValueEdit

Output

• output ProductOptionValue

products.id.options.option_id.values.count.json.get

Count all Product Option Values.

jumpseller.products.id.options.option_id.values.count.json.get({
  "login": "",
  "authtoken": "",
  "id": 0,
  "option_id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: ID of the Product
  • option_id required integer: ID of the Product Option

Output

• output Count

products.id.options.option_id.values.value_id.json.delete

Delete a Product Option Value.

jumpseller.products.id.options.option_id.values.value_id.json.delete({
  "login": "",
  "authtoken": "",
  "id": 0,
  "option_id": 0,
  "value_id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Product
  • option_id required integer: Id of the Product Option
  • value_id required integer: ID of the Product Option Value

Output

• output string

products.id.options.option_id.values.value_id.json.get

Retrieve a single Product Option Value.

jumpseller.products.id.options.option_id.values.value_id.json.get({
  "login": "",
  "authtoken": "",
  "id": 0,
  "option_id": 0,
  "value_id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Product
  • option_id required integer: Id of the Product Option
  • value_id required integer: ID of the Product Option Value

Output

• output ProductOptionValue

products.id.options.option_id.values.value_id.json.put

Modify an existing Product Option Value.

jumpseller.products.id.options.option_id.values.value_id.json.put({
  "login": "",
  "authtoken": "",
  "id": 0,
  "option_id": 0,
  "value_id": 0,
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Product
  • option_id required integer: Id of the Product Option
  • value_id required integer: Id of the Product Option Value
  • body required ProductOptionValueEdit

Output

• output ProductOptionValue

products.id.variants.json.get

Retrieve all Product Variants.

jumpseller.products.id.variants.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: ID of the Product

Output

• output array
  • items Variant

products.id.variants.json.post

Create a new Product Variant.

jumpseller.products.id.variants.json.post({
  "login": "",
  "authtoken": "",
  "id": 0,
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Product
  • body required VariantEdit

Output

• output Variant

products.id.variants.count.json.get

Count all Product Variants.

jumpseller.products.id.variants.count.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: ID of the Product

Output

• output Count

products.id.variants.variant_id.json.get

Retrieve a single Product Variant.

jumpseller.products.id.variants.variant_id.json.get({
  "login": "",
  "authtoken": "",
  "id": 0,
  "variant_id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Product
  • variant_id required integer: Id of the Product Variant

Output

• output Variant

products.id.variants.variant_id.json.put

Modify an existing Product Variant.

jumpseller.products.id.variants.variant_id.json.put({
  "login": "",
  "authtoken": "",
  "id": 0,
  "variant_id": 0,
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Product
  • variant_id required integer: Id of the Product Variant
  • body required VariantEdit

Output

• output Variant

promotions.json.get

Retrieve all Promotions.

jumpseller.promotions.json.get({
  "login": "",
  "authtoken": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • limit integer: Promotions' list restriction (default: 50 | max: 200).
  • page integer: Promotions' list page (default: 1).

Output

• output array
  • items Promotion

promotions.json.post

Create a new Promotion.

jumpseller.promotions.json.post({
  "login": "",
  "authtoken": "",
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • body required PromotionEdit

Output

• output Promotion

promotions.id.json.delete

Delete an existing Promotion.

jumpseller.promotions.id.json.delete({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Promotion

Output

• output string

promotions.id.json.get

Retrieve a single Promotion.

jumpseller.promotions.id.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Promotion

Output

• output Promotion

promotions.id.json.put

Update a Promotion.

jumpseller.promotions.id.json.put({
  "login": "",
  "authtoken": "",
  "id": 0,
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Promotion
  • body required PromotionEdit

Output

• output Promotion

shipping_methods.json.get

Retrieve all Store's Shipping Methods.

jumpseller.shipping_methods.json.get({
  "login": "",
  "authtoken": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.

Output

• output array
  • items ShippingMethod

shipping_methods.json.post

Creates a Shipping Method.

jumpseller.shipping_methods.json.post({
  "login": "",
  "authtoken": "",
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • body required ShippingMethodCreate

Output

• output ShippingMethod

shipping_methods.id.json.delete

Delete an existing Shipping Method.

jumpseller.shipping_methods.id.json.delete({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Shipping Method

Output

• output string

shipping_methods.id.json.get

Retrieve a single Shipping Method.

jumpseller.shipping_methods.id.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Shipping Method

Output

• output ShippingMethod

shipping_methods.id.json.put

Update a Shipping Method.

jumpseller.shipping_methods.id.json.put({
  "login": "",
  "authtoken": "",
  "id": 0,
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Shipping Method
  • body required ShippingMethodCreate

Output

• output ShippingMethod

store.info.json.get

Retrieve Store Information

jumpseller.store.info.json.get({
  "login": "",
  "authtoken": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.

Output

• output Store

store.languages.json.get

Retrieve Store Languages

jumpseller.store.languages.json.get({
  "login": "",
  "authtoken": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.

Output

• output array
  • items Language

taxes.json.get

Retrieve all Taxes.

jumpseller.taxes.json.get({
  "login": "",
  "authtoken": ""
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.

Output

• output array
  • items Tax

taxes.json.post

Create a new Tax.

jumpseller.taxes.json.post({
  "login": "",
  "authtoken": "",
  "body": {}
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • body required TaxEdit

Output

• output Tax

taxes.id.json.get

Retrieve a single Tax information.

jumpseller.taxes.id.json.get({
  "login": "",
  "authtoken": "",
  "id": 0
}, context)

Input

• input object
  • login required string: API OAuth login.
  • authtoken required string: API OAuth token.
  • id required integer: Id of the Tax

Output

• output Tax

Definitions

App

• App object
  • apps array
    • items AppFields

AppFields

• AppFields object
  • author string: Author of the app
  • code string: Code of the app
  • description string: Description of the app
  • js boolean: True if the app is a jsapp
  • name string: Name of the app
  • page string: Page of the app

Attachment

• Attachment object
  • attachment AttachmentFields

AttachmentEdit

• AttachmentEdit object
  • attachment AttachmentEditFields

AttachmentEditFields

• AttachmentEditFields object
  • filename string: Filename of the attachment (with file extensison)
  • url string: Public accessible URL with the desired file contents. (LIMIT: 100MB)

AttachmentFields

• AttachmentFields object
  • id integer: Unique identifier of the attachment
  • url string: Private URL of the attachment

BadParams

• BadParams object
  • message string

BillingAddress

• BillingAddress object
  • address string: Address of the Customer's Billing Address
  • city string: City of the Customer's Billing Address
  • country string: Country code of the Customer's Billing Address (ISO 3166-1 alpha-2)
  • municipality string: Municipality of the Customer's Billing Address
  • name string: Name of the Customer's Billing Address
  • postal string: Postal code of the Customer's Billing Address
  • region string: Region code of the Customer's Billing Address (Use the FIPS standard - http://www.geonames.org/countries/)
  • surname string: Surname of the Customer's Billing Address
  • taxid string: Tax id of the Customer's Billing Address

Category

• Category object
  • category CategoryFields

CategoryEdit

• CategoryEdit object
  • category CategoryEditFields

CategoryEditFields

• CategoryEditFields object
  • name string: Name of the Category
  • parent_id integer: Unique identifier of the Parent Category

CategoryFields

• CategoryFields object
  • id integer: Unique identifier of the Category
  • name string: Name of the Category
  • parent_id integer: Unique identifier of the Parent Category
  • permalink string: Category unique URL path

CheckoutCustomField

• CheckoutCustomField object
  • checkout_custom_field CheckoutCustomFieldFields

CheckoutCustomFieldEdit

• CheckoutCustomFieldEdit object
  • checkout_custom_field CheckoutCustomFieldEditFields

CheckoutCustomFieldEditFields

• CheckoutCustomFieldEditFields object
  • area string (values: contact, billing_shipping, other): Area of the CheckoutCustomField
  • custom_field_select_options array: The values for the CheckoutCustomField selection
    • items string
  • deletable boolean: True if the CheckoutCustomField can be removed from the store
  • label string: Label given to the CheckoutCustomField
  • position integer: Position of the CheckoutCustomField
  • required boolean: True if the CheckoutCustomField is mandatory
  • type string (values: text, select, input, checkbox, date): Type of the CheckoutCustomField

CheckoutCustomFieldFields

• CheckoutCustomFieldFields object
  • area string (values: contact, billing_shipping, other): Area of the CheckoutCustomField
  • custom_field_select_options array: The values for the CheckoutCustomField selection
    • items string
  • deletable boolean: True if the CheckoutCustomField can be removed from the store
  • id integer: Unique identifier of the CheckoutCustomField
  • label string: Label given to the CheckoutCustomField
  • position integer: Position of the CheckoutCustomField
  • required boolean: True if the CheckoutCustomField is mandatory
  • type string (values: text, select, input, checkbox): Type of the CheckoutCustomField

Count

• Count object
  • count integer

Country

• Country object
  • code string
  • name string

CustomField

• CustomField object
  • custom_field CustomFieldFields

CustomFieldEdit

• CustomFieldEdit object
  • custom_field CustomFieldEditFields

CustomFieldEditFields

• CustomFieldEditFields object
  • label string: Label given to the Custom Field
  • type string (values: text, selection, input): Type of the Custom Field
  • values array: All the possible Values of the Custom Field (for type 'selection')
    • items string

CustomFieldFields

• CustomFieldFields object
  • id integer: Unique identifier of the Custom Field
  • label string: Label given to the Custom Field
  • type string (values: text, selection, input): Type of the Custom Field
  • values array: All the possible Values of the Custom Field (for type 'sele