Skip to main content
Aria Knowledge Central

get_client_item_images_m Sample Call and Response

This example shows a client retrieving all images associated with one inventory item, based on the get_client_item_images_m method defined in plsql_m_r73.yml. A storefront can use these images to display an item's thumbnail and full-size product art.

The example looks up the item by its Aria-assigned item number. It does not cover a lookup by client-defined SKU, and it does not cover the deprecated client_item_id field.

Sample call

{
  "rest_call": "get_client_item_images_m",
  "output_format": "json",
  "client_no": 4009,
  "auth_key": "a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6",
  "item_no": 71042
}

The item_no field and the client_sku field form an alternative-required pair; this example supplies item_no, the Aria-assigned numeric identifier, and omits client_sku. This example omits the client_item_id field, which carries a deprecate_version and no longer belongs in a current integration, and the nonpublic do_logging_ind field. The rest_call and output_format fields are added by the REST layer.

Sample response

{
  "error_code": 0,
  "error_msg": "",
  "item_images": [
    {
      "image_class_name": "Thumbnail",
      "image_class_no": 1,
      "image_class_seq_no": 1,
      "image_url": "https://static.ariasystems.example/items/71042/thumbnail.png",
      "image_text": "Streaming Platinum Bundle thumbnail",
      "default_ind": 1
    },
    {
      "image_class_name": "Full",
      "image_class_no": 2,
      "image_class_seq_no": 1,
      "image_url": "https://static.ariasystems.example/items/71042/full.png",
      "image_text": "Streaming Platinum Bundle full product image",
      "default_ind": 0
    }
  ]
}

An error_code value of zero together with an empty error_msg indicates that Aria found and returned the item's images successfully. The item_images field is an array because an inventory item can have more than one associated image; this example shows two representative entries, a thumbnail and a full-size image, but an item with more image classes configured could return several more. The default_ind field is a boolean value; only the Thumbnail entry shows a value of one, meaning that image is the default for that image class, while the Full entry shows a value of zero. This example omits the error_details field.

TOP
  • Was this article helpful?