Apideck.Ecommerce

Class Name

EcommerceApi

Methods

List Customers
Get Customer
List Orders
Get Order
List Products
Get Product
Get Store

List Customers

Method: customersAll

ecommerceApi.customersAll(body)

Parameters

Name	Type	Description	Notes
raw	[boolean]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
consumerId	[string]	ID of the consumer which you want to get or push data from	(optional)
appId	[string]	The ID of your Unify application	(optional)
serviceId	[string]	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	(optional)
cursor	[string]	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.	(optional)
limit	[number]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20
filter	EcommerceCustomersFilter	Apply filters	(optional)
passThrough	PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads	(optional)
fields	[string]	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.	(optional)

Response Type

GetEcommerceCustomersResponse

HTTP response details

Status code	Description
200	Customers
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
});

const params = {}

try {
  const { data } = await apideck.ecommerce.customersAll(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

Get Customer

Method: customersOne

ecommerceApi.customersOne(body)

Parameters

Name	Type	Description	Notes
id	[string]	ID of the record you are acting upon.
consumerId	[string]	ID of the consumer which you want to get or push data from	(optional)
appId	[string]	The ID of your Unify application	(optional)
serviceId	[string]	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	(optional)
raw	[boolean]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
fields	[string]	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.	(optional)

Response Type

GetEcommerceCustomerResponse

HTTP response details

Status code	Description
200	Customers
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
});

const params = {
  id: 'id_example'
}

try {
  const { data } = await apideck.ecommerce.customersOne(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

List Orders

Method: ordersAll

ecommerceApi.ordersAll(body)

Parameters

Name	Type	Description	Notes
raw	[boolean]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
consumerId	[string]	ID of the consumer which you want to get or push data from	(optional)
appId	[string]	The ID of your Unify application	(optional)
serviceId	[string]	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	(optional)
cursor	[string]	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.	(optional)
limit	[number]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20
filter	EcommerceOrdersFilter	Apply filters	(optional)
sort	OrdersSort	Apply sorting	(optional)
passThrough	PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads	(optional)
fields	[string]	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.	(optional)

Response Type

GetEcommerceOrdersResponse

HTTP response details

Status code	Description
200	Orders
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
});

const params = {}

try {
  const { data } = await apideck.ecommerce.ordersAll(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

Get Order

Method: ordersOne

ecommerceApi.ordersOne(body)

Parameters

Name	Type	Description	Notes
id	[string]	ID of the record you are acting upon.
consumerId	[string]	ID of the consumer which you want to get or push data from	(optional)
appId	[string]	The ID of your Unify application	(optional)
serviceId	[string]	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	(optional)
raw	[boolean]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
fields	[string]	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.	(optional)

Response Type

GetEcommerceOrderResponse

HTTP response details

Status code	Description
200	Orders
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
});

const params = {
  id: 'id_example'
}

try {
  const { data } = await apideck.ecommerce.ordersOne(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

List Products

Method: productsAll

ecommerceApi.productsAll(body)

Parameters

Name	Type	Description	Notes
raw	[boolean]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
consumerId	[string]	ID of the consumer which you want to get or push data from	(optional)
appId	[string]	The ID of your Unify application	(optional)
serviceId	[string]	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	(optional)
cursor	[string]	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.	(optional)
limit	[number]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20
passThrough	PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads	(optional)
fields	[string]	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.	(optional)

Response Type

GetProductsResponse

HTTP response details

Status code	Description
200	Products
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
});

const params = {}

try {
  const { data } = await apideck.ecommerce.productsAll(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

Get Product

Method: productsOne

ecommerceApi.productsOne(body)

Parameters

Name	Type	Description	Notes
id	[string]	ID of the record you are acting upon.
consumerId	[string]	ID of the consumer which you want to get or push data from	(optional)
appId	[string]	The ID of your Unify application	(optional)
serviceId	[string]	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	(optional)
raw	[boolean]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
fields	[string]	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.	(optional)

Response Type

GetProductResponse

HTTP response details

Status code	Description
200	Products
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
});

const params = {
  id: 'id_example'
}

try {
  const { data } = await apideck.ecommerce.productsOne(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

Get Store

Method: storesOne

ecommerceApi.storesOne(body)

Parameters

Name	Type	Description	Notes
consumerId	[string]	ID of the consumer which you want to get or push data from	(optional)
appId	[string]	The ID of your Unify application	(optional)
serviceId	[string]	Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API.	(optional)
raw	[boolean]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
fields	[string]	The 'fields' parameter allows API users to specify the fields they want to include in the API response. If this parameter is not present, the API will return all available fields. If this parameter is present, only the fields specified in the comma-separated string will be included in the response. Nested properties can also be requested by using a dot notation. Example: `fields=name,email,addresses.city` In the example above, the response will only include the fields "name", "email" and "addresses.city". If any other fields are available, they will be excluded.	(optional)

Response Type

GetStoreResponse

HTTP response details

Status code	Description
200	Stores
400	Bad Request
401	Unauthorized
402	Payment Required
404	The specified resource was not found
422	Unprocessable
4/5xx	Unexpected error

Example Usage

import { Apideck } from '@apideck/node';

const apideck = new Apideck({
  apiKey: 'REPLACE_WITH_API_KEY',
  appId: 'REPLACE_WITH_APP_ID',
  consumerId: 'REPLACE_WITH_CONSUMER_ID'
});

const params = {}

try {
  const { data } = await apideck.ecommerce.storesOne(params)
  console.log('API called successfully', data)
} catch (error) {
  console.error(error)
  return error.json()
}

[Back to top] [Back to API list] [Back to README]

Files

EcommerceApi.md

Latest commit

History

EcommerceApi.md

File metadata and controls

Apideck.Ecommerce

Class Name

Methods

List Customers

Parameters

Response Type

HTTP response details

Example Usage

Get Customer

Parameters

Response Type

HTTP response details

Example Usage

List Orders

Parameters

Response Type

HTTP response details

Example Usage

Get Order

Parameters

Response Type

HTTP response details

Example Usage

List Products

Parameters

Response Type

HTTP response details

Example Usage

Get Product

Parameters

Response Type

HTTP response details

Example Usage

Get Store

Parameters

Response Type

HTTP response details

Example Usage