Ecommerce API
Welcome to the Ecommerce API. You can use this API to access all Ecommerce API endpoints. Base URL The base URL for all API requests is…
Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.
Overview
Welcome to the Ecommerce API.
You can use this API to access all Ecommerce API endpoints.
Base URL
The base URL for all API requests is https://unify.apideck.com
Headers
Custom headers that are expected as part of the request. Note that RFC7230 states header names are case insensitive.
| Name | Type | Required | Description |
|---|---|---|---|
| x-apideck-consumer-id | String | Yes | The id of the customer stored inside Apideck Vault. This can be a user id, account id, device id or whatever entity that can have integration within your app. |
| x-apideck-service-id | String | No | Describe the service you want to call (e.g., pipedrive). Only needed when a customer has activated multiple integrations for the same Unified API. |
| x-apideck-app-id | String | Yes | The application id of your Unify application. Available at https://app.apideck.com/unify/api-keys. |
| Authorization | String | Yes | Bearer KEY |
Authorization
You can interact with the API through the authorization methods below.
-->
Pagination
All API resources have support for bulk retrieval via list APIs. Apideck uses cursor-based pagination via the optional cursor and limit parameters.
To fetch the first page of results, call the list API without a cursor parameter. Afterwards you can fetch subsequent pages by providing a cursor parameter. You will find the next cursor in the response body in meta.cursors.next. If meta.cursors.next is null you're at the end of the list.
In the REST API you can also use the links from the response for added convenience. Simply call the URL in links.next to get the next page of results.
Query Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| cursor | String | No | Cursor to start from. You can find cursors for next & previous pages in the meta.cursors property of the response. |
| limit | Number | No | Number of results to return. Minimum 1, Maximum 200, Default 20 |
Response Body
| Name | Type | Description |
|---|---|---|
| meta.cursors.previous | String | Cursor to navigate to the previous page of results through the API |
| meta.cursors.current | String | Cursor to navigate to the current page of results through the API |
| meta.cursors.next | String | Cursor to navigate to the next page of results through the API |
| meta.items_on_page | Number | Number of items returned in the data property of the response |
| links.previous | String | Link to navigate to the previous page of results through the API |
| links.current | String | Link to navigate to the current page of results through the API |
| links.next | String | Link to navigate to the next page of results through the API |
⚠️ meta.cursors.previous/links.previous is not available for all connectors.
SDKs and API Clients
We currently offer a Node.js, PHP, Python and .NET SDK.
Need another SDK? Request the SDK of your choice.
Debugging
Because of the nature of the abstraction we do in Apideck Unify we still provide the option to the receive raw requests and responses being handled underlying. By including the raw flag ?raw=true in your requests you can still receive the full request. Please note that this increases the response size and can introduce extra latency.
Errors
The API returns standard HTTP response codes to indicate success or failure of the API requests. For errors, we also return a customized error message inside the JSON response. You can see the returned HTTP status codes below.
| Code | Title | Description … |
Endpoints 7
Orders
- GETList Orders
/ecommerce/orders?raw=false&cursor=string&limit=20&filter={"email":"elon@musk.com","customer_id":"123","updated_since":"2020-09-30T07:43:32.000Z","created_since":"2020-09-30T07:43:32.000Z"}&sort={"by":"created_at","direction":"desc"}&pass_through={"search":"San Francisco"}&fields=id,updated_atList Orders - GETGet Order
/ecommerce/orders/:id?raw=false&fields=id,updated_atGet Order
Products
- GETList Products
/ecommerce/products?raw=false&cursor=string&limit=20&pass_through={"search":"San Francisco"}&fields=id,updated_at&filter={"name":"Product Name","updated_since":"2020-09-30T07:43:32.000Z","created_since":"2020-09-30T07:43:32.000Z"}List Products - GETGet Product
/ecommerce/products/:id?raw=false&fields=id,updated_atGet Product
Customers
- GETList Customers
/ecommerce/customers?raw=false&cursor=string&limit=20&filter={"email":"elon@musk.com","phone_number":"111-111-1111","customer_ids":"12345,67890","updated_since":"2020-09-30T07:43:32.000Z","created_since":"2020-09-30T07:43:32.000Z"}&pass_through={"search":"San Francisco"}&fields=id,updated_atList Customers - GETGet Customer
/ecommerce/customers/:id?raw=false&fields=id,updated_atGet Customer
Stores
- GETGet Store
/ecommerce/store?raw=false&fields=id,updated_atGet Store
API details
- Base URL
https://unify.apideck.com- Authentication
- An API key in the Authorization header
- Operations
- 7 operations on 7 pathsGET 7
- Main resources
- Customers 2Orders 2Products 2Stores 1
- Description format
- OpenAPI 3.0.0, API version
10.83.0 - Links
- Documentation · OpenAPI document · Support
How to test the Ecommerce API in Swastik Codes
- Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
- Fork it into your workspaceChoose a workspace. You get your own copy of the Ecommerce API collection, without the publisher's secrets.
- Add your credentialsThis API uses an API key in the Authorization header. Add yours in the collection's variables or an environment; the requests already reference it.
- Send a requestPick an endpoint, for example “List Orders” (GET /ecommerce/orders?raw=false&cursor=string&limit=20&filter={"email":"elon@musk.com","customer_id":"123","updated_since":"2020-09-30T07:43:32.000Z","created_since":"2020-09-30T07:43:32.000Z"}&sort={"by":"created_at","direction":"desc"}&pass_through={"search":"San Francisco"}&fields=id,updated_at), and press Send. Check the response, add tests and run the whole collection with the runner.
Frequently asked questions
What is the Ecommerce API?
Welcome to the Ecommerce API. You can use this API to access all Ecommerce API endpoints. Base URL The base URL for all API requests is… It is listed under Developer tools and has 7 endpoints.
Who publishes the Ecommerce API?
It is listed from Apideck's public API description (an OpenAPI document), not published by Apideck on Swastik Codes. Anyone who controls apideck.com can claim the profile by adding a DNS TXT record.
What is the base URL of the Ecommerce API?
Requests go to https://unify.apideck.com. Endpoint paths are added to this base URL.
How do I authenticate with the Ecommerce API?
With an API key in the Authorization header.
How many endpoints does the Ecommerce API have?
7 operations on 7 paths (7 GET). The largest groups are Customers, Orders, Products, Stores.
Is forking the Ecommerce API free?
Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.