Changelog

Here is a change log of this document. More details about the software versions mentioned below can be seen here: GreyMatter Release Versions.

v10.1.0

  1. Changed in version 3.3-s60: The itemConfig.attributes structure now matches item.attributes structure.

  2. Changed in version 3.3-s60: Renamed itemConfig.qty to itemConfig.quantity.

  3. Changed in version 3.3-s60: Renamed itemConfig.barcode to itemConfig.barcodeList.

  4. Add new units of weight and dimensions in item.attributes, and correct the unit required for grams. Resolves BSS-10037.

  5. Add details about Pick Service Request Object attributes.

  6. Add descriptions about audit notifications data structure.

  7. PickPack Request Notifications - updated available notifications and notification data examples.

  8. New in version 4.0: Add information about

    pickServiceRequest.attributes.simple_priority in pick orders.

  9. New in version 4.0: Add information about Search Service Request

  10. Changed in version 4.1: Add audit_param_type to all audit

    notifications.

  11. Changed in version 4.1: Add

    auditlineNotificationData.quantity_details to represent a breakup of quantities.

  12. New in version 4.2: Add Item Created Notification.

v9.0.2

  1. Fix request and response json information about Creating an Audit. Also, add API to Delete an Audit.
  2. Put Exception Notifications fixes. Ref BSS-10000.
    • Item Un-scannable (put back) - removed expectations, id, and status.
    • Physically Damaged (put back) - removed expectations, id, status, tote_id.
    • Item Oversized (put back) - removed expectations, id, status.
    • Extra Items (put back) - removed expectations, id, status.
    • Warehouse Full (put back) - removed id, changed state to complete, and status to PROCESSED.
  3. Pick Cancellation and Modification changes. Resolves BSS-9870.
    • Pick cancellation and modification are asynchronous.
    • Add details about transaction id.
    • Remove serviceRequests from cancel pick’s response.
    • Add order information notification after cancellation.
  4. Put Cancellation and Modification changes.
    • Put cancellation and modification are synchronous.
    • Added details about the request and response parameters.
    • Removed everything except id from both responses.
  5. Added put and pick life-cycle diagrams.
  6. Remove unused PkgUOM from Item Config Object.
  7. Use nested referencing in the documents. For example, serviceRequest.actuals instead of just actuals.
  8. Add new units of weight and dimensions in item.attributes, and correct the unit required for grams. Resolves BSS-10037.

v9.0.1

List of changes done from original A9 doc in confluence: https://work.greyorange.com/confluence/display/GRYMTTR/A9+-+GoR+API+Contract

  1. Removed JSON request body option in Fetch an oauth token section. Resolves BSS-9940.
  2. Create or Update Items’s example response has been set as the default item_object json example. This resolves BSS-9823.
  3. PickPack Request Notifications - updated notification examples. Resolves BSS-9973. Changes:
    1. Add status to start notification
    2. Add status to exception notification.
    3. In exception notification example, change top-level service request’s state to pick_started because some quantity has been picked successfully, so state would have changed.
    4. Add status to complete notification. Fix state vs status.
    5. Remove products list from pack end notification example. Also add a warning that pack end does not follow the generic notification payload format.
  4. Add the missing Search for an Item API. Also indicated there that for no matching products, HTTP status 200 with empty list will be returned. Also corrected it’s response JSON. Resolves BSS-8495, BSS-9833, and BSS-9824.
  5. Filter parameters in Search for an Item API can only be applied on item’s unique schema fields. Resolves BSS-9841.
  6. Remove possibleUids from pick and put responses and notifications. Resolves BSS-9853.
  7. Add missing status field and corrected notification_seq to notification_id in:
  8. Add API gateway URLs for audit. Resolves BSS-9907.
  9. Fix status in Put Staging Notifications - staging success. Resolves BSS-9893.
  10. Add audit_id and audit_param_name in Audit Object and Audit Notifications. Resolves BSS-9900, BSS-9901, BSS-9902, BSS-9903, BSS-9904, BSS-9905.
  11. Add missing expectations, state, and status blocks in Put Exception Notifications. Resolves BSS-9889, BSS-9891.
  12. Add API to Stage a Put Request. Resolves BSS-9970.
  13. Change Stage a Put Request response error code to 400.
  14. Add Print Ready API. Resolves BSS-10064.