Resources
Upload resource
URL : /:organizationid/:pimid/api/v0.1/resource
or
URL : /:organizationid/:pimid/api/v0.1/productresource
Using the productresource-URL will start a generation of product-variants after upload. Using the generic resource-URL product/category variants are only generated once the resource is related to a product or category.
URL Parameters:
organizationid=[string]
is the ID of the chainbox.io organization.
pimid=[string]
is the APP ID of the PIM application.
Method: POST
Auth required: YES
Authorization required: write
Request headers:
Content-Type: multipart/form-data; boundary=----xxx
Request body:
FIle-upload with name file
------xxx
Content-Disposition: form-data; name="file"; filename="image.jpg"
Content-Type: image/jpeg
Response body
{ id = "b6b4bb0b-6fb3-4dc9-a2f9-34e333e7d4f4"}
Error Responses
Condition: If basic auth header is not present in request or is incorrect. Code: 401 UNAUTHORIZED
Delete Resource
URL : /:organizationid/:pimid/api/v0.1/resource/:resourceid
URL Parameters:
organizationid=[string]
is the ID of the chainbox.io organization.
pimid=[string]
is the APP ID of the PIM application.
resourceid=[string]
is the ID of the Resource to be deleted.
Method: DELETE
Auth required: YES
Authorization required: write
Error Responses
Condition: If basic auth header is not present in request or is incorrect. Code: 401 UNAUTHORIZED
Condition: Referencing an invalid product. Code: 404 NOT FOUND
Download Resource
URL : /:organizationid/:pimid/api/v0.1/resource/:resourceid/download?variant=default
URL Parameters:
organizationid=[string]
is the ID of the chainbox.io organization.
pimid=[string]
is the APP ID of the PIM application.
resourceid=[string]
is the ID of the Resource to be deleted.
variant=[string]
is the variant-identifier to be downloaded. Leaving the parameter out, will download the original file.
Method: GET
Auth required: YES
Authorization required: read
Error Responses
Condition: If basic auth header is not present in request or is incorrect. Code: 401 UNAUTHORIZED
Condition: Referencing an invalid product. Code: 404 NOT FOUND
Relate resource to product
URL : /:organizationid/:pimid/api/v0.1/productresource/:resourceid/relate
URL Parameters:
organizationid=[string]
is the ID of the chainbox.io organization.
pimid=[string]
is the APP ID of the PIM application.
resourceid=[string]
is the ID of the Resource to be deleted.
Method: POST
Auth required: YES
Authorization required: write
Request headers:
Content-Type: application/json
Request body:
{ "productid" = "123" }
Error Responses
Condition: If basic auth header is not present in request or is incorrect. Code: 401 UNAUTHORIZED
UnRelate resource from product
URL : /:organizationid/:pimid/api/v0.1/productresource/:resourceid/unrelate
URL Parameters:
organizationid=[string]
is the ID of the chainbox.io organization.
pimid=[string]
is the APP ID of the PIM application.
resourceid=[string]
is the ID of the Resource to be deleted.
Method: POST
Auth required: YES
Authorization required: write
Request headers:
Content-Type: application/json
Request body:
{ "productid" = "123" }
Error Responses
Condition: If basic auth header is not present in request or is incorrect. Code: 401 UNAUTHORIZED
Last updated