Inventory management, including querying inventory status for products.
Filter parameters for the ListItems method.
| Field | Type | Label | Description |
| filter | StockItemFilter | optional | Optional. Filters for the stock items to return. |
| page_size | int32 | Optional. The page size of the response. |
|
| page_token | string | Optional. Token for which page to return, obtained from next_page_token. Leave empty for the first page. |
Response from ListItems
| Field | Type | Label | Description |
| items | StockItem | repeated | StockItems matching the supplied filters. |
| next_page_token | string | Optional. Token used to obtain the next page. Empty if this is the last page. |
Information about a stock item.
| Field | Type | Label | Description |
| sku | string | Product SKU/Stock-keeping-unit, globally unique for each product. |
|
| warehouse_id | string | Which warehouse these items are contained in. UUID in string-format. |
|
| read_time | google.protobuf.Timestamp | When this stock item was read, UTC per definition. |
|
| updated_time | google.protobuf.Timestamp | When this stock item was last modified. |
|
| available_quantity | int64 | Available item quantity. |
Filter parameters for the StreamItems method.
| Field | Type | Label | Description |
| sku | string | optional | Optional. Product SKU to filter inventory items by. |
| warehouse_id | string | optional | Optional. Warehouse to filter results by. UUID in string-format. Note: The available warehouse-ids depend on the permissions granted to the client. |
| modified_since_time | google.protobuf.Timestamp | optional | Optional. Timestamp to filter results by, will include items created or updated after the given timestamp. |
Request for streamed StockItems.
| Field | Type | Label | Description |
| filter | StockItemFilter | optional | Optional. Filters for the stock items to return. |
Service exposing inventory information.
| Method Name | Request Type | Response Type | Description |
| StreamStockItems | StreamStockItemsRequest | StockItem stream | Returns a stream of items matching the given filters. |
| ListStockItems | ListStockItemsRequest | ListStockItemsResponse | Query stock items based on a filter, returning a paginated result. |
Tracking number for a parcel which is to be sent or has been sent.
| Field | Type | Label | Description |
| number | string | Tracking number for a parcel. |
Status describing the current phase the order is in.
| Name | Number | Description |
| ORDER_STATUS_UNSPECIFIED | 0 | Unknown order status. |
| ORDER_STATUS_ORDERED | 1 | Order has been created. |
| ORDER_STATUS_HOLD | 2 | Order is on-hold. |
| ORDER_STATUS_PICKING | 3 | Order-items are being picked. |
| ORDER_STATUS_FULFILLED | 4 | Order has been fulfilled (shipped/packaged/pending-sending). |
| ORDER_STATUS_CANCELLED | 5 | Order has been cancelled. |
Datatypes and services for orders.
Request for querying order status of a specific order.
| Field | Type | Label | Description |
| order_id | string | Required. Order identifier. |
The current order status information for the requested order id.
| Field | Type | Label | Description |
| order_id | string | Order identifier. |
|
| order_status | awardit.order.OrderStatus | Order status. |
|
| created_time | google.protobuf.Timestamp | When the order was created. |
|
| updated_time | google.protobuf.Timestamp | When the order was last updated. |
|
| tracking_numbers | awardit.order.TrackingNumber | repeated | Parcels for the order, will be empty for virtual orders or if the order has not yet been picked. Some shipping methods do not provide any tracking information or parcel data. |
Service for querying information about orders.
| Method Name | Request Type | Response Type | Description |
| GetOrderStatusInformation | GetOrderStatusInformationRequest | OrderStatusInformation | Attempts to retrieve the order-status of a given order. |
| .proto Type | Notes | C++ | Java | Python | Go | C# | PHP | Ruby |
| double | double | double | float | float64 | double | float | Float | |
| float | float | float | float | float32 | float | float | Float | |
| int32 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| int64 | Uses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| uint32 | Uses variable-length encoding. | uint32 | int | int/long | uint32 | uint | integer | Bignum or Fixnum (as required) |
| uint64 | Uses variable-length encoding. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum or Fixnum (as required) |
| sint32 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sint64 | Uses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| fixed32 | Always four bytes. More efficient than uint32 if values are often greater than 2^28. | uint32 | int | int | uint32 | uint | integer | Bignum or Fixnum (as required) |
| fixed64 | Always eight bytes. More efficient than uint64 if values are often greater than 2^56. | uint64 | long | int/long | uint64 | ulong | integer/string | Bignum |
| sfixed32 | Always four bytes. | int32 | int | int | int32 | int | integer | Bignum or Fixnum (as required) |
| sfixed64 | Always eight bytes. | int64 | long | int/long | int64 | long | integer/string | Bignum |
| bool | bool | boolean | boolean | bool | bool | boolean | TrueClass/FalseClass | |
| string | A string must always contain UTF-8 encoded or 7-bit ASCII text. | string | String | str/unicode | string | string | string | String (UTF-8) |
| bytes | May contain any arbitrary sequence of bytes. | string | ByteString | str | []byte | ByteString | string | String (ASCII-8BIT) |