Versions Compared

Old Version 7

changes.mady.by.user George Rossides (Unlicensed)

Saved on

compared with

New Version Current

changes.mady.by.user Marios Michael

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

...

...

...

...

...

...

...

...

...

...

...


Tip

Available from CRM.COM R14.4.0


Excerpt

This method adds a product in the list of favorite items. A single product can be added on each call

Resource URL

Parameters

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(mandatory)

Accounts Receivable Identifier

The accounts receivable owning the list of favorite items. The available accounts receivable identifiers are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

item

(mandatory)

Favorite Item ObjectThe item that will be added in the list of favorite items

fields_set

(optional)

List of Strings, comma separated 

A 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.

Anchor
accounts_receivable_add_members referred objects parameters
accounts_receivable_add_members referred objects parameters
Referred Objects Response Data

Include Page
V4:favorite_items_product_parameters
V4:favorite_items_product_parameters

Response Data

Include Page
V4:favorite_item_complete
V4:favorite_item_complete

Examples

Expand
titleExample 1

HTTP Method: POST


Request:

Body:

Code Block
languagejavascript
themeConfluence
linenumberstrue
 {
	"token": {{token}},
	"accounts_receivable_identifier": {
		"number": "ACR0000000025"
	},
	"item": {
		"product_identifier": {
			"code": "123"
		}
	}
}



Response:

Code Block
languagejavascript
themeConfluence
linenumberstrue
 {
    "data": {
        "number": null,
        "product": {
            "code": "123",
            "product_type": {
                "meter_reading_type": null,
                "service_type": null,
                "used_for_provisioning": true,
                "alternative_code": "STB",
                "udr_type": null,
                "composition_method": "FLAT",
                "name": "SET TOP BOX",
                "description": "SET TOP BOX",
                "id": "E8BA9A6F34A24019A89892D5B3ACD9DF",
                "classification": "PHYSICALGOODS",
                "physical_good_type": "TRACEABLE"
            },
            "alternative_code": "1_13",
            "description": "desc",
            "id": "99E46901A95B4E31A60BBE67280F2522",
            "priority_level": null
        },
        "components_set": [],
        "accounts_receivable": {
            "number": "ACR0000000025",
            "name": "ACR0000000025 Ramy M",
            "id": "4C13FA60560B42F7939113BD699A9E71",
            "life_cycle_state": "ACTIVE",
            "account_owner": {
                "company_profile": null,
                "company_name": null,
                "name": null,
                "last_name": "M",
                "id": "51DDE9E46B9F4F5EB0E01F909F18FE39",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "title": null,
                "type": "PERSON",
                "first_name": "Ramy",
                "demographics": {
                    "name_day": {
                        "month": null,
                        "day": null
                    },
                    "id_number": "126598",
                    "passport_number_expiration_date": null,
                    "gender": null,
                    "date_of_birth": {
                        "month": null,
                        "year": null,
                        "day": null
                    },
                    "id_number_expiration_date": null,
                    "industry_sector": null,
                    "passport_number": null,
                    "industry": null,
                    "social_security_number": null,
                    "id_issued_by_country": null,
                    "passport_issued_by_country": null
                }
            }
        },
        "id": "5AB3DB960C724D7C8AD5929E493101B9"
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}



Expand
titleExample 2

HTTP Method: POST


Request:

ResponseBody:

Code Block
languagejavascript
themeConfluence
linenumberstrue
{
	"token": {{token}},
	"accounts_receivable_identifier": {
		"number": "ACR0000000026"
	},
	"item": {
		"product_identifier": {
			"code": "Caffe Latte"
		},
		"components_set": [
			{
				"product_identifier": {
					"code": "Extra Milk"
				}
			},
			{
				"product_identifier": {
					"code": "Extra Shot"
				}
			}
		]
	}
}



Response:

Code Block
languagejavascript
themeConfluence
linenumberstrue
 {
    "data": {
        "number": null,
        "product": {
            "code": "Caffe Latte",
            "product_type": {
                "meter_reading_type": null,
                "service_type": null,
                "used_for_provisioning": false,
                "alternative_code": "Z",
                "udr_type": null,
                "composition_method": "FLEXIBLEBUNDLE",
                "name": "Zorbas",
                "description": null,
                "id": "A8F22AD71E9C4A818A5CA853E628CA4A",
                "classification": "PHYSICALGOODS",
                "physical_good_type": "NONTRACEABLE"
            },
            "alternative_code": "CL",
            "description": "Caffe Latte",
            "id": "847DAF8938094DC7B9542991D0A2916A",
            "priority_level": null
        },
        "components_set": [
            {
                "product": {
                    "code": "Extra Shot",
                    "product_type": {
                        "meter_reading_type": null,
                        "service_type": null,
                        "used_for_provisioning": false,
                        "alternative_code": "ZC",
                        "udr_type": null,
                        "composition_method": "FLAT",
                        "name": "Zorbas Component",
                        "description": null,
                        "id": "8EED05CC65A54147B1B6CFD0F80063C4",
                        "classification": "PHYSICALGOODS",
                        "physical_good_type": "NONTRACEABLE"
                    },
                    "alternative_code": "ES_1",
                    "description": "Extra Shot",
                    "id": "DA6C0E1F5BA34E2EA15B191CAA4FBCDB",
                    "priority_level": null
                },
                "id": "BE37B4FF56594F008008A4D6565A3FBA"
            },
            {
                "product": {
                    "code": "Extra Milk",
                    "product_type": {
                        "meter_reading_type": null,
                        "service_type": null,
                        "used_for_provisioning": false,
                        "alternative_code": "ZC",
                        "udr_type": null,
                        "composition_method": "FLAT",
                        "name": "Zorbas Component",
                        "description": null,
                        "id": "8EED05CC65A54147B1B6CFD0F80063C4",
                        "classification": "PHYSICALGOODS",
                        "physical_good_type": "NONTRACEABLE"
                    },
                    "alternative_code": "EM",
                    "description": "Extra Milk",
                    "id": "16A1B5AB31E542BC9E9335BABEAA9049",
                    "priority_level": null
                },
                "id": "1C80BA2EBDA04CC0B07770B68C0C6B47"
            }
        ],
        "accounts_receivable": {
            "number": "ACR0000000026",
            "name": "ACR0000000026 Loukia Papapavlou",
            "id": "ED512ED25BFF413280FA1BEB85DA9B1F",
            "life_cycle_state": "ACTIVE",
            "account_owner": {
                "company_profile": null,
                "company_name": null,
                "name": "Loukia Papapavlou",
                "last_name": "Papapavlou",
                "id": "E12B1552198540D7BDBBE5CCF23D0EE5",
                "life_cycle_state": "FINANCIAL",
                "middle_name": "Loukia",
                "title": "Miss",
                "type": "PERSON",
                "first_name": "Loukia",
                "demographics": {
                    "id_number": "11225588",
                    "gender": "FEMALE",
                    "country_of_residence": {
                        "alternative_code": "CYP",
                        "three_character_code": "CYP",
                        "name": "CYPRUS",
                        "id": "181",
                        "two_character_code": "CY"
                    },
                    "date_of_birth": {
                        "month": 1,
                        "year": 1991,
                        "day": 28
                    },
                    "industry_sector": null,
                    "industry": null,
                    "name_day": {
                        "month": 12,
                        "day": 13
                    },
                    "passport_number_expiration_date": null,
                    "id_number_expiration_date": null,
                    "passport_number": null,
                    "social_security_number": "99999999",
                    "id_issued_by_country": null,
                    "passport_issued_by_country": null
                }
            }
        },
        "id": "7922F92C8F064D4EAE6EA9521BD426D7"
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}



Expand
titleExample 3

HTTP Method: 

...

POST

Request:

Body:

Code Block
languagejavascript
themeConfluence
linenumberstrue
 {
    "token": {{token}},
    "accounts_receivable_identifier": {
        "number": "ACR0000002969"
    },
    "item": {
        "product_identifier": {
            "code": "10584_01"
        },
        "notes":"10584_01 for me"
    }
}


Response:

Code Block
languagejavascript
themeConfluence
linenumberstrue
{
    "data": {
        "number": "11",
        "product": {
            "code": "10584_01",
            "product_type": {
                "meter_reading_type": null,
                "service_type": null,
                "used_for_provisioning": false,
                "alternative_code": "CRM_ProdType",
                "udr_type": null,
                "composition_method": "FLAT",
                "name": "CRM_ProdType",
                "description": null,
                "id": "2A102A5FEECB43B2A8778CC4FCECE73C",
                "classification": "PHYSICALGOODS",
                "physical_good_type": "TRACEABLE"
            },
            "alternative_code": "1_1",
            "description": "Product Description 10584_A01",
            "id": "78E58334893C4ABE8CFAF170856D20C3",
            "priority_level": null
        },
        "notes": "10584_01 for me",
        "components_set": [],
        "accounts_receivable": {
            "number": "ACR0000002969",
            "name": "ACR0000002969 Test 16052019_01",
            "id": "207F6A3347244BAC9036CC8B3A1C87B5",
            "life_cycle_state": "ACTIVE",
            "account_owner": {
                "company_profile": null,
                "company_name": null,
                "name": null,
                "last_name": "16052019_01",
                "id": "DAE94BD8C0EB4C63A3A19318F74A5DD9",
                "life_cycle_state": "FINANCIAL",
                "middle_name": null,
                "title": null,
                "type": "PERSON",
                "first_name": "Test",
                "demographics": {
                    "id_number": "16052019_01",
                    "gender": null,
                    "country_of_residence": {
                        "alternative_code": "CYP",
                        "three_character_code": "CYP",
                        "name": "CYPRUS",
                        "id": "181",
                        "two_character_code": "CY"
                    },
                    "date_of_birth": {
                        "month": null,
                        "year": null,
                        "day": null
                    },
                    "industry_sector": null,
                    "industry": null,
                    "name_day": {
                        "month": null,
                        "day": null
                    },
                    "passport_number_expiration_date": null,
                    "id_number_expiration_date": null,
                    "passport_number": null,
                    "social_security_number": null,
                    "id_issued_by_country": null,
                    "passport_issued_by_country": null
                }
            }
        },
        "id": "542A111695FC4FBBAD0D9ED2A73B1ED7"
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}