Page Comparison

Tip
Available from CRM.COM R14.2.0

...

Name

Type

Description

token

String

The token retrieved from the login method

return_policy_identifier

(mandatory)

Identifier

The identifier of the return policy that should be returned as a result. The allowed return policy identifier fields are the following:

Include Page

	V4:return_policy_identifier
	V4:return_policy_identifier

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

...

Expand

title	Example 1

HTTP Method: GET

Request:

Response:

Code Block

 {
    "data": {
        "unit_of_time": "DAYS",
        "allowed_organisational_units_set": null,
        "alternative_code": "DR",
        "log_information": {
            "created_by_unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "Community",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "updated_by_unit": {
                "alternative_code": "adminunit",
                "group_name": "Main Group",
                "community_name": "Community",
                "name": "Admin Unit",
                "description": "admin unit",
                "id": "1"
            },
            "created_date": "2018-07-12T10:23:45",
            "updated_date": "2018-07-24T16:24:05",
            "updated_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "email": "test@crm.com",
                "username": "MPAdministrator"
            },
            "created_by_user": {
                "person_name": "CRM COM",
                "id": "1",
                "email": "test@crm.com",
                "username": "MPAdministrator"
            }
        },
        "description": null,
        "allowed_return_period": 30,
        "expiration_date": null,
        "udf_date_2": null,
        "udf_date_1": null,
        "udf_date_4": null,
        "udf_date_3": null,
        "number": "3",
        "coverage_reasoning": [
            {
                "return_coverage_reason": {
                    "name": "Cannot be resold",
                    "description": null,
                    "id": "4F52A57CD4A14A43A4D3A74A653DB08D",
                    "altCode": "CBR"
                },
                "allows_refund": 0
            },
            {
                "return_coverage_reason": {
                    "name": "Returned with damages",
                    "description": null,
                    "id": "49BBBA5FDF504073AE6048DDDDC9F0DC",
                    "altCode": "RWD"
                },
                "allows_refund": 0
            },
            {
                "return_coverage_reason": {
                    "name": "Returned in good condition",
                    "description": null,
                    "id": "97B50115EB4543679B33FABC753B47F8",
                    "altCode": "RIGC"
                },
                "allows_refund": 1
            }
        ],
        "company_responsibilities": null,
        "udf_float_3": null,
        "udf_float_4": null,
        "effective_date": "2018-07-12T10:32:05",
        "customer_responsibilities": null,
        "id": "79B632942C784DB59453155B526B25FE",
        "physical_goods_covered": [
            {
                "product_family": null,
                "product": {
                    "code": "Set-top-box",
                    "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": "STB",
                    "description": "Set-top-box",
                    "id": "D613415339C14975B28BB4FC11598E93",
                    "priority_level": null
                },
                "product_type": null,
                "product_brand": null
            }
        ],
        "udf_float_1": null,
        "udf_float_2": null,
        "udf_string_2": null,
        "udf_string_3": null,
        "udf_string_4": null,
        "udf_string_5": null,
        "udf_string_1": null,
        "life_cycle_state": "EFFECTIVE",
        "name": "Decoder Returns",
        "udf_string_6": null,
        "udf_string_7": null,
        "udf_string_8": null
    },
    "status": {
        "code": "OK",
        "description": "",
        "message": ""
    }
}

Versions Compared

Old Version 1

New Version Current

Key