retailCRM PHP API client
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo

Namespaces

  • RetailCrm
    • Exception
    • Http
    • Response

Classes

  • ApiClient

Class ApiClient

retailCRM API client class

Namespace: RetailCrm
Located at RetailCrm/ApiClient.php

Methods summary

public mixed
# __construct( string $url, string $apiKey )

Client creating

Client creating

Parameters

$url
$apiKey

Returns

mixed
public RetailCrm\Response\ApiResponse
# ordersCreate( array $order )

Create a order

Create a order

Parameters

$order

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# ordersEdit( array $order, mixed $by = 'externalId' )

Edit a order

Edit a order

Parameters

$order
$by

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# ordersUpload( array $orders )

Upload array of the orders

Upload array of the orders

Parameters

$orders

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# ordersGet( string $id, string $by = 'externalId' )

Get order by id or externalId

Get order by id or externalId

Parameters

$id
$by
(default: 'externalId')

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# ordersHistory( DateTime $startDate = null, DateTime $endDate = null, integer $limit = 100, integer $offset = 0, boolean $skipMyChanges = true )

Returns a orders history

Returns a orders history

Parameters

$startDate
(default: null)
$endDate
(default: null)
$limit
(default: 100)
$offset
(default: 0)
$skipMyChanges
(default: true)

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# ordersList( array $filter = array(), integer $page = null, integer $limit = null )

Returns filtered orders list

Returns filtered orders list

Parameters

$filter
(default: array())
$page
(default: null)
$limit
(default: null)

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# ordersFixExternalIds( array $ids )

Save order IDs' (id and externalId) association in the CRM

Save order IDs' (id and externalId) association in the CRM

Parameters

$ids

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# customersCreate( array $customer )

Create a customer

Create a customer

Parameters

$customer

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# customersEdit( array $customer, mixed $by = 'externalId' )

Edit a customer

Edit a customer

Parameters

$customer
$by

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# customersUpload( array $customers )

Upload array of the customers

Upload array of the customers

Parameters

$customers

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# customersGet( string $id, string $by = 'externalId' )

Get customer by id or externalId

Get customer by id or externalId

Parameters

$id
$by
(default: 'externalId')

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# customersList( array $filter = array(), integer $page = null, integer $limit = null )

Returns filtered customers list

Returns filtered customers list

Parameters

$filter
(default: array())
$page
(default: null)
$limit
(default: null)

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# customersFixExternalIds( array $ids )

Save customer IDs' (id and externalId) association in the CRM

Save customer IDs' (id and externalId) association in the CRM

Parameters

$ids

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# deliveryServicesList( )

Returns deliveryServices list

Returns deliveryServices list

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# deliveryTypesList( )

Returns deliveryTypes list

Returns deliveryTypes list

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# orderMethodsList( )

Returns orderMethods list

Returns orderMethods list

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# orderTypesList( )

Returns orderTypes list

Returns orderTypes list

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# paymentStatusesList( )

Returns paymentStatuses list

Returns paymentStatuses list

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# paymentTypesList( )

Returns paymentTypes list

Returns paymentTypes list

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# productStatusesList( )

Returns productStatuses list

Returns productStatuses list

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# statusGroupsList( )

Returns statusGroups list

Returns statusGroups list

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# statusesList( )

Returns statuses list

Returns statuses list

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# deliveryServicesEdit( array $data )

Edit deliveryService

Edit deliveryService

Parameters

$data
delivery service data

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# deliveryTypesEdit( array $data )

Edit deliveryType

Edit deliveryType

Parameters

$data
delivery type data

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# orderMethodsEdit( array $data )

Edit orderMethod

Edit orderMethod

Parameters

$data
order method data

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# orderTypesEdit( array $data )

Edit orderType

Edit orderType

Parameters

$data
order type data

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# paymentStatusesEdit( array $data )

Edit paymentStatus

Edit paymentStatus

Parameters

$data
payment status data

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# paymentTypesEdit( array $data )

Edit paymentType

Edit paymentType

Parameters

$data
payment type data

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# productStatusesEdit( array $data )

Edit productStatus

Edit productStatus

Parameters

$data
product status data

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# statusesEdit( array $data )

Edit order status

Edit order status

Parameters

$data
status data

Returns

RetailCrm\Response\ApiResponse
public RetailCrm\Response\ApiResponse
# statisticUpdate( )

Update CRM basic statistic

Update CRM basic statistic

Returns

RetailCrm\Response\ApiResponse
protected boolean
# checkIdParameter( string $by )

Check ID parameter

Check ID parameter

Parameters

$by

Returns

boolean

Magic methods summary

Constants summary

string VERSION
# 'v3'

Properties summary

protected mixed $client
#
retailCRM PHP API client API documentation generated by ApiGen