Apideck.Ecommerce

Class Name

EcommerceApi

Methods

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

List Customers

Method: customersAll

Apideck->getEcommerceApi()->customersAll($data)

Parameters

Name	Type	Description	Notes
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
cursor	string	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
filter	\Apideck\Client\Model\EcommerceCustomersFilter	Apply filters
pass_through	\Apideck\Client\Model\PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
limit	[int]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20

Response Type

\Apideck\Client\Model\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

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getEcommerceApi()->customersAll();
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Get Customer

Method: customersOne

Apideck->getEcommerceApi()->customersOne($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\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

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getEcommerceApi()->customersOne('id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

List Orders

Method: ordersAll

Apideck->getEcommerceApi()->ordersAll($data)

Parameters

Name	Type	Description	Notes
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
cursor	string	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
filter	\Apideck\Client\Model\EcommerceOrdersFilter	Apply filters
sort	\Apideck\Client\Model\OrdersSort	Apply sorting
pass_through	\Apideck\Client\Model\PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
limit	[int]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20

Response Type

\Apideck\Client\Model\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

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getEcommerceApi()->ordersAll();
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Get Order

Method: ordersOne

Apideck->getEcommerceApi()->ordersOne($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\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

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getEcommerceApi()->ordersOne('id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

List Products

Method: productsAll

Apideck->getEcommerceApi()->productsAll($data)

Parameters

Name	Type	Description	Notes
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
cursor	string	Cursor to start from. You can find cursors for next/previous pages in the meta.cursors property of the response.
pass_through	\Apideck\Client\Model\PassThroughQuery	Optional unmapped key/values that will be passed through to downstream as query parameters. Ie: ?pass_through[search]=leads becomes ?search=leads
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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false
limit	[int]	Number of results to return. Minimum 1, Maximum 200, Default 20	(optional) defaults to 20

Response Type

\Apideck\Client\Model\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

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getEcommerceApi()->productsAll();
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Get Product

Method: productsOne

Apideck->getEcommerceApi()->productsOne($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\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

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getEcommerceApi()->productsOne('id_example');
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

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

Get Store

Method: storesOne

Apideck->getEcommerceApi()->storesOne($data)

Parameters

Name	Type	Description	Notes
x_apideck_consumer_id	string	ID of the consumer which you want to get or push data from
x_apideck_app_id	string	The ID of your Unify application
x_apideck_service_id	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.
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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\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

<?php
require('vendor/autoload.php');

use Apideck\Client\Apideck;
use Apideck\Client\ApideckConfiguration;
use Apideck\Client\ApiException;

$config = new ApideckConfiguration('<insert-api-key-here>', '<insert-application-id-here>', '<insert-consumer-id-here>', '<insert-service-id-here>');

$apideck = new Apideck($config);

try {
  $response = $apideck->getEcommerceApi()->storesOne();
  var_dump('API called successfully', $response);
} catch(ApiException $error) {
  var_dump('API called failed', $error);
}

[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