RetailCRM REST API

https://help.retailcrm.pro/api_v5_en.html
Admin
RetailCRM REST API provides endpoints for managing customer data, orders, costs, and other...
Tokens:221,814
Snippets:819
Trust Score:7.1
Update:1 month ago
Show doc for...
Tokens:
Raw
### GET {configUrl}

Source: https://help.retailcrm.pro/api_v5_en.html

Callback to get connection configuration. Called before connecting the module.

```APIDOC
## GET {configUrl}

### Description
Callback to get connection configuration. Called before connecting the module. `{configUrl}` is the "URL to request a simple connection configuration" from the partner account.

### Method
GET

### Endpoint
{configUrl}

### Response
#### Success Response (200)
- **success** (boolean) - Query result (successful/unsuccessful)
- **scopes[]** (array of strings) - Permissions required by the API key for the operation of the module
- **registerUrl** (string) - URL to register the module

#### Response Example
{
  "success": true,
  "scopes": ["string"],
  "registerUrl": "string"
}
```

--------------------------------

### GET {integrationModule["baseUrl"]}/{integrationModule["integrations"]["delivery"]["actions"]["get"]}

Source: https://help.retailcrm.pro/api_v5_en.html

Callback for getting delivery data. The system initiates a GET request to the configured get action URL.

```APIDOC
## GET {integrationModule["baseUrl"]}/{integrationModule["integrations"]["delivery"]["actions"]["get"]}

### Description
Getting the delivery data. For getting delivery data the system initiates GET-request of method specified in `integrationModule[integrations][delivery]["actions"]["get"]` configuration.

### Method
GET

### Endpoint
{integrationModule["baseUrl"]}/{integrationModule["integrations"]["delivery"]["actions"]["get"]}

### Parameters
#### Query Parameters
- **clientId** (string) - Required - Client ID in external service
- **deliveryId** (string) - Required - Delivery ID in delivery service

### Response
#### Success Response
- **success** (boolean) - Query result (successful/unsuccessful)
- **result** (object (ResponseLoadDeliveryData)) - Delivery data
- **result[trackNumber]** (string) - Track number (if option `configuration[allowTrackNumber]` is enabled)
- **result[cost]** (float) - Cost
- **result[shipmentDate]** (DateTime) - Shipment date
- **result[deliveryDate]** (DateTime) - Delivery date
- **result[deliveryTime]** (object (TimeInterval)) - Delivery time

```

--------------------------------

### GET /api/v5/offers

Source: https://help.retailcrm.pro/api_v5_en.html

Documentation for the GET /api/v5/offers endpoint, including query parameters for filtering and pagination, and the response structure.

```APIDOC
## GET /api/v5/offers

### Description
Retrieves a list of offers (SKUs) with optional filtering and pagination.

### Method
GET

### Endpoint
/api/v5/offers

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Quantity of elements in the answer (20 by default). Allowed values: 20, 50, 100.
- **page** (integer) - Optional - Number of page with the results (1 by default). Must be >= 1.
- **filter[ids][]** (array of integers) - Optional - Array of offer IDs.
- **filter[externalIds][]** (array of strings) - Optional - Array of external IDs.
- **filter[xmlIds][]** (array of strings) - Optional - Array of XML IDs.
- **filter[articles][]** (array of strings) - Optional - Array of articles.
- **filter[name]** (string) - Optional - Name/article of the product or article/barcode of the offer. Max length: 255.
- **filter[sites][]** (array of strings) - Optional - Array of store codes.
- **filter[catalogs][]** (array of integers) - Optional - Array of catalog IDs.
- **filter[groups][]** (array of integers) - Optional - Array of product or service group IDs.
- **filter[priceType]** (string) - Optional - Price type.
- **filter[active]** (boolean) - Optional - Activity. Allowed values: 1.
- **filter[properties][]** (array) - Optional - Offer properties.
- **filter[sinceId]** (integer) - Optional - Starting with the offer ID. Range: 0 to 2147483647.
- **filter[minPrice]** (integer) - Optional - Offer price (from).
- **filter[maxPrice]** (integer) - Optional - Offer price (to).
- **filter[minQuantity]** (integer) - Optional - Offer quantity (from).
- **filter[maxQuantity]** (integer) - Optional - Offer quantity (to).

### Response
#### Success Response (200)
- **success** (boolean) - Query result (successful/unsuccessful).
- **pagination** (object) - Pagination.
- **pagination[limit]** (integer) - Quantity of elements in the answer.
- **pagination[totalCount]** (integer) - Total quantity of found elements.
- **pagination[currentPage]** (integer) - Current issuance page.
- **pagination[totalPageCount]** (integer) - Total quantity of issuance pages.
- **offers[]** (array of objects) - SKU.
- **offers[][images][]** (array of strings) - Images URL.
- **offers[][id]** (integer) - SKU ID.
- **offers[][externalId]** (string) - SKU ID in store.
- **offers[][xmlId]** (string) - SKU ID in the warehouse system.
- **offers[][site]** (string) - Deprecated. Store. Use `getCatalog()`.
- **offers[][name]** (string) - Name.
- **offers[][article]** (string) - Vendor code.
- **offers[][prices][]** (array of objects) - Available prices.
- **offers[][prices][][priceType]** (string) - Price type.
- **offers[][prices][][currency]** (string) - Currency.
```

--------------------------------

### GET {integrationModule["baseUrl"]}/{integrationModule["integrations"]["recommendation"]["actions"]["recommendation"]}

Source: https://help.retailcrm.pro/api_v5_en.html

Recommended products request. The system initiates a GET request to the specified URL, passing product identifiers and recommendation type. The response contains a list of product identifiers and the field name for identification.

```APIDOC
## [GET] {integrationModule["baseUrl"]}/{integrationModule["integrations"]["recommendation"]["actions"]["recommendation"]}

### Description
Recommended products request. To receive a list of recommendations the system initiates a GET method request, which is specified in `integrationModule[integrations][recommendation]["actions"]["recommendation"]`. The system transmits the product identifiers and the type of requested recommendations. In response the system expects to receive a list of product identifiers and the field name for identification.

### Method
GET

### Endpoint
{integrationModule["baseUrl"]}/{integrationModule["integrations"]["recommendation"]["actions"]["recommendation"]}

### Parameters
#### Query Parameters
- **clientId** (string) - Client ID in external service
- **ids[]** (array of integers) - Products ID
- **externalIds[]** (array of strings) - Products external ID
- **mode** (string) - Recommendations type: products "Buying with" and products "Analogs". Possible values `buying_with`, `analogs`

### Response
#### Success Response
- **by** (string) - field name for product identification. Possible values id, externalId
- **ids[]** (array of strings) - Array with products identifications
```

--------------------------------

### GET /api/v5/loyalty/loyalties

Source: https://help.retailcrm.pro/api_v5_en.html

Documentation for the GET /api/v5/loyalty/loyalties endpoint that lists loyalty programs.

```APIDOC
## GET /api/v5/loyalty/loyalties

### Description
List of loyalty programs. Returns a list of loyalty programs. Requires the `loyalty_read` permission.

### Method
GET

### Endpoint
/api/v5/loyalty/loyalties

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Quantity of elements in the answer (20 by default). Allowed values: 20, 50, 100.
- **page** (integer) - Optional - Number of page with the results (1 by default). Must be >= 1.
- **filter** (object) - Optional - Filter object.
- **filter[ids][]** (array of integers) - Optional - Array ID of loyalty programs.
- **filter[sites][]** (array of strings) - Optional - Stores.
- **filter[active]** (boolean) - Optional - Activity.
- **filter[blocked]** (boolean) - Optional - Blocked.

### Response
#### Success Response (200)
- **success** (boolean) - Query result (successful/unsuccessful).
- **pagination** (object) - Pagination.
- **pagination[limit]** (integer) - Quantity of elements in the answer.
- **pagination[totalCount]** (integer) - Total quantity of found elements.
- **pagination[currentPage]** (integer) - Current issuance page.
- **pagination[totalPageCount]** (integer) - Total quantity of issuance pages.
- **loyalties[]** (array of objects) - Loyalty program.
- **loyalties[][levels][]** (array of objects) - Loyalty levels.
- **loyalties[][levels][][type]** (string) - Level type. Possible values: `bonus_converting`, `bonus_percent`, `discount`.
- **loyalties[][levels][][id]** (integer) - Level ID.
- **loyalties[][levels][][name]** (string) - Level name.
- **loyalties[][levels][][sum]** (custom handler result for (int)) - The sum required to go to this level (in entity currency).
```

--------------------------------

### POST /api/v5/store/products/batch/create

Source: https://help.retailcrm.pro/api_v5_en.html

Documentation for the POST /api/v5/store/products/batch/create endpoint, which allows batch creation of products and services.

```APIDOC
## POST /api/v5/store/products/batch/create

### Description
Batch adding of products and services. Requires the `store_write` permission. Up to 50 products can be transferred per request. The `type` parameter determines whether a product or service is created. Each product must have `name` and `catalogId`. Product groups must have either `id` or `externalId`. For services, fields `manufacturer`, `markable`, and `markingProvider` are ignored.

### Method
POST

### Endpoint
/api/v5/store/products/batch/create

### Parameters
#### Request Body
- **products[]** (array of objects (ProductCreateInput)) - Required - Array of products to create.
- **products[][type]** (string) - Optional - Type: `product` or `service`. Default is `product`.
- **products[][catalogId]** (integer) - Required - Catalog ID.
- **products[][article]** (string) - Optional - Vendor code.
- **products[][name]** (string) - Required - Name.
- **products[][url]** (string) - Optional - Link to item page in the web-store.
- **products[][imageUrl]** (string) - Optional - Image URL.
- **products[][description]** (string) - Optional - Description.
- **products[][popular]** (boolean) - Optional - Mark Sales leader.
- **products[][stock]** (boolean) - Optional - Mark Best price.
- **products[][novelty]** (boolean) - Optional - Mark New.
- **products[][recommended]** (boolean) - Optional - Mark Recommended.
- **products[][groups][]** (array of objects (ProductEditGroupInput)) - Optional - Item groups containing this item.
- **products[][groups][][externalId]** (string) - Optional - External ID of the product group.
- **products[][groups][][id]** (integer) - Optional - Product group ID.
- **products[][externalId]** (string) - Optional - Item external ID.
- **products[][manufacturer]** (string) - Optional - Manufacturer.
- **products[][active]** (boolean) - Optional - Activity.
- **products[][markable]** (boolean) - Optional - Deprecated. Subject to marking. Only responsible for the marking attribute under the "Chestny Znak" system.
- **products[][markingProvider]** (string) - Optional - Type of product marking. Possible values: `chestny_znak` for marking under the "Chestny Znak" system, `giis_dmdk` for marking under the "GIIS DMDK" system.

### Response
#### Success Response (200)
- **success** (boolean) - Query result (successful/unsuccessful).
- **processedProductsCount** (integer) - Number of successfully processed products.
- **addedProducts[]** (array of integers) - List of IDs of added products.

#### Response Example
{
  "success": true,
  "processedProductsCount": 2,
  "addedProducts": [123, 124]
}

### Error Responses
#### 400 Bad Request
- An error occurred while adding products or the array is too large.
```

--------------------------------

### GET {integrationModule["baseUrl"]}/{integrationModule["integrations"]["delivery"]["actions"]["autocomplete"]}

Source: https://help.retailcrm.pro/api_v5_en.html

Callback for getting data for autocomplete fields. The system initializes a GET request to the delivery service using the method specified in the `autocompleteUrl` configuration of the appropriate field.

```APIDOC
## GET {integrationModule["baseUrl"]}/{integrationModule["integrations"]["delivery"]["actions"]["autocomplete"]}

### Description
Callback for getting data for autocomplete fields. The system initializes a GET request to the delivery service using the method specified in the `autocompleteUrl` configuration of the appropriate field.

### Method
GET

### Endpoint
{integrationModule["baseUrl"]}/{integrationModule["integrations"]["delivery"]["actions"]["autocomplete"]}

### Parameters
#### Query Parameters
- **clientId** (string) - Required - Client ID in external service
- **term** (string) - Required - Request row

### Response
#### Success Response (200)
- **success** (boolean) - Query result (successful/unsuccessful)
- **result** (array of objects) - Array of values
  - **value** (string) - Value
  - **label** (string) - Name
  - **description** (string) - Optional - Hint for option
```

--------------------------------

### GET /api/v5/store/inventories

Source: https://help.retailcrm.pro/api_v5_en.html

Documentation for the GET /api/v5/store/inventories endpoint, including parameters and response notes.

```APIDOC
## GET /api/v5/store/inventories

### Description
Getting the leftover stocks and purchasing prices. Requires the `store_read` permission. Returns stock balance and cost price for SKUs, optionally with detailed elaboration and filtered by stores, products, and SKUs.

### Method
GET

### Endpoint
/api/v5/store/inventories

### Parameters
#### Query Parameters
- **limit** (choice) - Optional - Values: `{not blank}``[20|50|100|250]}`
- **page** (string) - Optional - Format: `{not blank}``{range: {>=1}}}`
- **filter** (object) - Optional - Type: `InventoryAlternativeFilterData`
- **filter[ids][]** (array of integers) - Optional - Array of SKU's ID
- **filter[sites][]** (array of strings) - Optional - Stores
- **filter[catalogs][]** (array of integers) - Optional - Array of catalog's ID
- **filter[productExternalId]** (string) - Optional - Format: `{length: {max: 255}}` - Product external ID
- **filter[productArticle][]** (array of strings) - Optional - Array of product articles
- **filter[productActive]** (boolean) - Optional - Return the stock balance only for active products
- **filter[offerExternalId][]** (array of strings) - Optional - Array of external IDs for SKUs
- **filter[offerXmlId][]** (array of strings) - Optional - Array of XML IDs for SKUs
- **filter[offerArticle][]** (array of strings) - Optional - Array of articles for SKUs
- **filter[offerActive]** (boolean) - Optional - Return the stock balance only for active SKUs
- **filter[details]** (boolean) - Optional - Return the details for stock balance
- **filter[productExternalIds][]** (array of strings) - Optional - Array of product external IDs

### Response
#### Success Response (200)
- **offers[][site]** - Returned only if data is returned by several stores

### Notes
- By default, information about both enabled and disabled products and SKUs is returned. Use `filter[productActive]=1` and `filter[offerActive]=1` to get only enabled ones.
- Data is returned by stores to which the API key has access, or by a specific store if `filter[sites][]=site-code` is specified.
```

--------------------------------

### POST {integrationModule["baseUrl"]}/{integrationModule["integrations"]["payment"]["actions"]["approve"]}

Source: https://help.retailcrm.pro/api_v5_en.html

Documentation for the payment confirmation callback endpoint, which is called by the system to confirm a payment at reserving.

```APIDOC
## POST {integrationModule["baseUrl"]}/{integrationModule["integrations"]["payment"]["actions"]["approve"]}

### Description
Callback endpoint for payment confirmation. The system initiates calling this POST method when confirming payment at reserving, as specified in the integration configuration.

### Method
POST

### Endpoint
{integrationModule["baseUrl"]}/{integrationModule["integrations"]["payment"]["actions"]["approve"]}

### Parameters
#### Request Body
- **clientId** (string) - Required - Client ID in external service
- **approve** (object ModuleApiRequest) - Required - JSON with request data
- **approve[paymentId]** (string) - Required - Internal ID of payment in the module
- **approve[amount]** (float) - Required - Total amount which will be debited from the customer

### Response
#### Success Response (200)
- **success** (boolean) - Query result (successful/unsuccessful)
- **errorMsg** (string) - Error message
- **errors** (array) - Error details array
```

--------------------------------

### GET /api/v5/reference/delivery-types

Source: https://help.retailcrm.pro/api_v5_en.html

Documentation for the GET /api/v5/reference/delivery-types endpoint, including parameters and response fields.

```APIDOC
## GET /api/v5/reference/delivery-types

### Description
Getting the list of delivery types. Requires the `reference_read` permission. Use `filter[codes][]` to return delivery types with the specified symbolic codes. Unknown codes are ignored. Pass `includeCostSettings=true` (or `1`) together with `filter[codes][]` to include cost calculation types, COD markup, regional availability and the `regionWeightCostConditions` and `dateTimeCostConditions` arrays. Without `filter[codes][]`, the parameter returns a `400` error.

### Method
GET

### Endpoint
/api/v5/reference/delivery-types

### Parameters
#### Query Parameters
- **filter[codes][]** (string[]) - Optional - Symbolic delivery type codes to filter by
- **includeCostSettings** (boolean) - Optional - Includes delivery type cost settings; requires filter[codes][]

### Response
#### Success Response (200)
- **success** (boolean) - Query result (successful/unsuccessful)
- **deliveryTypes[]** (array of objects (DeliveryType)) - Delivery type
- **deliveryTypes[][paymentTypes]** (array) - deprecated Allowed payment types. Use `deliveryPaymentTypes`
- **deliveryTypes[][isDynamicCostCalculation]** (boolean) - Dynamic type of calculation of delivery cost
- **deliveryTypes[][isAutoCostCalculation]** (boolean) - Delivery cost is calculated automatically by the delivery service
- **deliveryTypes[][isAutoNetCostCalculation]** (boolean) - Net cost of delivery is calculated automatically by the delivery service
- **deliveryTypes[][isCostDependsOnRegionAndWeightAndSum]** (boolean) - Delivery cost depends on the region, weight and order amount
- **deliveryTypes[][isCostDependsOnDateTime]** (boolean) - Delivery cost depends on the time and day of the week
- **deliveryTypes[][costCalculationType]** (string) - 
- **deliveryTypes[][netCostCalculationType]** (string) - 
- **deliveryTypes[][codMarkup]** (double) - 
- **deliveryTypes[][limitByRegions]** (boolean) - 
- **deliveryTypes[][regionWeightCostConditions]** (array) - 
- **deliveryTypes[][dateTimeCostConditions]** (array) - 
- **deliveryTypes[][currency]** (string) - Currency
- **deliveryTypes[][name]** (string) - Name
- **deliveryTypes[][code]** (string) - Symbolic code
- **deliveryTypes[][active]** (boolean) - Activity status
```

--------------------------------

### GET /api/v5/reference/countries

Source: https://help.retailcrm.pro/api_v5_en.html

Gets the list of available country codes. Requires the `reference_read` permission.

```APIDOC
## GET /api/v5/reference/countries

### Description
Gets the list of available country codes. Requires the `reference_read` permission.

### Method
GET

### Endpoint
/api/v5/reference/countries

### Response
#### Success Response (200)
- **success** (boolean) - Query result (successful/unsuccessful).
- **countriesIso[]** (array of strings) - List of ISO 3166-1 alpha-2 codes of active countries.

#### Response Example
{
  "success": true,
  "countriesIso": ["US", "GB", "DE"]
}

### HTTP Statuses
- **200** - The query was successfully executed.
- **400** - Error on query execution.
```

--------------------------------

### POST {integrationModule["baseUrl"]}/{integrationModule["integrations"]["delivery"]["actions"]["calculate"]}

Source: https://help.retailcrm.pro/api_v5_en.html

Callback for delivery cost calculation. The system initiates a POST call to the method specified in the `calculate` configuration.

```APIDOC
## POST {integrationModule["baseUrl"]}/{integrationModule["integrations"]["delivery"]["actions"]["calculate"]}

### Description
Callback for delivery cost calculation. The system initiates a POST call to the method specified in the `calculate` configuration.

### Method
POST

### Endpoint
{integrationModule["baseUrl"]}/{integrationModule["integrations"]["delivery"]["actions"]["calculate"]}

### Parameters
#### Query Parameters
- **clientId** (string) - Required - Client ID in external service

#### Request Body
- **calculate** (object) - Required - JSON with data for delivery cost calculation
  - **shipmentAddress** (object) - Required - Shipment address
    - **index** (string) - Optional - Country ISO code (ISO 3166-1 alpha-2)
    - **countryIso** (string) - Optional - Country

### Response
#### Success Response (200)
- **success** (boolean) - Query result (successful/unsuccessful)
```

--------------------------------

### GET /api/v5/orders/packs/history

Source: https://help.retailcrm.pro/api_v5_en.html

Gets the history of order packing with pagination. Requires order_read permission.

```APIDOC
## GET /api/v5/orders/packs/history

### Description
Gets the history of order packing. The result is returned per-page with pagination information in the `pagination` field.

### Method
GET

### Endpoint
/api/v5/orders/packs/history

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Quantity of elements in the answer (20 by default). Allowed values: 20, 50, 100.
- **page** (integer) - Optional - Number of page with the results (1 by default). Must be >= 1.
- **filter** (object (OrderProductPackHistoryFilterType)) - Optional - Filter object
- **filter[orderId]** (integer) - Optional - Order internal identifier. Must be >= 0.
- **filter[sinceId]** (integer) - Optional - The lower limit on entry id in the history (excluding boundary). Must be >= 0.
- **filter[orderExternalId]** (string) - Optional - Order identifier in store. Max length: 255.
- **filter[startDate]** (DateTime) - Optional - Time of change (from). Format: Y-m-d H:i:s.
- **filter[endDate]** (DateTime) - Optional - Time of change (to). Format: Y-m-d H:i:s.

### Response
#### Success Response (200)
- The query was successfully executed

#### Error Response (400)
- Error on query execution

### Permissions
- `order_read`
```

--------------------------------

### POST {integrationModule["baseUrl"]}/{integrationModule["integrations"]["payment"]["actions"]["create"]}

Source: https://help.retailcrm.pro/api_v5_en.html

Callback endpoint for payment creation. The system calls this POST method to create a payment.

```APIDOC
## POST {integrationModule["baseUrl"]}/{integrationModule["integrations"]["payment"]["actions"]["create"]}

### Description
Payment creation. To create a payment, the system initiates calling POST method specified in configuration integrationModule["integrations"]["payment"]["actions"]["create"]. For products with the entered marking codes, each product unit will be passed as a separate string in `create[items][]`.

### Method
POST

### Endpoint
{integrationModule["baseUrl"]}/{integrationModule["integrations"]["payment"]["actions"]["create"]}

### Parameters
#### Request Body
- **clientId** (string) - Required - Client ID in external service
- **create** (object (Create)) - Required - JSON with data for payment creation
- **create[shopId]** (string) - Required - Store ID
- **create[invoiceUuid]** (string) - Required - Invoice ID the (UUID). All requests to API of the system are made via this ID
- **create[invoiceType]** (string) - Required - Invoice type. Possible values: link
- **create[amount]** (float) - Required - Amount in the selected currency
- **create[currency]** (string) - Required - Currency code in ISO-4217 format
- **create[orderNumber]** (string) - Required - Order number
- **create[orderId]** (integer) - Required - Order internal ID
- **create[siteUrl]** (string) - Required - Store URL
- **create[returnUrl]** (string) - Required - URL to which the user will be redirected after confirmation or cancellation of the payment
- **create[items][]** (array of objects (Item)) - Required - Products list
- **create[items][][name]** (string) - Required - Name
- **create[items][][price]** (float) - Required - Price
- **create[items][][quantity]** (float) - Required - Quantity
- **create[items][][measurementUnit]** (string) - Required - Unit of measurement
- **create[items][][vat]** (string) - Required - VAT rate. Possible values: none, vat0, vat5, vat7, vat10, vat18, vat20, vat22, vat105, vat107, vat110, vat118, vat120, vat122
- **create[items][][paymentMethod]** (string) - Required - Parameter of payment method. Possible values: `full_prepayment, advance`
- **create[items][][paymentObject]** (string) - Required - Parameter of payment subject. Possible values: `commodity, service, payment`
- **create[items][][productCode]** (string) - Required - Marking code under the "Chestny Znak" system in hexadecimal notation
- **create[items][][markingCode]** (string) - Required - `deprecated` Marking code under the "Chestny Znak" system. Use `markingObject`
- **create[items][][markingObject]** (object (ItemMarkingObject)) - Required - Marking code object
- **create[items][][markingObject][code]** (string) - Required - Marking code value
- **create[items][][markingObject][provider]** (string) - Required - Marking code provider. Possible values: `chestny_znak` — for marking under the "Chestny Znak" system, `giis_dmdk` — for marking under the "GIIS DMDK" system
- **create[items][][offerId]** (integer) - Required - SKU ID
- **create[items][][offerExternalId]** (string) - Required - SKU external ID
- **create[items][][offerXmlId]** (string) - Required - SKU ID in the warehouse system
- **create[customer]** (object (Customer)) - Required - Buyer details
- **create[customer][email]** (string) - Required - Email address
- **create[customer][phone]** (string) - Required - Phone number
- **create[customer][firstName]** (string) - Required - First name
- **create[customer][lastName]** (string) - Required - Last name
- **create[customer][patronymic]** (string) - Required - Middle name
- **create[customer][sex]** (string) - Required - Gender, possible values: male, female
- **create[customer][contragentType]** (string) - Required - Counterparty type: `individual`, `legal-entity`, `enterpreneur`
- **create[customer][legalName]** (string) - Required - The full name of the legal entity or enterpreneur, is transferred in the case of fiscalization on the module side for legal entities and enterpreneurs
- **create[customer][INN]** (string) - Required - Customer TIN, is transmitted in the case of fiscalization on the side of the module for legal entities and enterpreneurs

### Response
No response parameters are documented.
```

--------------------------------

### GET /api/v5/delivery/shipments

Source: https://help.retailcrm.pro/api_v5_en.html

Gets the list of shipments to delivery services. Requires the `delivery_read` permission.

```APIDOC
## GET /api/v5/delivery/shipments

### Description
Gets the list of shipments to delivery services. Requires the `delivery_read` permission.

### Method
GET

### Endpoint
/api/v5/delivery/shipments

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - Quantity of elements in the answer (20 by default). Allowed values: 20, 50, 100.
- **page** (integer) - Optional - Number of page with the results (1 by default). Must be >= 1.
- **filter** (object (DeliveryShipmentFilterData)) - Optional - Filter object.
- **filter[ids][]** (array of integers) - Optional - Array of shipment's ID
- **filter[externalId]** (string) - Optional - External ID
- **filter[orderNumber]** (string) - Optional - Order number in shipment (max length 255)
- **filter[deliveryTypes][]** (array of strings) - Optional - Delivery types
- **filter[managers][]** (array of integers) - Optional - Managers
- **filter[stores][]** (array of strings) - Optional - Warehouses
- **filter[statuses][]** (array of strings) - Optional - Statuses
- **filter[dateFrom]** (DateTime) - Optional - Shipment date (from) (format: Y-m-d)
- **filter[dateTo]** (DateTime) - Optional - Shipment date (to) (format: Y-m-d)

### Response
#### Success Response (200)
- **success** (boolean) - Query result (successful/unsuccessful)
- **pagination** (object (PaginationResponse)) - Pagination
- **pagination[limit]** (integer) - Quantity of elements in the answer
- **pagination[totalCount]** (integer) - Total quantity of found elements
- **pagination[currentPage]** (integer) - Current issuance page
- **pagination[totalPageCount]** (integer) - Total quantity of issuance pages
- **deliveryShipments[]** (array of objects (DeliveryShipment)) - Shipment to delivery service
- **deliveryShipments[][integrationCode]** (string) - Integration code
- **deliveryShipments[][id]** (integer) - Shipment id

```

--------------------------------

### POST /api/v5/loyalty/account/create

Source: https://help.retailcrm.pro/api_v5_en.html

Documentation for the POST /api/v5/loyalty/account/create endpoint that adds a customer to the loyalty program.

```APIDOC
## POST /api/v5/loyalty/account/create

### Description
Adds a customer to the loyalty program. Checks the possibility of customer participation and adds the customer. Requires the `loyalty_write` permission.

### Method
POST

### Endpoint
/api/v5/loyalty/account/create

### Parameters
#### Query Parameters
- **site** (string) - Required - Store symbolic code

#### Request Body
- **loyaltyAccount** (object) - Required - SerializedCreateLoyaltyAccount object
- **loyaltyAccount[phoneNumber]** (string) - Optional - Phone number
- **loyaltyAccount[cardNumber]** (string) - Optional - Card number
- **loyaltyAccount[customFields]** (array) - Optional - Associative array of custom fields
- **loyaltyAccount[customer]** (object) - Optional - SerializedEntityCustomer object
- **loyaltyAccount[customer][id]** (integer) - Optional - Customer internal ID
- **loyaltyAccount[customer][externalId]** (string) - Optional - Customer external ID

### Notes
- One of `phoneNumber` or `cardNumber` must be provided.
- If required fields are not set up and no SMS confirmation is required, the participation is created active; otherwise inactive.
- Inactive participation prevents redeeming bonuses and applying discounts.
- Missing required fields are reported in the `warnings` field of the response.
```

--------------------------------

### GET /api/v5/customers-corporate/{externalId}/addresses

Source: https://help.retailcrm.pro/api_v5_en.html

Documentation for the GET endpoint that lists addresses for a corporate customer.

```APIDOC
## GET /api/v5/customers-corporate/{externalId}/addresses

### Description
List of addresses for a corporate customer. To access the method, the following permission is required `customer_read`. The result is returned page by page. In the field `pagination` there is information on pagination.

### Method
GET

### Endpoint
/api/v5/customers-corporate/{externalId}/addresses

### Parameters
#### Path Parameters
- **externalId** (string) - Required - Customer ID

#### Query Parameters
- **by** (string) - Optional - Is specified what is transmitted in parameter externalId: internal (by=id) or external (by=externalId) ID. By default it is externalId.
- **site** (string) - Optional - Symbolic code of store. Is specified in case of handling by externalId (by=externalId)
- **limit** (integer) - Optional - Quantity of elements in the answer (20 by default). Format: {not blank}[20|50|100]}
- **page** (integer) - Optional - Number of page with the results (1 by default). Format: {not blank}{range: {>=1}}}
- **filter** (object (CustomerAddressFilterData)) - Optional - Filter parameters
- **filter[ids]** (string) - Optional - Filter by IDs
- **filter[name]** (string) - Optional - Filter by name. Format: {length: {max: 255}}
- **filter[city]** (string) - Optional - Filter by city. Format: {length: {max: 255}}
- **filter[region]** (string) - Optional - Filter by region. Format: {length: {max: 255}}

### Response
#### Success Response (200)
- **addresses** (array) - List of customer addresses. If the customer address was specified in the string form it will be returned to the `address[text]`. If the address was specified in detailed view, there will be returned all delivery filled fields, and in the `address[text]` there will be automatically generated textual representation of the address.
- **pagination** (object) - Pagination information

```
Tokens:
Raw