Versions Compared

Key

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

Available from CRM.COM R12.3.0

Excerpt

This method returns information related with jobs of fulfillment scope Generic Purpose. Multiple jobs are returned by each call

...

Name

Type

Description

token

String

The token retrieved from the login method

accounts_receivable_identifier

(semi-optional)

Accounts receivable identifier

The identifier of the account related with the job that should be returned as a result. The allowed account identifier fields are the following:

Include Page
V4:accounts_receivable_identifier
V4:accounts_receivable_identifier

type_identifier
(semi-optional)

Job type identifier

The identifier of the job type related with the jobs that should be returned as a result. Only job types classified as generic purpose can be specified.The allowed job type identifier fields are the following:

Include Page
V4:job_type_identifier
V4:job_type_identifier

number_of_results

(optional)

Number

The number of results that can be retrieved through each call

offset

(optional)

Number

Defines the number of entities that should be skipped from the results. If it is set to 0 then none results should be skipped, otherwise the results will begin from the provided offset number

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
titleExample 1

HTTP Method: GET

Request:

Response:

Code Block
themeConfluence
languagejavascript
linenumberstrue
     {
        "data":
        [
            {
                "number": "JB00019",
                "requested_physical_goods_set":
                [
                    {
                        "product":
                        {
                            "code": "25526B",
                            "product_type":
                            {
                                "service_type": null,
                                "used_for_provisioning": false,
                                "alternative_code": "86",
                                "composition_method": "FLEXIBLEBUNDLE",
                                "name": "BEVERAGES COFFEE STA",
                                "description": "BEVERAGES COFFEE STATIONS",
                                "id": "6B7E3F57B7AF4C9790C523178614CC29",
                                "classification": "PHYSICALGOODS",
                                "physical_good_type": "NONTRACEABLE"
                            },
                            "alternative_code": "25526B",
                            "description": "FREDDO ESPRESSO PREMIUM",
                            "id": "A6E89DE0BF01473A9ED72D02CF1574DB"
                        },
                        "quantity": 1,
                        "notes": null,
                        "components_set":
                        [
                            {
                                "code": "Sugar",
                                "product_type":
                                {
                                    "service_type": null,
                                    "used_for_provisioning": false,
                                    "alternative_code": "I",
                                    "composition_method": "FLAT",
                                    "name": "Ingredients",
                                    "description": null,
                                    "id": "6C195AAA1D65469C9494AF833AD672B2",
                                    "classification": "PHYSICALGOODS",
                                    "physical_good_type": "NONTRACEABLE"
                                },
                                "alternative_code": "S",
                                "description": "Sugar",
                                "id": "D275DAD0668347BBBBCF76ED952EA494"
                            }
                        ],
                        "id": "681B009C3A02464CAFE10D2B387CD0D1"
                    },
                    {
                        "product":
                        {
                            "code": "25526B",
                            "product_type":
                            {
                                "service_type": null,
                                "used_for_provisioning": false,
                                "alternative_code": "86",
                                "composition_method": "FLEXIBLEBUNDLE",
                                "name": "BEVERAGES COFFEE STA",
                                "description": "BEVERAGES COFFEE STATIONS",
                                "id": "6B7E3F57B7AF4C9790C523178614CC29",
                                "classification": "PHYSICALGOODS",
                                "physical_good_type": "NONTRACEABLE"
                            },
                            "alternative_code": "25526B",
                            "description": "FREDDO ESPRESSO PREMIUM",
                            "id": "A6E89DE0BF01473A9ED72D02CF1574DB"
                        },
                        "quantity": 1,
                        "notes": null,
                        "components_set":
                        [
                            {
                                "code": "Caramel Sauce",
                                "product_type":
                                {
                                    "service_type": null,
                                    "used_for_provisioning": false,
                                    "alternative_code": "I",
                                    "composition_method": "FLAT",
                                    "name": "Ingredients",
                                    "description": null,
                                    "id": "6C195AAA1D65469C9494AF833AD672B2",
                                    "classification": "PHYSICALGOODS",
                                    "physical_good_type": "NONTRACEABLE"
                                },
                                "alternative_code": "CS",
                                "description": "Caramel Sauce",
                                "id": "CA7EB19FDB6A49BBAECE898E090C4D0C"
                            }
                        ],
                        "id": "22C7226980454A40BB8CCD5BD2486440"
                    },
                    {
                        "product":
                        {
                            "code": "American Cookies /Kg",
                            "product_type":
                            {
                                "service_type": null,
                                "used_for_provisioning": false,
                                "alternative_code": "AMERICAN COOKIES NT",
                                "composition_method": "FLAT",
                                "name": "AMERICAN COOKIES NT",
                                "description": "NT = Non Traceable",
                                "id": "46F8449037FD4CC6981FCFA42CD1605F",
                                "classification": "PHYSICALGOODS",
                                "physical_good_type": "NONTRACEABLE"
                            },
                            "alternative_code": "AC/",
                            "description": "American Cookies /Kg",
                            "id": "0654A6AA5BF84A0297401EC92B11B244"
                        },
                        "quantity": 1,
                        "notes": null,
                        "id": "9E43F9B9DB2646FD8174B4C45A427B2B"
                    },
                    {
                        "product":
                        {
                            "code": "\u03a4\u03c5\u03c1\u03cc\u03c0\u03b9\u03c4\u03b1",
                            "product_type":
                            {
                                "service_type": null,
                                "used_for_provisioning": false,
                                "alternative_code": "\u0391\u03a4\u039f\u039c\u0399\u039a\u0391 \u0391\u039b\u039c\u03a5\u03a1\u0391 NT",
                                "composition_method": "FLAT",
                                "name": "\u0391\u03a4\u039f\u039c\u0399\u039a\u0391 \u0391\u039b\u039c\u03a5\u03a1\u0391 NT",
                                "description": "NT - Non Traceable",
                                "id": "1D6D9DB8A02D4D00B97E1884F5429183",
                                "classification": "PHYSICALGOODS",
                                "physical_good_type": "NONTRACEABLE"
                            },
                            "alternative_code": "\u03a4\u03c5\u03c1\u03cc\u03c0\u03b9\u03c4\u03b1",
                            "description": "\u03a4\u03c5\u03c1\u03cc\u03c0\u03b9\u03c4\u03b1
    ",
                            "id": "67D65B570E30434BA333B98EBB3D7F79"
                        },
                        "quantity": 2,
                        "notes": null,
                        "id": "C68FD98895714A45A8199EA2AD7C8E71"
                    }
                ],
                "log_information":
                {
                    "created_by_unit":
                    {
                        "alternative_code": "ZAU",
                        "group_name": "Zorbas Main Group",
                        "community_name": "Zorbas Management",
                        "name": "Zorbas Admin Unit",
                        "description": "IT Administrator",
                        "id": "50D76D2F5BFE47DBAE2FD1C90AA346A1"
                    },
                    "updated_by_unit":
                    {
                        "alternative_code": "ZAU",
                        "group_name": "Zorbas Main Group",
                        "community_name": "Zorbas Management",
                        "name": "Zorbas Admin Unit",
                        "description": "IT Administrator",
                        "id": "50D76D2F5BFE47DBAE2FD1C90AA346A1"
                    },
                    "created_date": "2017-08-17T16:50:42",
                    "updated_date": "2017-08-17T16:50:44",
                    "updated_by_user":
                    {
                        "person_name": "rewardsapp",
                        "id": "87C1641CF98643069390427E181B964B",
                        "email": null,
                        "username": "rewardsapp"
                    },
                    "created_by_user":
                    {
                        "person_name": "rewardsapp",
                        "id": "87C1641CF98643069390427E181B964B",
                        "email": null,
                        "username": "rewardsapp"
                    }
                },
                "location":
                {
                    "apartment_number": "",
                    "care_of": null,
                    "country":
                    {
                        "alternative_code": "CYP",
                        "three_character_code": null,
                        "name": "CYPRUS",
                        "id": "181",
                        "two_character_code": null
                    },
                    "municipality": null,
                    "type": "CUSTOM2",
                    "udf_date_2": null,
                    "udf_date_1": null,
                    "street_name": "\u03c7\u03c3\u03b4\u03c6",
                    "udf_date_4": null,
                    "udf_date_3": null,
                    "udf_float_3": null,
                    "udf_float_4": null,
                    "po_box_postal_code": null,
                    "udf_string_15": null,
                    "udf_string_16": null,
                    "udf_string_13": null,
                    "udf_string_14": null,
                    "udf_string_11": null,
                    "udf_string_12": null,
                    "id": "C5C8D845A9FE4832AA01F161C4D5F618",
                    "state": "Active",
                    "udf_string_10": null,
                    "floor": null,
                    "udf_float_1": null,
                    "udf_float_2": null,
                    "area": null,
                    "udf_string_2": null,
                    "udf_string_3": null,
                    "udf_string_4": null,
                    "udf_string_5": null,
                    "udf_string_1": null,
                    "po_box": null,
                    "town_city": "",
                    "district": null,
                    "street_number": "222",
                    "postal_code": "2000",
                    "udf_string_6": null,
                    "udf_string_7": null,
                    "udf_string_8": null,
                    "udf_string_9": null
                },
                "id": "6AE5D14E7A93416483A0A6091C1E51A4",
                "status":
                {
                    "alternative_code": "P",
                    "name": "Pending",
                    "description": null,
                    "id": "F22DC83AE5864CF6A0B9C25C49D41AFE",
                    "life_cycle_state": "PENDING"
                }
            },
            {
                "number": "JB00020",
                "requested_physical_goods_set":
                [
                    {
                        "product":
                        {
                            "code": "25526B",
                            "product_type":
                            {
                                "service_type": null,
                                "used_for_provisioning": false,
                                "alternative_code": "86",
                                "composition_method": "FLEXIBLEBUNDLE",
                                "name": "BEVERAGES COFFEE STA",
                                "description": "BEVERAGES COFFEE STATIONS",
                                "id": "6B7E3F57B7AF4C9790C523178614CC29",
                                "classification": "PHYSICALGOODS",
                                "physical_good_type": "NONTRACEABLE"
                            },
                            "alternative_code": "25526B",
                            "description": "FREDDO ESPRESSO PREMIUM",
                            "id": "A6E89DE0BF01473A9ED72D02CF1574DB"
                        },
                        "quantity": 1,
                        "notes": null,
                        "components_set":
                        [
                            {
                                "code": "Sugar",
                                "product_type":
                                {
                                    "service_type": null,
                                    "used_for_provisioning": false,
                                    "alternative_code": "I",
                                    "composition_method": "FLAT",
                                    "name": "Ingredients",
                                    "description": null,
                                    "id": "6C195AAA1D65469C9494AF833AD672B2",
                                    "classification": "PHYSICALGOODS",
                                    "physical_good_type": "NONTRACEABLE"
                                },
                                "alternative_code": "S",
                                "description": "Sugar",
                                "id": "D275DAD0668347BBBBCF76ED952EA494"
                            }
                        ],
                        "id": "71A9E8C5B33B46C7AB2519825C8DA9FA"
                    },
                    {
                        "product":
                        {
                            "code": "American Cookies /Kg",
                            "product_type":
                            {
                                "service_type": null,
                                "used_for_provisioning": false,
                                "alternative_code": "AMERICAN COOKIES NT",
                                "composition_method": "FLAT",
                                "name": "AMERICAN COOKIES NT",
                                "description": "NT = Non Traceable",
                                "id": "46F8449037FD4CC6981FCFA42CD1605F",
                                "classification": "PHYSICALGOODS",
                                "physical_good_type": "NONTRACEABLE"
                            },
                            "alternative_code": "AC/",
                            "description": "American Cookies /Kg",
                            "id": "0654A6AA5BF84A0297401EC92B11B244"
                        },
                        "quantity": 2,
                        "notes": null,
                        "id": "1A31A00E743343108757E1F313070651"
                    },
                    {
                        "product":
                        {
                            "code": "\u03a4\u03c5\u03c1\u03cc\u03c0\u03b9\u03c4\u03b1",
                            "product_type":
                            {
                                "service_type": null,
                                "used_for_provisioning": false,
                                "alternative_code": "\u0391\u03a4\u039f\u039c\u0399\u039a\u0391 \u0391\u039b\u039c\u03a5\u03a1\u0391 NT",
                                "composition_method": "FLAT",
                                "name": "\u0391\u03a4\u039f\u039c\u0399\u039a\u0391 \u0391\u039b\u039c\u03a5\u03a1\u0391 NT",
                                "description": "NT - Non Traceable",
                                "id": "1D6D9DB8A02D4D00B97E1884F5429183",
                                "classification": "PHYSICALGOODS",
                                "physical_good_type": "NONTRACEABLE"
                            },
                            "alternative_code": "\u03a4\u03c5\u03c1\u03cc\u03c0\u03b9\u03c4\u03b1",
                            "description": "\u03a4\u03c5\u03c1\u03cc\u03c0\u03b9\u03c4\u03b1
    ",
                            "id": "67D65B570E30434BA333B98EBB3D7F79"
                        },
                        "quantity": 2,
                        "notes": null,
                        "id": "882D45DCF8B749CBB3F64B9C3B52A91D"
                    },
                    {
                        "product":
                        {
                            "code": "25526B",
                            "product_type":
                            {
                                "service_type": null,
                                "used_for_provisioning": false,
                                "alternative_code": "86",
                                "composition_method": "FLEXIBLEBUNDLE",
                                "name": "BEVERAGES COFFEE STA",
                                "description": "BEVERAGES COFFEE STATIONS",
                                "id": "6B7E3F57B7AF4C9790C523178614CC29",
                                "classification": "PHYSICALGOODS",
                                "physical_good_type": "NONTRACEABLE"
                            },
                            "alternative_code": "25526B",
                            "description": "FREDDO ESPRESSO PREMIUM",
                            "id": "A6E89DE0BF01473A9ED72D02CF1574DB"
                        },
                        "quantity": 1,
                        "notes": null,
                        "components_set":
                        [
                            {
                                "code": "Caramel Sauce",
                                "product_type":
                                {
                                    "service_type": null,
                                    "used_for_provisioning": false,
                                    "alternative_code": "I",
                                    "composition_method": "FLAT",
                                    "name": "Ingredients",
                                    "description": null,
                                    "id": "6C195AAA1D65469C9494AF833AD672B2",
                                    "classification": "PHYSICALGOODS",
                                    "physical_good_type": "NONTRACEABLE"
                                },
                                "alternative_code": "CS",
                                "description": "Caramel Sauce",
                                "id": "CA7EB19FDB6A49BBAECE898E090C4D0C"
                            }
                        ],
                        "id": "F20B185C1D6E4B818DA31A10B95D88C4"
                    }
                ],
                "log_information":
                {
                    "created_by_unit":
                    {
                        "alternative_code": "ZAU",
                        "group_name": "Zorbas Main Group",
                        "community_name": "Zorbas Management",
                        "name": "Zorbas Admin Unit",
                        "description": "IT Administrator",
                        "id": "50D76D2F5BFE47DBAE2FD1C90AA346A1"
                    },
                    "updated_by_unit":
                    {
                        "alternative_code": "ZAU",
                        "group_name": "Zorbas Main Group",
                        "community_name": "Zorbas Management",
                        "name": "Zorbas Admin Unit",
                        "description": "IT Administrator",
                        "id": "50D76D2F5BFE47DBAE2FD1C90AA346A1"
                    },
                    "created_date": "2017-08-17T18:22:29",
                    "updated_date": "2017-08-17T18:22:30",
                    "updated_by_user":
                    {
                        "person_name": "rewardsapp",
                        "id": "87C1641CF98643069390427E181B964B",
                        "email": null,
                        "username": "rewardsapp"
                    },
                    "created_by_user":
                    {
                        "person_name": "rewardsapp",
                        "id": "87C1641CF98643069390427E181B964B",
                        "email": null,
                        "username": "rewardsapp"
                    }
                },
                "location":
                {
                    "apartment_number": "",
                    "care_of": null,
                    "country":
                    {
                        "alternative_code": "CYP",
                        "three_character_code": null,
                        "name": "CYPRUS",
                        "id": "181",
                        "two_character_code": null
                    },
                    "municipality": null,
                    "type": "CUSTOM2",
                    "udf_date_2": null,
                    "udf_date_1": null,
                    "street_name": "\u03c7\u03c3\u03b4\u03c6",
                    "udf_date_4": null,
                    "udf_date_3": null,
                    "udf_float_3": null,
                    "udf_float_4": null,
                    "po_box_postal_code": null,
                    "udf_string_15": null,
                    "udf_string_16": null,
                    "udf_string_13": null,
                    "udf_string_14": null,
                    "udf_string_11": null,
                    "udf_string_12": null,
                    "id": "C5C8D845A9FE4832AA01F161C4D5F618",
                    "state": "Active",
                    "udf_string_10": null,
                    "floor": null,
                    "udf_float_1": null,
                    "udf_float_2": null,
                    "area": null,
                    "udf_string_2": null,
                    "udf_string_3": null,
                    "udf_string_4": null,
                    "udf_string_5": null,
                    "udf_string_1": null,
                    "po_box": null,
                    "town_city": "",
                    "district": null,
                    "street_number": "222",
                    "postal_code": "2000",
                    "udf_string_6": null,
                    "udf_string_7": null,
                    "udf_string_8": null,
                    "udf_string_9": null
                },
                "id": "074C046B7337463AA0403B1A407BBC77",
                "status":
                {
                    "alternative_code": "P",
                    "name": "Pending",
                    "description": null,
                    "id": "F22DC83AE5864CF6A0B9C25C49D41AFE",
                    "life_cycle_state": "PENDING"
                }
            }
        ],
        "status":
        {
            "code": "OK",
            "description": "",
            "message": ""
        }
    }