Skip to end of banner
Go to start of banner

POST products/synchronise

Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 25 Current »

Available from CRM.COM R14.0.0

This method is used to synchronise products information in CRM.COM with products information that exists in a 3rd party system, within a single Web API method call. Note that the maximum number of products to be synchronised is 1000

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

synchronisation_definition_identifier

(mandatory)

String

The identifier of the products synchronisation process run definition. The available products synchronisation process run definition identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the process run definition

name

(semi-optional)

String

The name of the process run definition

alternative_code

(semi-optional)

StringThe alternative code of the process run definition

products_set

(mandatory)

Set of Product ObjectsThe set of products that will be synchronised through the Web API method.customer events that will be created by this Web API method. Note that the maximum number of products that can be specified within a single Web API call is 1000

fields_set

(optional)

List of Strings, comma separatedA list of fields that should be included in the results. If not specified then all the available fields will be returned


Restrictions

  • It is mandatory to specify one of the semi-optional parameters. Only one of those parameters is allowed to be specified.

Referred Parameter Objects Data

 bulk products parameter object data

Name

Type

Description

code

(mandatory)

StringThe code of the product

alternative_code

(optional)

StringThe alternative code of the product

description

(optional)

StringThe description of the product

long_description

(optional)

String

A long description of the retrieved product


priority_level

(optional)

Integer

The priority level of the product

type_identifier

(optional)

Product Type Identifier

The product type identifier of the product. The allowed product type identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product type

name

(semi-optional)

String

The name of the product type

alternative_code

(semi-optional)

String

The alternative code of  a product type

brand_identifier

(optional)

Product Brand Identifier

The product brand identifier of the product. The allowed product brand identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product brand

name

(semi-optional)

String

The name of the product brand

alternative_code

(semi-optional)

String

The alternative code of  a product brand

family_identifier

(optional)

Product Family Identifier

The product family identifier of the product. The allowed product family identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product family

name

(semi-optional)

String

The name of the product family

code

(semi-optional)

String

The code of  a product family

category_identifier

(optional)

Product Category Identifier

The product category of the product

Name

Type

Description

id

(semi-optional)

String

The ID of the product category

name

(semi-optional)

String

The name of the product category

code

(semi-optional)

String

The code of  a product category

Deprecated from CRM.COM R14.8.0, R15.2.0, R16.0.0

vat_rate_identifier

(optional)

VAT Rate Identifier

The VAT Rate identifier of the product The allowed VAT Rate identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the VAT rate

name

(semi-optional)

String

The name of the VAT rate

alternative_code

(semi-optional)

String

The alternative code of  the VAT rate

Deprecated from CRM.COM R17.0.0

tax_rate_identifier

(optional)

Tax Rate Identifier

The Tax Rate identifier of the product The allowed Tax Rate identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the Tax rate

name

(semi-optional)

String

The name of the Tax rate

alternative_code

(semi-optional)

String

The alternative code of the Tax rate

Deprecated from CRM.COM R17.0.0

global_rate

(optional)

 Global Rate object

The rate (price) that the product will have in the Global Price Plan

Available from CRM.COM R15.0.0

product_validity_from

(optional)

DateThe date from which the product will be valid

product_validity_to

(optional)

DateThe date until which the product will be valid

udf_string_1

(optional)

String

User Defined Field of type String

udf_string_2

(optional)

String

User Defined Field of type String

udf_string_3

(optional)

String

User Defined Field of type String

udf_string_4

(optional)

String

User Defined Field of type String

udf_string_5

(optional)

String

User Defined Field of type String

udf_string_6

(optional)

String

User Defined Field of type String

udf_string_7

(optional)

String

User Defined Field of type String

udf_string_8

(optional)

String

User Defined Field of type String

udf_string_9

(optional)

String

User Defined Field of type String

udf_string_10

(optional)

String

User Defined Field of type String

udf_string_11

(optional)

String

User Defined Field of type String

udf_string_12

(optional)

String

User Defined Field of type String

udf_string_13

(optional)

String

User Defined Field of type String

udf_string_14

(optional)

String

User Defined Field of type String

udf_string_15

(optional)

String

User Defined Field of type String

udf_string_16

(optional)

String

User Defined Field of type String

udf_float_1

(optional)

Float

User Defined Field of type Float

udf_float_2

(optional)

Float

User Defined Field of type Float

udf_float_3

(optional)

Float

User Defined Field of type Float

udf_float_4

(optional)

Float

User Defined Field of type Float

udf_date_1

(optional)

Date

User Defined Field of type Date

udf_date_2

(optional)

Date

User Defined Field of type Date

udf_date_3

(optional)

Date

User Defined Field of type Date

udf_date_4

(optional)

Date

User Defined Field of type Date

metadata_set

(optional)

Set of Metadata Object

The set of metadata attributes and values associated to the specific product

Available from CRM.COM R15.0.0

categories_set

(optional)

Set of Category Objects

The product category of the product

Available from CRM.COM R14.8.0, R15.2.0, R16.0.0

Referred Parameter Objects Data

 global_rate object parameter data

Name

Type

Description

base_amount

(mandatory)

Number

The base rate that is applied if not tiered rates are applied

rate_model

(mandatory on conditions)

String

The rate model of the retrieved price plan rate which is applicable only if the product type is of a product classification/service type Termed Service.

Available values are:

  • QUANTITYANDPERIODBASED
  • BILLABLEPERIODBASED

For any of the other product classification/type the rate model is automatically set. The applicable values are as follows:

  • QUANTITYBASED
  • QUANTITYANDPERIODBASED
  • BILLABLEPERIODBASED
  • DURATIONBASED
  • FLATFEEBASED (FLATRATE)
  • USAGEBASED (NEW)

From CRM.COM R17.0.0, QUANTITYANDMATURITYBASED is renamed to QUANTITYANDPERIODBASED

base_rate_applied_per

(mandatory on conditions)

String

Determines whether the amount provided is per period or period and quantity. The following options are available

  • Period
  • Period & Item

Mandatory and applicable only for 'Period & Quantity' Based rate model

uot

(mandatory on conditions)

String

The unit of time used for one-time services rates.  The following options are available

  • SECONDS
  • MINUTES
  • HOUR
  • DAY
  • WEEK
  • MONTH
  • YEAR

Mandatory and applicable only for one-time services (Duration rate model)

uom

(mandatory on conditions)

String

Unit of Measurement represents the unit of measurement that can be used in the system in order to measure usage UOM are configurable.

Mandatory and applicable only for usage services (Usage based rate model)

time_period

(mandatory on conditions)

Time Period Object

The period and unit of time used for termed services rates.

Mandatory and applicable only on termed services rates.

Referred Objects Data

 time period parameter object data

Name

Type

Description

time_period_value

(mandatory)

Number

The time period value

time_period_uot

(mandatory)

String

The time period unit of time

The supported values are the following: MINUTES, HOURS, DAYS, WEEKS, MONTHS, YEARS



 metadata attribute value parameter data

Name

Type

Description

keyStringThe key of the metadata field for which a value will be provided
valueStringThe value of the metadata field

 product_categories parameter object data
NameType Description

category_identifier

(mandatory)

Product Category Identifier

The identifier of the product category. The allowed product categories identifier fields are the following:

Name

Type

Description

id

(semi-optional)

String

The ID of the product category

name

(semi-optional)

String

The name of the product category

code

(semi-optional)

String

The code of  a product category

Response Data

Name

Type

Description

processed_products_set

Set of Processed Products Objects

A set that contains the ID and the code of the products that were synchronised


unprocessed_products_set

Set of Unprocessed Products Objects

A set that contains the products that failed to be synchronised in CRM.COM. Each row includes the code of the product, as provided by the caller, along with an error code and error description.


Referred Objects Response Data

 processed products object response data

Name

Type

Description

request_codeStringThe product code as provided by the caller, in order to identify the successful results.

id

String

The ID of the product in CRM.COM which was synchronised

code

String

The number of the product in CRM.COM which was synchronised

messageString

The description of the processed product (including any combination of an attribute and the reason why such attribute information was not updated)

Available from CRM.COM R17.0.0

 unprocessed products object response data

Name

Type

Description

request_codeStringThe product code as provided by the caller, in order to identify the failed results.
error_code

String

The code of the error that was raised

error_descriptionString

The description of the error that was raised

Examples

 Example 1

HTTP Method: POST


Request:


Body

 {
    "token" :   "{{token}}",
    "synchronisation_definition_identifier" :  { "alternative_code" : "SBI1" },
	"products_set":
    [
        {
			"code" : "0001A" ,
            "description":"Product created through Products Synchronization",
            "type_identifier" :  { "alternative_code" : "AO" }
        },
        {
			"code" : "0002A" ,
            "description":"Product created through Products Synchronization",
            "type_identifier" :  { "alternative_code" : "Main Packages" },
            "family_identifier" :  { "code" : "P" }
        },
        {
			"code" : "0003A" ,
            "description":"Product created through Products Synchronization",
            "type_identifier" :  { "alternative_code" : "Main Packages" },
            "product_validity_from" : "2017-08-01T00:00:00"
        }
    ]      
}


Response

 {
    "data": {
        "unprocessed_products_set": [
            {
                "error_description": "Error:Product Synchronisation is Not Allowed Based on the Product Synchronisation Definition. - Description:Product synchronisation cannot be performed.",
                "error_code": "CannotSynchronizeProductException",
                "request_code": "0001A"
            }
        ],
        "processed_products_set": [
            {
                "code": "0002A",
                "request_code": "0002A",
                "id": "4AC27B639C0642F1BDEF2F57A4BBDFCD"
            },
            {
                "code": "0003A",
                "request_code": "0003A",
                "id": "DC2C874B90594438A86096E73C1D3148"
            }
        ]
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}
  • No labels