Commerce7

The Commerce7 Developer Hub

Welcome to the Commerce7 developer hub. You'll find comprehensive guides and documentation to help you start working with Commerce7 as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Getting Started with Commerce7

This page will help you get started with Commerce7. You'll be up and running in a jiffy!

Base URL

Authentication

You connect to Commerce7 Rest APIs using basic auth. To obtain a username and password, you need to request a current admin to send you an invite. The username is required to be an email address and you configure the password when you receive the invite email.

Link to documentation to invite a new user / API user.
https://documentation.commerce7.com/settings/accounts/how-to-invite-staff-members

**Note a specific permission "Data role" is required to enable API access to migrate historical data to Commerce7 and retain the existing primary key, createdAt and updatedAt fields, for Customers, Customer Addresses, Customer Credit Card Tokens, Clubs, Club Memberships, Notes, Orders and Products. To request this Data role to be enabled for your API user, please email jason@commerce7.com and provide the Tenant and the API user email address that needs the role to be set.

Requests

The tenant is required to be sent with every API request as a header field. You can obtain the tenant from logging into the Commerce7 Admin using your API credentials at the following link https://platform.commerce7.com.

The tenant is the first part of the URL when you are logged into the admin interface.

Example:
https:// spectrawinery.admin.platform.commerce7.com

Header     Value
tenant       spectrawinery

Pagination

All get requests for lists have a limit of 50 records per page, you can add a query param
?limit=n where n is between 1 and 50 to retrieve less records per page if you choose. The response is an object with an array of the objects your listing and a total, which is the total record count.

To request the next page pass in a query param ?page=n

Request:
https://api.commerce7.com/beta/customer?page=1&limit=10

Response:
{
    "customers": [
        { .... customer objects .... }
    ],
    "total": 79318
}

Total requests you need to make to retrieve all data: 79318 / 10 = 7932

Data formats

All currency amounts are stored in Commerce7 in cents. eg. If you pass in a request to update a product price to $100.00 the amount should be sent as 10000.

Dates are all stored in UTC time. If the system you are integrating works in a timezone other than UTC you will need to convert the time for your requests and responses to UTC time.

Throttle Limits

API throttle limits are 100 requests per minute, based IP address. Future updates will include limits based on API user and tenant, and may provide burst capability with exponential backoff.