Changelog
#########

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

v10.1.0
*******

#. .. versionchanged:: 3.3-s60 The :gm:data:`itemConfig.attributes` structure
      now matches :gm:data:`item.attributes` structure.

#. .. versionchanged:: 3.3-s60 Renamed ``itemConfig.qty`` to
      :gm:data:`itemConfig.quantity`.

#. .. versionchanged:: 3.3-s60 Renamed ``itemConfig.barcode`` to
      :gm:data:`itemConfig.barcodeList`.

#. Add new units of weight and dimensions in :gm:data:`item.attributes`, and
   correct the unit required for grams. Resolves :jira:`BSS-10037`.

#. Add details about :ref:`Pick Service Request Object` attributes.

#. Add descriptions about audit notifications data structure.

#. :ref:`PickPack Request Notifications` - updated available notifications and
   notification data examples.

#. .. versionadded:: 4.0 Add information about
   :gm:data:`pickServiceRequest.attributes.simple_priority` in pick orders.

#. .. versionadded:: 4.0 Add information about :ref:`Search Service Request`

#. .. versionchanged:: 4.1 Add :gm:data:`audit_param_type` to all audit
   notifications.

#. .. versionchanged:: 4.1 Add
   :gm:data:`auditlineNotificationData.quantity_details` to represent a breakup
   of quantities.

#. .. versionadded:: 4.2 Add :ref:`Item Created Notification`.

v9.0.2
******

#. Fix request and response json information about :ref:`Creating an Audit`.
   Also, add API to :ref:`Delete an Audit`.

#. :ref:`Put Exception Notifications` fixes. Ref :jira:`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``.

#. Pick Cancellation and Modification changes. Resolves :jira:`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.

#. 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.

#. Added put and pick life-cycle diagrams.

#. Remove unused ``PkgUOM`` from :ref:`Item Config Object`.

#. Use nested referencing in the documents. For example,
   :gm:data:`serviceRequest.actuals` instead of just ``actuals``.

#. Add new units of weight and dimensions in :gm:data:`item.attributes`, and
   correct the unit required for grams. Resolves :jira:`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

#. Removed JSON request body option in :ref:`Fetch an oauth token` section.
   Resolves :jira:`BSS-9940`.

#. :ref:`Create or Update Items`\ 's example response has been set as the
   default item_object json example. This resolves :jira:`BSS-9823`.

#. :ref:`PickPack Request Notifications` - updated notification examples.
   Resolves :jira:`BSS-9973`. Changes:

   #. Add ``status`` to start notification
   #. Add ``status`` to exception notification.
   #. 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.
   #. Add ``status`` to complete notification. Fix ``state`` vs ``status``.
   #. Remove ``products`` list from pack end notification example. Also add a
      warning that pack end does not follow the generic notification payload
      format.

#. Add the missing :ref:`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 :jira:`BSS-8495`, :jira:`BSS-9833`,
   and :jira:`BSS-9824`.

#. Filter parameters in :ref:`Search for an Item` API can only be applied on
   item's unique schema fields. Resolves :jira:`BSS-9841`.

#. Remove possibleUids from pick and put responses and notifications. Resolves
   :jira:`BSS-9853`.

#. Add missing ``status`` field and corrected ``notification_seq`` to
   ``notification_id`` in:

   * :ref:`Unfulfillable Notification` - :jira:`BSS-9864`
   * :ref:`Pick Started Notification` - :jira:`BSS-9865`
   * :ref:`Fulfillable Notification` - :jira:`BSS-9866`
   * :ref:`Item Picked Notifications` - :jira:`BSS-9867`
   * :ref:`Abandoned Notification` - :jira:`BSS-9871`
   * :ref:`Order Complete Notification`
   * :ref:`Bin Complete Notification`
   * :ref:`Cancelled and Modified Notification`
   * :ref:`Cancellation Locked Notification`
   * Staging cancelled and success notifications in :ref:`Put Staging
     Notifications`
   * :ref:`Inventory Sync Report` notification - :jira:`BSS-9939`

#. Add API gateway URLs for audit. Resolves :jira:`BSS-9907`.

#. Fix ``status`` in :ref:`Put Staging Notifications` - staging success.
   Resolves :jira:`BSS-9893`.

#. Add ``audit_id`` and ``audit_param_name`` in :ref:`Audit Object` and
   :ref:`Audit Notifications`. Resolves :jira:`BSS-9900`, :jira:`BSS-9901`,
   :jira:`BSS-9902`, :jira:`BSS-9903`, :jira:`BSS-9904`, :jira:`BSS-9905`.

#. Add missing ``expectations``, ``state``, and ``status`` blocks in :ref:`Put
   Exception Notifications`. Resolves :jira:`BSS-9889`, :jira:`BSS-9891`.

#. Add API to :ref:`Stage a Put Request`. Resolves :jira:`BSS-9970`.

#. Change :ref:`Stage a Put Request` response error code to 400.

#. Add :ref:`Print Ready API`. Resolves :jira:`BSS-10064`.