Custom Vocab Get
  • 5 Minutes to read
  • Dark
    Light

Custom Vocab Get

  • Dark
    Light

Article summary

To get a custom vocab, mention the following in the postman and then click Send.

GET

Headers

Authorization: Specify required Auth Token in the header.

Response 200 OK


{
  "VocabularyByEntityType": [
    {
      "EntityType": "Product",
      "SimpleAttributes": [
        {
          "Alias": "ProductDescription",
          "Id": "8af4c7b2-3d5b-4181-a9c6-60978a36a8da"
        },
        {
          "Alias": "UPC - All Digit Lengths",
          "Id": "575ad9c5-3da2-472e-ada0-85d227d2cbaf"
        },
        {
          "Alias": "Internal Supplier Part #",
          "Id": "54f9b50d-671d-4895-8f02-cd757999ec9e"
        },
        {
          "Alias": "MFG Part # (OEM)",
          "Id": "cd250fb8-fb00-4f9d-813a-dea949605715"
        },
        {
          "Alias": "MFG Model # (Series)",
          "Id": "2bce6533-87c7-4646-a3b7-d5efb49bf927"
        },
        {
          "Alias": "Short Description",
          "Id": "57fa45f9-9a71-4f7e-af1f-3e5cc97dc06b"
        },
        {
          "Alias": "GTIN",
          "Id": "0994d0f8-35e7-4a6d-9cd9-2ae97cd8b993"
        },
        {
          "Alias": "UPC",
          "Id": "6d030ff8-72ce-4f42-ba53-023f55c53a20"
        },
        {
          "Alias": "Packaging Level",
          "Id": "694d3708-43e6-4c28-b01b-262b33d7eebe"
        },
        {
          "Alias": "Item is the Lowest Packaging Level",
          "Id": "4c7e4e19-1bfa-4841-b759-895d2efeb418"
        },
        {
          "Alias": "Market Availability Date",
          "Id": "173e8b0a-d22d-46ff-87c4-a4eae02da18e"
        },
        {
          "Alias": "MFG Name",
          "Id": "37f3fed4-5bf3-4bf8-88bd-310bd2addb56"
        },
        {
          "Alias": "MFG Brand Name",
          "Id": "29d438d9-64f2-4623-8f4e-09f9368e93bb"
        },
        {
          "Alias": "Supplier Company Name",
          "Id": "42f50983-e03e-4503-8ed5-f1d3da062855"
        },
        {
          "Alias": "Suggested Buy URL",
          "Id": "8a745957-9ec0-474b-87d3-375a7a0273a9"
        },
        {
          "Alias": "Supplier Product Type/Category",
          "Id": "bf915f55-0d49-48d0-9aad-70ca05176618"
        },
        {
          "Alias": "Search Keywords",
          "Id": "2aac5537-9953-4527-a491-25ce5155d86c"
        },
        {
          "Alias": "Product Name",
          "Id": "bda64a3f-507c-49de-883c-fa832c6539e7"
        },
        {
          "Alias": "Marketing Copy",
          "Id": "52e3af44-05b0-44e2-950d-431017fe9728"
        },
        {
          "Alias": "Feature - Benefit Bullet 1",
          "Id": "a2523cf4-a05f-4916-93a0-95026883babe"
        },
        {
          "Alias": "Feature - Benefit Bullet 2",
          "Id": "d157285a-f56a-4bfa-80eb-1fcecb6160e4"
        },
        {
          "Alias": "Feature - Benefit Bullet 3",
          "Id": "357c51e8-a649-44df-a56e-ae75227b5ba9"
        },
        {
          "Alias": "Feature - Benefit Bullet 4",
          "Id": "d74d3ae2-40f4-4aff-a6c5-f2926d968826"
        },
        {
          "Alias": "Item has Restrictions?",
          "Id": "125f97fd-6209-48b8-893b-ed55d6bd3b10"
        },
        {
          "Alias": "Package Height",
          "Id": "7f4f75eb-e94d-4786-ae07-f3dc2a2ce038"
        },
        {
          "Alias": "Package Height UOM",
          "Id": "e7e870ac-2a79-4a83-a76a-62920437499a"
        },
        {
          "Alias": "Package Width",
          "Id": "e70b7eaa-6150-4f3b-abb3-5693b2995862"
        },
        {
          "Alias": "Package Width UOM",
          "Id": "5f7edd54-a66d-4309-a4d5-65e4868a062c"
        },
        {
          "Alias": "Package Depth",
          "Id": "fc3653d1-74b5-41d4-95a3-93acc7e3c9c2"
        },
        {
          "Alias": "Package Depth UOM",
          "Id": "f4b91aa1-d925-4f03-847c-dc2e18f39125"
        },
        {
          "Alias": "Package Weight",
          "Id": "fab13caf-792f-48df-9dbf-81446cd6e8a7"
        },
        {
          "Alias": "Package Weight UOM",
          "Id": "f9d67d41-df67-4941-a86e-70276bd7f3e7"
        },
        {
          "Alias": "Country of Origin (numeric)",
          "Id": "8ecf0ae5-f846-47f6-99c0-43a83d12f346"
        },
        {
          "Alias": "Net Package Quantity/Net Content",
          "Id": "0d09ffd4-6a5e-4a6e-a291-ab5eb6eb28b7"
        },
        {
          "Alias": "Feature - Benefit Bullet 5",
          "Id": "703be75e-f6c8-42ef-9458-c794d745941a"
        },
        {
          "Alias": "Feature - Benefit Bullet 6",
          "Id": "535f4985-cc34-4754-8cbe-dabde4a72dd7"
        },
        {
          "Alias": "Feature - Benefit Bullet 7",
          "Id": "32eb02e3-5755-44ab-bc10-5b9e95c3832c"
        },
        {
          "Alias": "Feature - Benefit Bullet 8",
          "Id": "07e43f47-910e-4629-bd6b-e2bf25cb1699"
        },
        {
          "Alias": "Feature - Benefit Bullet 9",
          "Id": "fd6c8c49-8621-4c4e-8250-6683e75693ef"
        },
        {
          "Alias": "Feature - Benefit Bullet 10",
          "Id": "108ae4ca-61be-4770-affe-577c7a929b39"
        },
        {
          "Alias": "Feature - Benefit Bullet 11",
          "Id": "0b380615-c3e2-401c-b13f-75901c07aa1d"
        },
        {
          "Alias": "Feature - Benefit Bullet 12",
          "Id": "850652a5-10b6-4ecd-9cae-f4982442087c"
        },
        {
          "Alias": "Feature - Benefit Bullet 13",
          "Id": "ce8920a3-f557-4192-9254-f1fd3e9ec24c"
        },
        {
          "Alias": "Feature - Benefit Bullet 14",
          "Id": "84aa96dc-a549-46da-b3e5-ad8ce6096a90"
        },
        {
          "Alias": "Feature - Benefit Bullet 15",
          "Id": "8c63ad44-62ea-4466-b556-d71dea1c95c8"
        },
        {
          "Alias": "Feature - Benefit Bullet 16",
          "Id": "0c10dd1f-e54b-4df5-8cfa-c24e2260a6ff"
        },
        {
          "Alias": "Feature - Benefit Bullet 17",
          "Id": "95cc3d1d-9a09-475b-9874-53013c34f8af"
        },
        {
          "Alias": "Feature - Benefit Bullet 18",
          "Id": "cb491246-5c72-4b51-bf0f-52fd76b78f15"
        },
        {
          "Alias": "Feature - Benefit Bullet 19",
          "Id": "a76d8a88-0d90-46f2-9b9c-10056a7375af"
        },
        {
          "Alias": "Feature - Benefit Bullet 20",
          "Id": "286c67a6-d2cc-4f05-bd89-49f2df187975"
        },
        {
          "Alias": "Feature - Benefit Bullet 21",
          "Id": "4a313f3c-9003-41af-85fc-a0996bea53a9"
        },
        {
          "Alias": "Feature - Benefit Bullet 22",
          "Id": "53e64771-08e0-4a8b-8818-9d048c255119"
        },
        {
          "Alias": "Supplier Internal Item Status Code",
          "Id": "c12998b1-ab09-4e1e-8005-502f7964b55c"
        },
        {
          "Alias": "Collection Name",
          "Id": "eae9863c-01da-4820-abd9-83487cf6819a"
        },
        {
          "Alias": "Sub-Brand",
          "Id": "ebf5c9b9-89af-4900-a33d-6e0cca9413e0"
        },
        {
          "Alias": "Does this Product Have a Warranty?",
          "Id": "4ec1b59b-511d-4c34-846d-06056bc653c2"
        },
        {
          "Alias": "Manufacturer Warranty",
          "Id": "9df6fe91-5acd-4163-8276-f628b5faa8ba"
        },
        {
          "Alias": "Warranty Type",
          "Id": "00e03fdc-e177-4233-8f1f-48ec59fbc8e4"
        },
        {
          "Alias": "Warranty Type of Effective Date",
          "Id": "86123937-7f81-4b88-8c33-6aafad50c55a"
        },
        {
          "Alias": "Date Type on Packaging",
          "Id": "c9df82f1-2686-4bd5-9ac4-10a4d5f740d3"
        },
        {
          "Alias": "Has Item Been Recalled",
          "Id": "06b9e7cc-c646-4670-bf6f-8188ac4b1f4e"
        },
        {
          "Alias": "Nominal Size",
          "Id": "c4d74a8d-9b2a-4134-a7be-7a3564f8f4bc"
        },
        {
          "Alias": "Assembled Depth (in)",
          "Id": "9456caa0-3856-4dd3-91b9-1d19ff130e2b"
        },
        {
          "Alias": "Assembled Height (in)",
          "Id": "f7e66e4f-d14a-4665-a40b-720b82d4bb20"
        },
        {
          "Alias": "Assembled Width (in)",
          "Id": "bc79d3ef-18fd-4891-8b2c-1fdae404318c"
        },
        {
          "Alias": "Assembled Weight (lbs)",
          "Id": "228a54a1-045b-4ca4-9c0a-02df98efd77b"
        },
        {
          "Alias": "Vendor Base Cost",
          "Id": "110a1269-43af-4986-8d3c-53512d2429ac"
        },
        {
          "Alias": "List Price (MSRP)",
          "Id": "0433f453-3bef-4e31-9a97-1e0070a92318"
        },
        {
          "Alias": "Minimum Advertised Price (MAP)",
          "Id": "4e3ac794-8aa9-4911-b064-17f221ccdb84"
        },
        {
          "Alias": "Price Sheet Effective Date",
          "Id": "70d925b4-0d66-48cf-a34d-fb7ee12807b6"
        },
        {
          "Alias": "Price Sheet Number",
          "Id": "cc6852ce-c002-4b70-97e9-c9d5d5aebf67"
        },
        {
          "Alias": "Brand AAIA ID",
          "Id": "463dbd90-b364-4b91-b3eb-76ab9b82c820"
        },
        {
          "Alias": "Part Terminology ID - AAIA",
          "Id": "916cecfe-c736-442b-8be9-12be0583d299"
        },
        {
          "Alias": "ManufacturerID - AAIA",
          "Id": "2cacf154-a0e0-43ee-a2ee-405eafe1485b"
        },
        {
          "Alias": "National Popularity (Velocity) Codes",
          "Id": "145c25b6-d915-4b5e-883b-b2f6e3ea8dfe"
        },
        {
          "Alias": "Life Cycle Status Code",
          "Id": "96a89164-b619-4957-a444-7b8ac008d35b"
        },
        {
          "Alias": "Quantity per Application",
          "Id": "fcf7d3a6-b983-4b19-b592-aed646140d12"
        },
        {
          "Alias": "Supplier is the Manufacturer",
          "Id": "987052ba-0bef-4845-b0be-e625dd17e14c"
        },
        {
          "Alias": "Previous UPC",
          "Id": "a53e6099-a48b-4da6-826b-be104c400dfc"
        },
        {
          "Alias": "Previous MFG Model #",
          "Id": "d2cefcb8-4d57-48f7-a857-c30bce115d0c"
        },
        {
          "Alias": "Product Description – Short - 20",
          "Id": "6b122a15-eb92-414c-91d4-19a59cb246f9"
        },
        {
          "Alias": "Item is Shipped/Despatched at this Packaging Level",
          "Id": "2bc62f00-387d-494d-a789-9233c4fbe891"
        },
        {
          "Alias": "Item is Sold to the Consumer",
          "Id": "8b53213a-aa8c-41b1-b56d-8bf20d2a5961"
        },
        {
          "Alias": "Information Effective Date",
          "Id": "bd2aebae-c898-47a8-9765-c38e339d21c5"
        },
        {
          "Alias": "Minimum Order Quantity",
          "Id": "69a59f4f-0a5e-4361-8f60-c6d8f0f3e8fa"
        },
        {
          "Alias": "Order UOM",
          "Id": "b7679ddb-b113-431a-872d-ce64f4d530a5"
        },
        {
          "Alias": "Multiple Order Quantity",
          "Id": "4c2bac6e-0728-43dd-8267-c8657007009d"
        },
        {
          "Alias": "Selling UOM",
          "Id": "1883168e-bf52-4563-980a-f437e648fbdd"
        },
        {
          "Alias": "Layers Per Pallet",
          "Id": "bbdbeec5-151e-4e57-93f8-fd48b381b3c5"
        },
        {
          "Alias": "Items Per Pallet Layer",
          "Id": "c993155e-5b77-4530-beab-fe4bacf6b42c"
        },
        {
          "Alias": "Regulating Country of Origin",
          "Id": "9fce91d2-da0c-4fe9-ab49-afa9a4d6b4d4"
        },
        {
          "Alias": "Country Code - 2 Character code",
          "Id": "93f48d10-6dcc-4d0b-afd3-d983882d3fae"
        },
        {
          "Alias": "UL Listing",
          "Id": "3bba3737-0d2f-47b1-a2b6-e1a66c210b34"
        },
        {
          "Alias": "Hazardous per DOT",
          "Id": "fe10980e-d199-44fa-9f4a-b3664bd95976"
        },
        {
          "Alias": "Product Information Video Link - URL",
          "Id": "2d4d7198-e7b1-4a96-9b1f-2ad3ea6fe35d"
        },
        {
          "Alias": "Assembly Instruction Video Link - URL",
          "Id": "b2670a46-217d-48fa-92ff-c565a35ed497"
        },
        {
          "Alias": "Product Review Video Link - URL",
          "Id": "43724b25-52a5-46b4-881f-c2c987dd70bf"
        },
        {
          "Alias": "Product Installation Video Link - URL",
          "Id": "76760d43-23bb-47ae-a0e3-eb5a295ab70d"
        },
        {
          "Alias": "Part Type (Grade) - Collision Repair (REQUIRED)",
          "Id": "324dbb25-9e86-4023-a3ac-aad03f868be8"
        },
        {
          "Alias": "Reconditioned Methodology - Collision Repair",
          "Id": "33443140-33b9-47f0-b195-c488a643da1e"
        },
        {
          "Alias": "Assembly Indicator - Collision Repair (REQUIRED)",
          "Id": "32d71c2c-0c7f-4312-a4db-4615508f9e1c"
        },
        {
          "Alias": "Industry Certifications - Collision Repair (REQUIRED)",
          "Id": "4678ffb5-04ec-452b-aa2d-16afacd3d5a8"
        },
        {
          "Alias": "Part Supplier Designation - Collision Repair",
          "Id": "0558d522-00ba-4972-97a5-1c2dff464dda"
        },
        {
          "Alias": "OEM Cross References",
          "Id": "b45f9ba0-fa19-4860-87ec-00ff0a209869"
        },
        {
          "Alias": "Superceded OEM Part Number(s)",
          "Id": "44147c9b-6332-4738-9d58-a25e0a32f933"
        },
        {
          "Alias": "Disclaimer",
          "Id": "3ccb8679-1b63-4c90-9cc0-965cff7d6eb6"
        },
        {
          "Alias": "UNSPSC_Code",
          "Id": "d3956077-605b-4b04-b790-0e0824dd0a66"
        },
        {
          "Alias": "Item has MSDS (SDS)?",
          "Id": "24690cd5-f52a-4b84-b5e3-922262f10c31"
        },
        {
          "Alias": "California Proposition 65 Warning Required",
          "Id": "b1c56364-c8d2-4e4c-b92a-b37a7b3e830b"
        },
        {
          "Alias": "Contains Chemicals that Cause Birth Defects (Calif Prop65)",
          "Id": "4e34fe2e-bae7-41af-888e-81bcdcfdaf7b"
        },
        {
          "Alias": "Front - Center - Elevated",
          "Id": "e3238a4c-1936-400d-84c0-63cb320c24ce"
        }
      ],
      "ComplexAttributes": [
        {
          "ParentAttribute": {
            "Alias": "Restrictions",
            "Id": "aa8f9ce0-9cb1-4db5-81f0-8723e8951752"
          },
          "ChildAttributes": [
            {
              "Alias": "Restriction Country",
              "Id": "b8c496ae-fe4d-4643-9cfc-5b9d54eda7b3"
            },
            {
              "Alias": "Restriction State",
              "Id": "40877eea-104e-48f5-aed5-6988c51c8388"
            },
            {
              "Alias": "Restriction City",
              "Id": "e525cc75-0fd7-4fc8-8bbe-222340fb282e"
            },
            {
              "Alias": "Restriction type",
              "Id": "b7297738-fa68-4b8e-8e61-0248d0cf0399"
            },
            {
              "Alias": "Restriction Notes",
              "Id": "8dfa39af-c040-432a-89cf-3f04ac649bd3"
            },
            {
              "Alias": "Restriction Effective Date",
              "Id": "58c05647-9033-4bea-b4ef-419c76cc3989"
            },
            {
              "Alias": "Restriction Expire Date",
              "Id": "f38d52da-4d93-4264-ad11-eb0fb345fd81"
            }
          ]
        }
      ],
      "ContainerAttributes": [],
      "Lookups": {},
      "Workflows": []
    }
  ],
  "ShouldIncludeMissingVocabularyAttributes": true,
  "id": "0642243f-73e6-4f04-9037-a118112c2e99",
  "DataOwner": "0642243f-73e6-4f04-9037-a118112c2e99",
  "AuditInfo": {
    "ContextId": "0HMIJ0IF0HD9B:00000002",
    "CreateDate": "2022-06-02T15:27:58.2716912Z",
    "CreatorId": "597a002c-413b-45b8-a76c-e86d3c3e26c6",
    "CreatorName": "Borchardt Adam",
    "LastModifiedDate": "2022-06-21T23:31:41.0037611Z",
    "PrincipleId": "b80fcbd0-040e-4e55-b120-0c100e4f6a29",
    "PrincipleName": "Siegesmund John",
    "MachineName": "importexportservice-68f78bf997-8hbhk"
  },
  "Partition": "0642243f-73e6-4f04-9037-a118112c2e99",
  "Type": "CustomerVocabularySource"
}


Tips
  • The vocabulary also allows you to map recipients so that you can use aliases instead of recipients' guids.
  • You can also map the attribute TargetPartyAlias in the vocabulary. Under the attribute "Lookups" use "Party" to map the recipients:
 "Lookups": {
                "RecipientMapping": {},
                "Party": {
                "Walmart": "f6ab47b5-faa3-4540-831c-4407f98537fb" }
            }
  • To make use of data quality bulk call your vocabulary must include the top-level attribute "ProductIdentifierProperty" for example: globalTradeItemNumber (GTIN).
"ProductIdentifierProperty": "globalTradeItemNumber (GTIN)",

Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.
ESC

Eddy AI, facilitating knowledge discovery through conversational intelligence