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¶
Changed in version 3.3-s60: The
itemConfig.attributes
structure now matchesitem.attributes
structure.Changed in version 3.3-s60: Renamed
itemConfig.qty
toitemConfig.quantity
.Changed in version 3.3-s60: Renamed
itemConfig.barcode
toitemConfig.barcodeList
.Add new units of weight and dimensions in
item.attributes
, and correct the unit required for grams. Resolves BSS-10037.Add details about Pick Service Request Object attributes.
Add descriptions about audit notifications data structure.
PickPack Request Notifications - updated available notifications and notification data examples.
New in version 4.0: Add information about
pickServiceRequest.attributes.simple_priority
in pick orders.New in version 4.0: Add information about Search Service Request
Changed in version 4.1: Add
audit_param_type
to all auditnotifications.
Changed in version 4.1: Add
auditlineNotificationData.quantity_details
to represent a breakup of quantities.New in version 4.2: Add Item Created Notification.
v9.0.2¶
- Fix request and response json information about Creating an Audit. Also, add API to Delete an Audit.
- Put Exception Notifications fixes. Ref BSS-10000.
- Item Un-scannable (put back) - removed
expectations
,id
, andstatus
. - 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
, changedstate
tocomplete
, andstatus
toPROCESSED
.
- Item Un-scannable (put back) - removed
- 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.
- 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 Item Config Object. - Use nested referencing in the documents. For example,
serviceRequest.actuals
instead of justactuals
. - 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
- Removed JSON request body option in Fetch an oauth token section. Resolves BSS-9940.
- Create or Update Items’s example response has been set as the default item_object json example. This resolves BSS-9823.
- PickPack Request Notifications - updated notification examples.
Resolves BSS-9973. Changes:
- Add
status
to start notification - Add
status
to exception notification. - In exception notification example, change top-level service request’s
state
topick_started
because some quantity has been picked successfully, so state would have changed. - Add
status
to complete notification. Fixstate
vsstatus
. - Remove
products
list from pack end notification example. Also add a warning that pack end does not follow the generic notification payload format.
- Add
- 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.
- Filter parameters in Search for an Item API can only be applied on item’s unique schema fields. Resolves BSS-9841.
- Remove possibleUids from pick and put responses and notifications. Resolves BSS-9853.
- Add missing
status
field and correctednotification_seq
tonotification_id
in:- Unfulfillable Notification - BSS-9864
- Pick Started Notification - BSS-9865
- Fulfillable Notification - BSS-9866
- Item Picked Notifications - BSS-9867
- Abandoned Notification - BSS-9871
- Order Complete Notification
- Bin Complete Notification
- Cancelled and Modified Notification
- Cancellation Locked Notification
- Staging cancelled and success notifications in Put Staging Notifications
- Inventory Sync Report notification - BSS-9939
- Add API gateway URLs for audit. Resolves BSS-9907.
- Fix
status
in Put Staging Notifications - staging success. Resolves BSS-9893. - Add
audit_id
andaudit_param_name
in Audit Object and Audit Notifications. Resolves BSS-9900, BSS-9901, BSS-9902, BSS-9903, BSS-9904, BSS-9905. - Add missing
expectations
,state
, andstatus
blocks in Put Exception Notifications. Resolves BSS-9889, BSS-9891. - Add API to Stage a Put Request. Resolves BSS-9970.
- Change Stage a Put Request response error code to 400.
- Add Print Ready API. Resolves BSS-10064.