Item instructions

Edit online

Occasionally, some items might require special handling or shipping instruction. To avoid mixing up item instruction with item description, the catalog service provides the item instruction declaration capability.

A catalog manager can associate one or more instructions to an item and each instruction is classified by the following parameters. The following fields are not mandatory.

Instruction Code - Code defined by the catalog manager to represent a set of internal instructions.
Instruction Text - Text that can be exposed by the catalog manager to allow staff to follow specific instruction.
Instruction Type - Instruction might have various type such as For Packing, For Shipping, For Pickup, and so on.
Sequence Number - Multiple instruction sets are supported. The catalog manager can assign a sequence number to the instructions so that they can be completed in the order of sequence.

To set the instruction set, use the Upsert Instructions API.

PATCH
https://api.watsoncommerce.ibm.com/catalog/{tenantid}/v1/itemInstructions

{

  "itemId": "WINE_CHEESE_GIFTSET",

  "unitOfMeasure": "EACH",

  "itemInstructions": [

    {

      "instructionCode": "FSWC001",

      "instructionText": "Fragile, use bubble wrap",

      "instructionType": "For Shipping",

      "sequenceNo": 1

    },

    {

      "instructionCode": "FPWC001",

      "instructionText": "Fragile, inform customer to handle with care",

      "instructionType": "For Pickup",

      "sequenceNo": 1

    }

  ]

}

To verify if the instruction is correctly assigned, you can use Get Instructions API or Get Item Details API.

Get Item Details API.

GET https://api.watsoncommerce.ibm.com/catalog/{tenantid} /v1/itemDetails?itemId=WINE_CHEESE_GIFTSET&unitOfMeasure=EACH

Response:

{

    "itemId": "WINE_CHEESE_GIFTSET",

    "unitOfMeasure": "EACH",

    "itemGroupCode": "PROD",

    "primaryInformation": {"kitCode": "BUNDLE"},

    "components": […],

    "itemInstructions": [

        {

            "instructionCode": "FSWC001",

            "instructionText": "Fragile, use bubble wrap",

            "instructionType": "For Shipping",

            "sequenceNo": 1

        },

        {

            "instructionCode": "FPWC001",

            "instructionText": "Fragile, inform customer to handle with care",

            "instructionType": "For Pickup",

            "sequenceNo": 1

        }

    ]

}