Item Inquiry ############ Pricing and Availability service .. code-block:: none :caption: Service Endpoint POST https://gateway.groupvan.com/json/federated/v3_1/item_inquiry Request ------- ``items`` array is required to make a request from Buyer system. GroupVAN Gateway handles user locations and account info before forwarding the request to the Seller system. Buyers can request a subset of their available locations by adding them to the request in the ``locations`` array. Only locations defined in the array will be returned. To see all available locations, omit the ``locations`` array from the request. Parameters ~~~~~~~~~~ ``items`` :bdg:`array` :bdg-danger:`required` An array of items to request from the seller system ``id`` :bdg:`string` :bdg-danger:`required` Unique ID assigned by the seller system ``mfr_code`` :bdg:`string` :bdg-danger:`required` Manufacturer Code ``part_number`` :bdg:`string` :bdg-danger:`required` Part Number ``locations`` :bdg:`array` An optional array of locations to request from the seller system. ``id``, ``member`` & ``account`` are required if using locations array ``id`` :bdg:`string` :bdg-warning:`optionally required` Location ID in GroupLink ``member`` :bdg:`string` :bdg-warning:`optionally required` Member ID in GroupLink ``account`` :bdg:`string` :bdg-warning:`optionally required` Account ID in Member System Examples ~~~~~~~~ .. tab:: Buyer .. code-block:: json { "items": [ { "id": "1421", "mfr_code": "BAR", "part_number": "2522002" }, { "id": "6321", "mfr_code": "FEF", "part_number": "LF115F" } ] } .. tab:: Seller .. code-block:: json { "service": "item_inquiry", "integration": "B2C", "terminal_id": "optional field", "locations": [ { "id": "Loc0012", "member": "520", "account": "12345" } ], "items": [ { "id": "1421", "mfr_code": "BAR", "part_number": "2522002" }, { "id": "6321", "mfr_code": "FEF", "part_number": "LF115F" } ] } Schema ~~~~~~~~ .. dropdown:: Request JSON Schema .. code-block:: json { "type": "object", "properties": { "service": { "type": "string" }, "integration": { "type": "string" }, "terminal_id": { "type": "string" }, "locations": { "type": "array", "items": [ { "type": "object", "properties": { "id": { "type": "string" }, "member": { "type": "string" }, "account": { "type": "string" } }, "required": [ "id", "member", "account" ] } ] }, "items": { "type": "array", "items": [ { "type": "object", "properties": { "id": { "type": "string" }, "mfr_code": { "type": "string" }, "part_number": { "type": "string" } }, "required": [ "id", "mfr_code", "part_number" ] } ] } }, "required": [ "service", "locations", "items" ] } Response -------- Seller must return the same ``id`` as defined by the Buyer system. See notes below for attaching alternate items. Examples ~~~~~~~~ .. tab:: Buyer .. code-block:: json { "status_code": 2000, "items": [ { "id": "1421", "mfr_code": "BAR", "part_number": "2522002", "part_description": "Automatic Transmission Fluid", "mfr_description": "Beck Arnley", "comment": "", "weight": 2.22, "status_code": 1, "locations": [ { "id": "Loc0012", "description": "Fisher Auto Parts - TESTXX", "can_order": true, "sort_order": 1, "type": 1 "cost": 8.79, "list": 12.89, "core": 1.15, "bundle_cost": 28.17, "pack_code": "EA", "pack_quantity": 1, "quantity_available": 5, "route_times": [ { "cutoff_time": "2020-07-31 11:00:00", "arrival_time": "2020-07-31 12:08:00", "pickup_time": "2020-07-31 12:08:00", "route_code": "050" } ] } ] }, { "id": "1421", "mfr_code": "BFR", "part_number": "2522002", "original_part": "2522002", "original_mfr": "BAR", "part_description": "Automatic Transmission Fluid", "mfr_description": "Beck Arnley", "comment": "THIS IS AN ALTERNATE", "weight": 2.22, "status_code": 2, "locations": [ { "id": "Loc0012", "description": "Fisher Auto Parts - TESTXX", "can_order": true, "sort_order": 1, "type": 1 "cost": 8.79, "list": 12.89, "pack_code": "EA", "pack_quantity": 1, "quantity_available": 0, "route_times": [ { "cutoff_time": "2020-07-31 11:00:00", "arrival_time": "2020-07-31 12:08:00", "pickup_time": "2020-07-31 12:08:00", "route_code": "050" } ] } ] } ] } .. tab:: Seller .. code-block:: json { "status_code": 2000, "items": [ { "id": "1421", "mfr_code": "BAR", "part_number": "2522002", "part_description": "Automatic Transmission Fluid", "mfr_description": "Beck Arnley", "comment": "", "weight": 2.22, "status_code": 1, "locations": [ { "id": "Loc0012", "cost": 8.79, "list": 12.89, "core": 0.0, "bundle_cost": 0.0, "pack_code": "EA", "pack_quantity": 1, "quantity_available": 5, "route_times": [ { "cutoff_time": "2020-07-31 11:00:00", "arrival_time": "2020-07-31 12:08:00", "pickup_time": "2020-07-31 12:08:00", "route_code": "050" } ] } ] }, { "id": "1421", "mfr_code": "BFR", "part_number": "2522002", "original_part": "2522002", "original_mfr": "BAR", "part_description": "Automatic Transmission Fluid", "mfr_description": "Beck Arnley", "comment": "THIS IS AN ALTERNATE", "weight": 2.22, "status_code": 2, "locations": [ { "id": "Loc0012", "cost": 8.79, "list": 12.89, "pack_code": "EA", "pack_quantity": 1, "quantity_available": 0, "route_times": [ { "cutoff_time": "2020-07-31 11:00:00", "arrival_time": "2020-07-31 12:08:00", "pickup_time": "2020-07-31 12:08:00", "route_code": "050" } ] } ] } ] } Schema ~~~~~~~~ .. dropdown:: Response JSON Schema .. code-block:: json { "type": "object", "properties": { "status_code": { "type": "integer" }, "items": { "type": "array", "items": [ { "type": "object", "properties": { "id": { "type": "string" }, "mfr_code": { "type": "string" }, "part_number": { "type": "string" }, "original_part": { "type": "string" }, "original_mfr": { "type": "string" }, "part_description": { "type": "string" }, "mfr_description": { "type": "string" }, "comment": { "type": "string" }, "weight": { "type": "float" }, "status_code": { "type": "integer" }, "locations": { "type": "array", "items": [ { "type": "object", "properties": { "id": { "type": "string" }, "description": { "type": "string" }, "type": { "type": "integer" }, "cost": { "type": "float" }, "list": { "type": "float" }, "core": { "type": "float" }, "bundle_cost": { "type": "float" }, "pack_code": { "type": "string" }, "pack_quantity": { "type": "integer" }, "quantity_available": { "type": "float" }, "route_times": { "type": "array", "items": [ { "type": "object", "properties": { "cutoff_time": { "type": "string" }, "arrival_time": { "type": "string" }, "pickup_time": { "type": "string" }, "route_code": { "type": "string" } }, "required": [ "cutoff_time", "arrival_time", "pickup_time", "route_code" ] } ] } }, "required": [ "id", "cost", "list", "pack_code", "pack_quantity", "quantity_available", ] } ] } }, "required": [ "id", "mfr_code", "part_number", "status_code", "locations" ] } ] } }, "required": [ "status_code", "items" ] } .. important:: ``original_part`` and ``original_mfr`` are required for Alternate, Superseded and Equivalent parts. These fields should match the original manufacturer code and part number requested by the Buyer. .. tip:: ``comment`` fields are optional and can by used to return a human readable message to the buyer