Get all products with all attributes.
| Name | Required | Located in | Type | Description |
|---|---|---|---|---|
| category | false | query | string () | Filter by product category (e.g., "gizmo") |
| Field | Type | Description |
|---|---|---|
| product_id | string | Unique identifier representing a specific product for a given latitude & longitude. For example, uberX in San Francisco will have a different product_id than uberX in Los Angeles. |
| description | string | Description of product. |
| display_name | string | Display name of product. |
| category | string | Category of product. For example, "gizmo". |
| Field | Type | Description |
|---|---|---|
| code | integer | |
| message | string | |
| fields | string |
Create a product with the provided attributes.
| Name | Required | Located in | Type | Description |
|---|---|---|---|---|
| description | body | string () | Description of product. | |
| display_name | body | string () | Display name of product. | |
| category | body | string () | Product category. |
| Field | Type | Description |
|---|---|---|
| product_id | integer | New product's id. |
| Field | Type | Description |
|---|---|---|
| code | integer | |
| message | string | |
| fields | string |
Update a subset of a product's attributes.
| Name | Required | Located in | Type | Description |
|---|---|---|---|---|
| product_id | URL | integer () | Product ID. | |
| description | body | string () | Description of product. | |
| display_name | body | string () | Display name of product. | |
| category | body | string () | Product category. |
| Field | Type | Description |
|---|---|---|
| product_id | integer | Updated product's id. |
| Field | Type | Description |
|---|---|---|
| code | integer | |
| message | string | |
| fields | string |
Update a all of a product's attributes.
| Name | Required | Located in | Type | Description |
|---|---|---|---|---|
| product_id | URL | integer () | Product ID. | |
| description | body | string () | Description of product. | |
| display_name | body | string () | Display name of product. | |
| category | body | string () | Product category. |
| Field | Type | Description |
|---|---|---|
| product_id | integer | Updated product's id. |
| Field | Type | Description |
|---|---|---|
| code | integer | |
| message | string | |
| fields | string |
Delete a product with a give ID.
| Name | Required | Located in | Type | Description |
|---|---|---|---|---|
| product_id | URL | integer () | Product ID. |
| Field | Type | Description |
|---|---|---|
| success | boolean | "true" for successful delete. |
| Field | Type | Description |
|---|---|---|
| code | integer | |
| message | string | |
| fields | string |