Apideck.Pos

Class Name

PosApi

Methods

Create Item
List Items
Delete Item
Get Item
Update Item
Create Location
List Locations
Delete Location
Get Location
Update Location
Create Merchant
List Merchants
Delete Merchant
Get Merchant
Update Merchant
Create Modifier Group
List Modifier Groups
Delete Modifier Group
Get Modifier Group
Update Modifier Group
Create Modifier
List Modifiers
Delete Modifier
Get Modifier
Update Modifier
Create Order Type
List Order Types
Delete Order Type
Get Order Type
Update Order Type
Create Order
List Orders
Delete Order
Get Order
Pay Order
Update Order
Create Payment
List Payments
Delete Payment
Get Payment
Update Payment
Create Tender
List Tenders
Delete Tender
Get Tender
Update Tender

Create Item

Method: itemsAdd

Apideck->getPosApi()->itemsAdd($data)

Parameters

Name	Type	Description	Notes
item	\Apideck\Client\Model\Item
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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\CreateItemResponse

HTTP response details

Status code	Description
201	Items
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->getPosApi()->itemsAdd($item);
  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 Items

Method: itemsAll

Apideck->getPosApi()->itemsAll($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.
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\GetItemsResponse

HTTP response details

Status code	Description
200	Items
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->getPosApi()->itemsAll();
  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]

Delete Item

Method: itemsDelete

Apideck->getPosApi()->itemsDelete($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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\DeleteItemResponse

HTTP response details

Status code	Description
200	Items
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->getPosApi()->itemsDelete('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 Item

Method: itemsOne

Apideck->getPosApi()->itemsOne($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\GetItemResponse

HTTP response details

Status code	Description
200	Items
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->getPosApi()->itemsOne('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]

Update Item

Method: itemsUpdate

Apideck->getPosApi()->itemsUpdate($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
item	\Apideck\Client\Model\Item
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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\UpdateItemResponse

HTTP response details

Status code	Description
200	Items
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->getPosApi()->itemsUpdate('id_example', $item);
  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]

Create Location

Method: locationsAdd

Apideck->getPosApi()->locationsAdd($data)

Parameters

Name	Type	Description	Notes
location	\Apideck\Client\Model\Location
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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\CreateLocationResponse

HTTP response details

Status code	Description
201	Locations
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->getPosApi()->locationsAdd($location);
  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 Locations

Method: locationsAll

Apideck->getPosApi()->locationsAll($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.
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\GetLocationsResponse

HTTP response details

Status code	Description
200	Locations
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->getPosApi()->locationsAll();
  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]

Delete Location

Method: locationsDelete

Apideck->getPosApi()->locationsDelete($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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\DeleteLocationResponse

HTTP response details

Status code	Description
200	Locations
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->getPosApi()->locationsDelete('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 Location

Method: locationsOne

Apideck->getPosApi()->locationsOne($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\GetLocationResponse

HTTP response details

Status code	Description
200	Locations
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->getPosApi()->locationsOne('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]

Update Location

Method: locationsUpdate

Apideck->getPosApi()->locationsUpdate($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
location	\Apideck\Client\Model\Location
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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\UpdateLocationResponse

HTTP response details

Status code	Description
200	Locations
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->getPosApi()->locationsUpdate('id_example', $location);
  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]

Create Merchant

Method: merchantsAdd

Apideck->getPosApi()->merchantsAdd($data)

Parameters

Name	Type	Description	Notes
merchant	\Apideck\Client\Model\Merchant
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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\CreateMerchantResponse

HTTP response details

Status code	Description
201	Merchants
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->getPosApi()->merchantsAdd($merchant);
  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 Merchants

Method: merchantsAll

Apideck->getPosApi()->merchantsAll($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.
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\GetMerchantsResponse

HTTP response details

Status code	Description
200	Merchants
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->getPosApi()->merchantsAll();
  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]

Delete Merchant

Method: merchantsDelete

Apideck->getPosApi()->merchantsDelete($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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\DeleteMerchantResponse

HTTP response details

Status code	Description
200	Merchants
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->getPosApi()->merchantsDelete('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 Merchant

Method: merchantsOne

Apideck->getPosApi()->merchantsOne($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\GetMerchantResponse

HTTP response details

Status code	Description
200	Merchants
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->getPosApi()->merchantsOne('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]

Update Merchant

Method: merchantsUpdate

Apideck->getPosApi()->merchantsUpdate($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
merchant	\Apideck\Client\Model\Merchant
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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\UpdateMerchantResponse

HTTP response details

Status code	Description
200	Merchants
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->getPosApi()->merchantsUpdate('id_example', $merchant);
  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]

Create Modifier Group

Method: modifierGroupsAdd

Apideck->getPosApi()->modifierGroupsAdd($data)

Parameters

Name	Type	Description	Notes
modifier_group	\Apideck\Client\Model\ModifierGroup
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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\CreateModifierGroupResponse

HTTP response details

Status code	Description
201	ModifierGroups
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->getPosApi()->modifierGroupsAdd($modifierGroup);
  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 Modifier Groups

Method: modifierGroupsAll

Apideck->getPosApi()->modifierGroupsAll($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.
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\GetModifierGroupsResponse

HTTP response details

Status code	Description
200	ModifierGroups
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->getPosApi()->modifierGroupsAll();
  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]

Delete Modifier Group

Method: modifierGroupsDelete

Apideck->getPosApi()->modifierGroupsDelete($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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\DeleteModifierGroupResponse

HTTP response details

Status code	Description
200	ModifierGroups
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->getPosApi()->modifierGroupsDelete('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 Modifier Group

Method: modifierGroupsOne

Apideck->getPosApi()->modifierGroupsOne($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\GetModifierGroupResponse

HTTP response details

Status code	Description
200	ModifierGroups
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->getPosApi()->modifierGroupsOne('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]

Update Modifier Group

Method: modifierGroupsUpdate

Apideck->getPosApi()->modifierGroupsUpdate($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
modifier_group	\Apideck\Client\Model\ModifierGroup
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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\UpdateModifierGroupResponse

HTTP response details

Status code	Description
200	ModifierGroups
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->getPosApi()->modifierGroupsUpdate('id_example', $modifierGroup);
  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]

Create Modifier

Method: modifiersAdd

Apideck->getPosApi()->modifiersAdd($data)

Parameters

Name	Type	Description	Notes
modifier	\Apideck\Client\Model\Modifier
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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\CreateModifierResponse

HTTP response details

Status code	Description
201	Modifiers
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->getPosApi()->modifiersAdd($modifier);
  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 Modifiers

Method: modifiersAll

Apideck->getPosApi()->modifiersAll($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.
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\GetModifiersResponse

HTTP response details

Status code	Description
200	Modifiers
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->getPosApi()->modifiersAll();
  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]

Delete Modifier

Method: modifiersDelete

Apideck->getPosApi()->modifiersDelete($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.
filter	\Apideck\Client\Model\ModifierGroupFilter	Apply filters
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\DeleteModifierResponse

HTTP response details

Status code	Description
200	Modifiers
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->getPosApi()->modifiersDelete('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 Modifier

Method: modifiersOne

Apideck->getPosApi()->modifiersOne($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.
filter	\Apideck\Client\Model\ModifierGroupFilter	Apply filters
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\GetModifierResponse

HTTP response details

Status code	Description
200	Modifiers
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->getPosApi()->modifiersOne('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]

Update Modifier

Method: modifiersUpdate

Apideck->getPosApi()->modifiersUpdate($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
modifier	\Apideck\Client\Model\Modifier
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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\UpdateModifierResponse

HTTP response details

Status code	Description
200	Modifiers
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->getPosApi()->modifiersUpdate('id_example', $modifier);
  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]

Create Order Type

Method: orderTypesAdd

Apideck->getPosApi()->orderTypesAdd($data)

Parameters

Name	Type	Description	Notes
order_type	\Apideck\Client\Model\OrderType
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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\CreateOrderTypeResponse

HTTP response details

Status code	Description
201	OrderTypes
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->getPosApi()->orderTypesAdd($orderType);
  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 Order Types

Method: orderTypesAll

Apideck->getPosApi()->orderTypesAll($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.
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\GetOrderTypesResponse

HTTP response details

Status code	Description
200	OrderTypes
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->getPosApi()->orderTypesAll();
  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]

Delete Order Type

Method: orderTypesDelete

Apideck->getPosApi()->orderTypesDelete($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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\DeleteOrderTypeResponse

HTTP response details

Status code	Description
200	OrderTypes
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->getPosApi()->orderTypesDelete('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 Order Type

Method: orderTypesOne

Apideck->getPosApi()->orderTypesOne($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\GetOrderTypeResponse

HTTP response details

Status code	Description
200	OrderTypes
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->getPosApi()->orderTypesOne('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]

Update Order Type

Method: orderTypesUpdate

Apideck->getPosApi()->orderTypesUpdate($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
order_type	\Apideck\Client\Model\OrderType
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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\UpdateOrderTypeResponse

HTTP response details

Status code	Description
200	OrderTypes
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->getPosApi()->orderTypesUpdate('id_example', $orderType);
  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]

Create Order

Method: ordersAdd

Apideck->getPosApi()->ordersAdd($data)

Parameters

Name	Type	Description	Notes
order	\Apideck\Client\Model\Order
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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\CreateOrderResponse

HTTP response details

Status code	Description
201	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->getPosApi()->ordersAdd($order);
  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->getPosApi()->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.
location_id	string	ID of the location.
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\GetOrdersResponse

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->getPosApi()->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]

Delete Order

Method: ordersDelete

Apideck->getPosApi()->ordersDelete($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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\DeleteOrderResponse

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->getPosApi()->ordersDelete('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 Order

Method: ordersOne

Apideck->getPosApi()->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\GetOrderResponse

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->getPosApi()->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]

Pay Order

Method: ordersPay

Apideck->getPosApi()->ordersPay($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
order	\Apideck\Client\Model\Order
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\CreateOrderResponse

HTTP response details

Status code	Description
201	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->getPosApi()->ordersPay('id_example', $order);
  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]

Update Order

Method: ordersUpdate

Apideck->getPosApi()->ordersUpdate($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
order	\Apideck\Client\Model\Order
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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\UpdateOrderResponse

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->getPosApi()->ordersUpdate('id_example', $order);
  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]

Create Payment

Method: paymentsAdd

Apideck->getPosApi()->paymentsAdd($data)

Parameters

Name	Type	Description	Notes
pos_payment	\Apideck\Client\Model\PosPayment
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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\CreatePosPaymentResponse

HTTP response details

Status code	Description
201	PosPayments
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->getPosApi()->paymentsAdd($payment);
  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 Payments

Method: paymentsAll

Apideck->getPosApi()->paymentsAll($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.
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\GetPosPaymentsResponse

HTTP response details

Status code	Description
200	PosPayments
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->getPosApi()->paymentsAll();
  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]

Delete Payment

Method: paymentsDelete

Apideck->getPosApi()->paymentsDelete($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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\DeletePosPaymentResponse

HTTP response details

Status code	Description
200	PosPayments
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->getPosApi()->paymentsDelete('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 Payment

Method: paymentsOne

Apideck->getPosApi()->paymentsOne($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\GetPosPaymentResponse

HTTP response details

Status code	Description
200	PosPayments
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->getPosApi()->paymentsOne('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]

Update Payment

Method: paymentsUpdate

Apideck->getPosApi()->paymentsUpdate($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
pos_payment	\Apideck\Client\Model\PosPayment
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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\UpdatePosPaymentResponse

HTTP response details

Status code	Description
200	PosPayments
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->getPosApi()->paymentsUpdate('id_example', $payment);
  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]

Create Tender

Method: tendersAdd

Apideck->getPosApi()->tendersAdd($data)

Parameters

Name	Type	Description	Notes
tender	\Apideck\Client\Model\Tender
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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\CreateTenderResponse

HTTP response details

Status code	Description
201	Tenders
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->getPosApi()->tendersAdd($tender);
  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 Tenders

Method: tendersAll

Apideck->getPosApi()->tendersAll($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.
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\GetTendersResponse

HTTP response details

Status code	Description
200	Tenders
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->getPosApi()->tendersAll();
  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]

Delete Tender

Method: tendersDelete

Apideck->getPosApi()->tendersDelete($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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\DeleteTenderResponse

HTTP response details

Status code	Description
200	Tenders
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->getPosApi()->tendersDelete('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 Tender

Method: tendersOne

Apideck->getPosApi()->tendersOne($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\GetTenderResponse

HTTP response details

Status code	Description
200	Tenders
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->getPosApi()->tendersOne('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]

Update Tender

Method: tendersUpdate

Apideck->getPosApi()->tendersUpdate($data)

Parameters

Name	Type	Description	Notes
id	string	ID of the record you are acting upon.
tender	\Apideck\Client\Model\Tender
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.
raw	[bool]	Include raw response. Mostly used for debugging purposes	(optional) defaults to false

Response Type

\Apideck\Client\Model\UpdateTenderResponse

HTTP response details

Status code	Description
200	Tenders
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->getPosApi()->tendersUpdate('id_example', $tender);
  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

PosApi.md

Latest commit

History

PosApi.md

File metadata and controls

Apideck.Pos

Class Name

Methods

Create Item

Parameters

Response Type

HTTP response details

Example Usage

List Items

Parameters

Response Type

HTTP response details

Example Usage

Delete Item

Parameters

Response Type

HTTP response details

Example Usage

Get Item

Parameters

Response Type

HTTP response details

Example Usage

Update Item

Parameters

Response Type

HTTP response details

Example Usage

Create Location

Parameters

Response Type

HTTP response details

Example Usage

List Locations

Parameters

Response Type

HTTP response details

Example Usage

Delete Location

Parameters

Response Type

HTTP response details

Example Usage

Get Location

Parameters

Response Type

HTTP response details

Example Usage

Update Location

Parameters

Response Type

HTTP response details

Example Usage

Create Merchant

Parameters

Response Type

HTTP response details

Example Usage

List Merchants

Parameters

Response Type

HTTP response details

Example Usage

Delete Merchant

Parameters

Response Type

HTTP response details

Example Usage

Get Merchant

Parameters

Response Type

HTTP response details

Example Usage

Update Merchant