Bynder Brandstore API

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