---
title: "Brandstore API"
url: "https://earlyaccess.developers.bynder.com/apis/brandstore-api-1/versions/9733d306-d818-499d-9b63-61b3136d2eea"
---

# Brandstore API

OpenAPI specification document.

```json
{"components":{"securitySchemes":{"OAuth2":{"flows":{"authorizationCode":{"authorizationUrl":"https://{your-auth-url}","scopes":{"brandstore.orderadmin.edit":"","brandstore.orderadmin.view":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"},"clientCredentials":{"scopes":{"brandstore.orderadmin.edit":"","brandstore.orderadmin.view":""},"tokenUrl":"https://{your-bynder-domain}/v6/authentication/oauth2/token"}},"type":"oauth2"},"permanentToken":{"in":"header","name":"Authorization","type":"apiKey"}}},"info":{"title":"Brandstore API","version":"1.0.0"},"openapi":"3.1.0","paths":{"/api/store/order/":{"get":{"parameters":[{"in":"query","name":"page","required":false,"schema":{"example":1,"type":"integer"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"properties":{"account_name":{"example":"Bynder","type":"string"},"currency_symbol":{"example":"8364","type":"string"},"date_created":{"example":"2018-10-25T14:26:01+00:00","type":"string"},"id":{"example":"00000000-0000-0000-0000-000000000000","type":"string"},"net_price":{"example":0,"type":"number"},"order_ref":{"example":"NA13334","type":"string"},"order_status":{"example":"In production","type":"string"},"username":{"example":"john.doe@bynder.com","type":"string"}},"type":"object"},"type":"array"}}},"description":"A list of orders"}},"security":[{"permanentToken":["brandstore.orderadmin.view"]},{"OAuth2":["brandstore.orderadmin.view"]}],"summary":"Retrieve orders","tags":["Orders"]}},"/api/store/order/{id}/":{"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"example":"00000000-0000-0000-0000000000000000","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"dateCreated":{"example":"2015-06-01T08:36:18Z","type":"string"},"id":{"example":"00000000-0000-0000-0000000000000000","type":"string"},"orderReference":{"example":"NL0456","type":"string"},"status":{"example":"IN_PRODUCTION","type":"string"}},"type":"object"}}},"description":"Specific order information"}},"security":[{"permanentToken":["brandstore.orderadmin.view"]},{"OAuth2":["brandstore.orderadmin.view"]}],"summary":"Retrieve specific order info","tags":["Orders"]}},"/api/store/order/{id}/products":{"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"example":"00000000-0000-0000-0000000000000000","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"items":{"properties":{"id":{"example":"00000000-0000-0000-0000-000000000000","type":"string"},"itemPrice":{"example":0.2333,"type":"number"},"name":{"example":"Train the trainer product","type":"string"},"orderId":{"example":"00000000-0000-0000-0000-000000000000","type":"string"},"product":{"properties":{"datecreated":{"example":"2016-08-10T12:14:16+00:00","type":"string"},"default_quantity":{"example":1,"type":"integer"},"description":{"example":"This is such a nice product!","type":"string"},"display_length_unit":{"example":"cm","type":"string"},"id":{"example":"00000000-0000-0000-0000-000000000000","type":"string"},"isActive":{"example":true,"type":"boolean"},"isFeatured":{"example":false,"type":"boolean"},"isFree":{"example":false,"type":"boolean"},"isShipping":{"example":false,"type":"boolean"},"max_quantity":{"example":10,"type":"integer"},"min_quantity":{"example":1,"type":"integer"},"name":{"example":"Train the trainer product","type":"string"},"product_number":{"example":"999999999","type":"string"},"product_package":{"example":"unit","type":"string"},"product_type":{"example":"print","type":"string"},"size_depth":{"example":1,"type":"number"},"size_height":{"example":1,"type":"number"},"size_width":{"example":1,"type":"number"},"sku":{"example":"1","type":"string"},"step":{"example":1,"type":"integer"},"weight":{"example":1,"type":"number"}},"type":"object"},"quantity":{"example":3,"type":"integer"},"referenceId":{"example":"999999999","type":"string"}},"type":"object"},"type":"array"}}},"description":"Specific order products"}},"security":[{"permanentToken":["brandstore.orderadmin.edit"]},{"OAuth2":["brandstore.orderadmin.edit"]}],"summary":"Retrieve specific order by id","tags":["Orders"]},"post":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"example":"00000000-0000-0000-0000000000000000","type":"string"}}],"requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"properties":{"message":{"example":"Order has been delivered","type":"string"},"status":{"enum":["IN_PROGRESS","CANCELED","FAILED","WAITING_FOR_PAYMENT","FOR_ORDER","IN_PRODUCTION","PRODUCTION_SUSPENDED","OUT_FOR_DELIVERY","FINISHED"],"example":"IN_PROGRESS","type":"string"},"trackingnumber":{"example":"trackingnumber","type":"string"}},"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Created","type":"string"},"status_code":{"example":201,"type":"integer"}},"type":"object"}}},"description":"Order modified"}},"security":[{"permanentToken":["brandstore.orderadmin.edit"]},{"OAuth2":["brandstore.orderadmin.edit"]}],"summary":"Modify order","tags":["Orders"]}},"/api/store/orderproducts/{id}":{"get":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"example":"00000000-0000-0000-0000000000000000","type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"properties":{"customerReference":{"example":"000000000000","type":"string"},"id":{"example":"00000000-0000-0000-0000-000000000000","type":"string"},"orderId":{"example":"00000000-0000-0000-0000-000000000000","type":"string"},"status":{"example":"unknown","type":"string"}},"type":"object"}}},"description":"Specific orderline information"}},"security":[{"permanentToken":["brandstore.orderadmin.view"]},{"OAuth2":["brandstore.orderadmin.view"]}],"summary":"Retrieve specific orderline","tags":["Orders"]},"patch":{"parameters":[{"in":"path","name":"id","required":true,"schema":{"example":"00000000-0000-0000-0000000000000000","type":"string"}}],"requestBody":{"content":{"application/json":{"schema":{"properties":{"customerReference":{"example":"000000000000","type":"string"},"status":{"enum":["approved","rejected"],"example":"approved","type":"string"}},"type":"object"}}},"required":true},"responses":{"201":{"content":{"application/json":{"schema":{"properties":{"message":{"example":"Created","type":"string"},"status_code":{"example":201,"type":"integer"}},"type":"object"}}},"description":"Orderline modified"}},"security":[{"permanentToken":["brandstore.orderadmin.edit"]},{"OAuth2":["brandstore.orderadmin.edit"]}],"summary":"Modify orderline","tags":["Orders"]}}},"servers":[{"url":"https://{your-bynder-domain}"}],"tags":[{"description":"","name":"Orders"}]}
```