General

Objects

Codes

Product Component GET

Stability: 3 - Frozen

A product component is primarily a merchant object, which represents an sub-item group of the parent item for sale on the Shopwave platform. A product component along with its parent item can be placed into a basket and be sold with associated transactions. Products component can have associated stock detail per store, which are tracked and can be reported on.

This API GET call allows you to retrieve each of these product component objects with full detail.

The endpoint you need to use for this is:

/product/component

Request

Headers

Key	Details	Example
Authorization*	{token_type} {access_token}	Bearer c3499c2729730a7f807efb8676a92dcb6f8a3f8f
Method*	GET	GET
x-accept-version	{recommended_latest_version_number}	2

* Required header

Response

Headers

Key	Details	Data Type	Example
statusCode	Very important to check this for shopwave server uptime. 200 for success.	int	200

Body

Key	Details	Data Type
productComponents[{productComponentId}].id	unique product Id	Int
productComponents[{productComponentId}].name	A name which is able to identify the product component.	String
productComponents[{productComponentId}].minQuantity	The minimum selectable quantity for this component.	Int
productComponents[{productComponentId}].maxQuantity	The maximum selectable quantity for this component.	Int
productComponents[{productComponentId}].productTimestamp	The date at which the product was added.	DateTime
productComponents[{productComponentId}].deleteDate	The date at which the product component was deleted.	DateTime
productComponents[{productComponentId}].products	An array of products (options) for this component.	Array
...products[{productId}].id	unique product Id	Int
...products[{productId}].barcode	The unique barcode for the product.	String
...products[{productId}].name	A name which is able to identify the product.	String
...products[{productId}].details	Extra details which are important for the product.	String
...products[{productId}].activeDate	The date at which the product became active. If this is null then the product is not currently active.	DateTime
...products[{productId}].images	An array of product image URL strings.	Array
...products[{productId}].productInstances	Availiable instances of the product for this component.	Array
...productInstances[{productInstanceId}].id	unique product Id	Int
...productInstances[{productInstanceId}].name	A name which is able to identify the product.	String
...productInstances[{productInstanceId}].price	The most recent and currently active product sale price.	String
...productInstances[{productInstanceId}].vatPercentage	The most recent and currently active product vat percentage.	String
...productInstances[{productInstanceId}].quantity	The default quantity for thi product instance.	Int

{
    "productComponents": {
        "893": {
            "id": 5432,
            "name": "Size",
            "productId": 45678,
            "minQuantity": 1,
            "maxQuantity": 1,
            "productTimestamp": "2017-08-01T20:00:34.000Z",
            "deleteDate": "2017-01-16T11:06:41.000Z",
            "products": {
                "56787": {
                    "id": 56787,
                    "name": "Large",
                    "barcode": "",
                    "details": "",
                    "unit": null,
                    "activeDate": null,
                    "images": [
                        "http://static.merchantstack.com/images/merchant/2765/product/352bf247e2a163623ab76859a65d564a8fa59cd4.jpg"
                    ],
                    "productInstances": {
                        "456789453678": {
                            "id": 456789453678,
                            "name": null,
                            "price": "123.3",
                            "activeDate": "2017-01-13T14:55:18.000Z",
                            "vatPercentage": "0.200",
                            "size": null,
                            "quantity": 0
                        }
                    }
                },
                "56788": {
                    "id": 56788,
                    "name": "Medium",
                    "barcode": "",
                    "details": "",
                    "unit": null,
                    "activeDate": "2016-12-19T15:06:22.000Z",
                    "images": [
                        "http://static.merchantstack.com/images/merchant/2765/product/145f73a2694037a6a536bf71a4d2923ae0795e57.jpg"
                    ],
                    "productInstances": {
                        "456783244": {
                            "id": 456783244,
                            "name": null,
                            "price": "83.3",
                            "activeDate": "2017-01-13T14:55:18.000Z",
                            "vatPercentage": "0.200",
                            "size": null,
                            "quantity": 0
                        }
                    }
                },
                "56789": {
                    "id": 56789,
                    "name": "Small",
                    "barcode": "",
                    "details": "",
                    "unit": null,
                    "activeDate": "2016-12-19T15:05:19.000Z",
                    "images": [
                        "http://static.merchantstack.com/images/merchant/2765/product/9ecf732807d7c2e05dc24fd638f2410f8407afaf.jpg"
                    ],
                    "productInstances": {
                        "232342424": {
                            "id": 232342424,
                            "name": null,
                            "price": "43.3",
                            "activeDate": "2017-01-13T14:55:18.000Z",
                            "vatPercentage": "0.200",
                            "size": null,
                            "quantity": 0
                        }
                    }
                }
            }
        }
    },
    "api": {
        "message": {
            "success": {
                "202": {
                    "id": 202,
                    "code": "tokenValid",
                    "title": "Token is valid",
                    "details": "Token is validated and found valid."
                },
                "203": {
                    "id": 203,
                    "code": "requestSuccessful",
                    "title": "Request Processed Successfully",
                    "details": "The request has been successfully completed."
                }
            }
        },
        "codeBaseVersion": 2,
        "executionTime_milliSeconds": 12
    }
}

Status Codes

Error

Please check the live API calls for more details on the API messages.

ID	Status Code	Title	Details
908	401	Expired Token	Token expired or invalid. Please renew your token
911	401	Authorization Header Invalid	The authorization header is invalid. The correct format is Authorization: {token_type} {accessToken}
912	403	Resource Not Allowed For Specified User	The user does not own this resource and its forbidden
899	500	Unknown Error	Something went wrong. Please contact the site administrator
917	500	Internal Server Error	Something went wrong.

Success

Please check the live API calls for more details on the API messages.

ID	Status Code	Title	Details
203	200	Request Processed Successfully	The request has been successfully completed.
204	204	No content to return	End of the page or no content to return for your request
202	200	Token is valid	Token is validated and found valid.

Request
- Headers
Response
- Headers
- Body
Status Codes
- Error
- Success
Top