Endpoints
Below is an overview of all the endpoints that are available in the Brincr API. The endpoints are grouped by the resource they are related to. All endpoints have a label, indicating if they are still in development or if they are already available in the production and/or sandbox environment.
Please visit the Swagger documentation for a more detailed description of our endpoints.
Here you can also find more examples on what responses to expect and how to make different kind of requests to the Brincr API.
Swagger documentation for Sandbox: sandbox-api.brincr.com
Swagger documentation for Production: api.brincr.com/api/documentation
Swagger documentation for Sandbox: sandbox-api.brincr.com
Swagger documentation for Production: api.brincr.com/api/documentation
| Api Analytics | ||
|---|---|---|
| GET | /api-analytics |
In development |
| GET | /api-analytics/category/{category} |
In development |
| GET | /api-analytics/label/{label} |
In development |
| GET | /api-analytics/status/{status} |
In development |
| Axis | ||
| GET | /axes |
In development |
| POST | /axes |
In development |
| GET | /axes/{axis_id} |
In development |
| PUT | /axes/{axis_id} |
In development |
| DELETE | /axes/{axis_id} |
In development |
| GET | /axes/{axis_id}/values |
In development |
| POST | /axes/{axis_id}/values |
In development |
| GET | /axes/{axis_id}/values/{axis_value_id} |
In development |
| PUT | /axes/{axis_id}/values/{axis_value_id} |
In development |
| DELETE | /axes/{axis_id}/values/{axis_value_id} |
In development |
| Category | ||
| GET | /categories |
Sandbox Production |
| POST | /categories |
Sandbox Production |
| GET | /categories/{category_id} |
Sandbox Production |
| PUT | /categories/{category_id} |
Sandbox Production |
| DELETE | /categories/{category_id} |
Sandbox |
| Country | ||
| GET | /countries |
Sandbox Production |
| GET | /countries/{country_id} |
Sandbox Production |
| Currency | ||
| GET | /currencies |
Sandbox Production |
| GET | /currencies/{currency_id} |
Sandbox Production |
| Customer | ||
| GET | /customers |
Sandbox Production |
| POST | /customers |
Sandbox Production |
| GET | /customers/{customer_id} |
Sandbox Production |
| PUT | /customers/{customer_id} |
Sandbox Production |
| DELETE | /customers/{customer_id} |
Sandbox |
| GET | /customers/{customer_id}/contacts |
Sandbox Production |
| POST | /customers/{customer_id}/contacts |
Sandbox Production |
| GET | /customers/{customer_id}/contacts/{contact_id} |
Sandbox Production |
| PUT | /customers/{customer_id}/contacts/{contact_id} |
Sandbox Production |
| DELETE | /customers/{customer_id}/contacts/{contact_id} |
Sandbox |
| GET | /customers/{customer_id}/discount_agreements |
Sandbox Production |
| POST | /customers/{customer_id}/discount_agreements |
Sandbox Production |
| GET | /customers/{customer_id}/discount_agreements/{discount_agreement_id} |
Sandbox Production |
| PUT | /customers/{customer_id}/discount_agreements/{discount_agreement_id} |
Sandbox Production |
| DELETE | /customers/{customer_id}/discount_agreements/{discount_agreement_id} |
Sandbox |
| GET | /customers/{customer_id}/price_agreements |
Sandbox Production |
| POST | /customers/{customer_id}/price_agreements |
Sandbox Production |
| GET | /customers/{customer_id}/price_agreements/{price_agreement_id} |
Sandbox Production |
| PUT | /customers/{customer_id}/price_agreements/{price_agreement_id} |
Sandbox Production |
| DELETE | /customers/{customer_id}/price_agreements/{price_agreement_id} |
Sandbox |
| GET | /customers/{customer_id}/shipping_addresses |
Sandbox Production |
| POST | /customers/{customer_id}/shipping_addresses |
Sandbox Production |
| GET | /customers/{customer_id}/shipping_addresses/{shipping_address_id} |
Sandbox Production |
| PUT | /customers/{customer_id}/shipping_addresses/{shipping_address_id} |
Sandbox Production |
| DELETE | /customers/{customer_id}/shipping_addresses/{shipping_address_id} |
Sandbox |
| ExchangeRate | ||
| GET | /exchange_rates/{exchange_rate_id} |
Sandbox Production |
| Invoice | ||
| GET | /invoices/provisional |
Sandbox Production |
| GET | /invoices/provisional/{provisional_invoice_id } |
Sandbox Production |
| GET | /invoices/sales |
Sandbox Production |
| GET | /invoices/sales/{sales_invoice_id } |
Sandbox Production |
| Locations | ||
| GET | /locations |
Sandbox Production |
| POST | /locations |
Sandbox Production |
| GET | /locations/{location_id} |
Sandbox Production |
| PUT | /locations/{location_id} |
Sandbox Production |
| DELETE | /locations/{location_id} |
Sandbox |
| POST | /locations/{location_id}/add_product/{product_id} |
Sandbox Production |
| DELETE | /locations/{location_id}/remove_product/{product_id} |
Sandbox |
| Orders | ||
| GET | /orders/{order_type} |
Sandbox Production |
| POST | /orders/{order_type} |
Sandbox Production |
| GET | /orders/{order_type}/{order_id} |
Sandbox Production |
| PUT | /orders/{order_type}/{order_id} |
Sandbox Production |
| DELETE | /orders/{order_type}/{order_id} |
Sandbox |
| GET | /orders/{order_type}/{order_id}/order_lines |
Sandbox Production |
| POST | /orders/{order_type}/{order_id}/order_lines |
Sandbox Production |
| GET | /orders/{order_type}/{order_id}/order_lines/{order_line_id} |
Sandbox Production |
| PUT | /orders/{order_type}/{order_id}/order_lines/{order_line_id} |
Sandbox Production |
| DELETE | /orders/{order_type}/{order_id}/order_lines/{order_line_id} |
Sandbox |
| PaymentMethod | ||
| GET | /payment_methods |
Sandbox Production |
| POST | /payment_methods |
Sandbox Production |
| GET | /payment_methods/{payment_method_id} |
Sandbox Production |
| PUT | /payment_methods/{payment_method_id} |
Sandbox Production |
| DELETE | /payment_methods/{payment_method_id} |
Sandbox |
| PriceGroup | ||
| GET | /price_groups |
Sandbox Production |
| POST | /price_groups |
Sandbox Production |
| GET | /price_groups/{price_group_id} |
Sandbox Production |
| PUT | /price_groups/{price_group_id} |
Sandbox Production |
| DELETE | /price_groups/{price_group_id} |
Sandbox |
| PriceNett | ||
| GET | /price_nett |
Sandbox Production |
| POST | /price_nett |
Sandbox Production |
| GET | /price_nett/{price_nett_id} |
Sandbox Production |
| PUT | /price_nett/{price_nett_id} |
Sandbox Production |
| DELETE | /price_nett/{price_nett_id} |
Sandbox |
| Product | ||
| GET | /products |
Sandbox Production |
| POST | /products |
Sandbox Production |
| GET | /products/{product_id} |
Sandbox Production |
| PUT | /products/{product_id} |
Sandbox Production |
| DELETE | /products/{product_id} |
Sandbox |
| GET | /products/{product_id}/images |
Sandbox Production |
| POST | /products/{product_id}/images |
Sandbox Production |
| GET | /products/{product_id}/images/{image_id} |
Sandbox Production |
| PATCH | /products/{product_id}/images/{image_id} |
Sandbox Production |
| DELETE | /products/{product_id}/images/{image_id} |
Sandbox |
| GET | /products/{product_id}/packaging |
Sandbox Production |
| POST | /products/{product_id}/packaging |
Sandbox Production |
| GET | /products/{product_id}/packaging/{packaging_id} |
Sandbox Production |
| PUT | /products/{product_id}/packaging/{packaging_id} |
Sandbox Production |
| DELETE | /products/{product_id}/packaging/{packaging_id} |
Sandbox |
| GET | /products/{product_id}/serial_numbers |
Sandbox |
| POST | /products/{product_id}/serial_numbers |
Sandbox |
| PUT | /products/{product_id}/serial_numbers/{serial_number_id} |
Sandbox |
| GET | /products/{product_id}/serial_numbers/{serial_number_id} |
Sandbox |
| DELETE | /products/{product_id}/serial_numbers/{serial_number_id} |
Sandbox |
| GET | /products/{product_id}/suppliers |
Sandbox Production |
| POST | /products/{product_id}/suppliers |
Sandbox Production |
| PUT | /products/{product_id}/suppliers/{supplier_id} |
Sandbox Production |
| GET | /products/{product_id}/suppliers/{supplier_id} |
Sandbox Production |
| DELETE | /products/{product_id}/suppliers/{supplier_id} |
Sandbox |
| GET | /products/{product_id}/variants |
In development |
| POST | /products/{product_id}/variants |
In development |
| GET | /products/{product_id}/variants/{product_variant_id} |
In development |
| PUT | /products/{product_id}/variants/{product_variant_id} |
In development |
| DELETE | /products/{product_id}/variants/{product_variant_id} |
In development |
| ProductMatrix | ||
| GET | /product_matrices |
In development |
| POST | /product_matrices |
In development |
| GET | /product_matrices/{product_matrix_id} |
In development |
| PUT | /product_matrices/{product_matrix_id} |
In development |
| DELETE | /product_matrices/{product_matrix_id} |
In development |
| GET | /product_matrices/{product_matrix_id}/axes |
In development |
| POST | /product_matrices/{product_matrix_id}/axes |
In development |
| GET | /product_matrices/{product_matrix_id}/axes/{axis_id} |
In development |
| PUT | /product_matrices/{product_matrix_id}/axes/{axis_id} |
In development |
| DELETE | /product_matrices/{product_matrix_id}/axes/{axis_id} |
In development |
| ProductBatch | ||
| GET | /products/{product_id}/batch |
Sandbox Production |
| POST | /products/{product_id}/batch |
Sandbox Production |
| GET | /products/{product_id}/batch/{batch_id} |
Sandbox Production |
| PUT | /products/{product_id}/batch/{batch_id} |
Sandbox Production |
| DELETE | /products/{product_id}/batch/{batch_id} |
Sandbox |
| ProductCode | ||
| GET | /products/{product_id}/codes |
Sandbox Production |
| POST | /products/{product_id}/codes |
Sandbox Production |
| GET | /products/{product_id}/codes/{product_code_id} |
Sandbox Production |
| PUT | /products/{product_id}/codes/{product_code_id} |
Sandbox Production |
| DELETE | /products/{product_id}/codes/{product_code_id} |
Sandbox |
| ProductWarehouseStock | ||
| GET | /products/{product_id}/warehouse_stock |
Sandbox Production |
| GET | /products/{product_id}/warehouse_stock/{warehouse_id} |
Sandbox Production |
| PATCH | /products/{product_id}/warehouse_stock/{warehouse_id} |
Sandbox Production |
| Salutation | ||
| GET | /salutations |
Sandbox Production |
| GET | /salutations/{salutation_id} |
Sandbox Production |
| SendMethod | ||
| GET | /send_methods |
Sandbox Production |
| POST | /send_methods |
Sandbox Production |
| GET | /send_methods/{send_method_id} |
Sandbox Production |
| PUT | /send_methods/{send_method_id} |
Sandbox Production |
| DELETE | /send_methods/{send_method_id} |
Sandbox |
| Status | ||
| GET | /statuses |
Sandbox Production |
| POST | /statuses |
Sandbox Production |
| GET | /statuses/{status_id} |
Sandbox Production |
| PUT | /statuses/{status_id} |
Sandbox Production |
| DELETE | /statuses/{status_id} |
Sandbox |
| Supplier | ||
| GET | /suppliers |
Sandbox Production |
| POST | /suppliers |
Sandbox Production |
| GET | /suppliers/{supplier_id} |
Sandbox Production |
| PUT | /suppliers/{supplier_id} |
Sandbox Production |
| DELETE | /suppliers/{supplier_id} |
Sandbox |
| GET | /suppliers/{supplier_id}/contacts |
Sandbox Production |
| POST | /suppliers/{supplier_id}/contacts |
Sandbox Production |
| GET | /suppliers/{supplier_id}/contacts/{contact_id} |
Sandbox Production |
| PUT | /suppliers/{supplier_id}/contacts/{contact_id} |
Sandbox Production |
| DELETE | /suppliers/{supplier_id}/contacts/{contact_id} |
Sandbox |
| TradeName | ||
| GET | /trade_names |
Sandbox Production |
| POST | /trade_names |
Sandbox Production |
| GET | /trade_names/{trade_name_id} |
Sandbox Production |
| PUT | /trade_names/{trade_name_id} |
Sandbox Production |
| DELETE | /trade_names/{trade_name_id} |
Sandbox |
| Unit | ||
| GET | /units |
Sandbox Production |
| POST | /units |
Sandbox Production |
| GET | /units/{unit_id} |
Sandbox Production |
| PUT | /units/{unit_id} |
Sandbox Production |
| DELETE | /units/{unit_id} |
Sandbox |
| VatRate | ||
| GET | /vat_rates |
Sandbox Production |
| POST | /vat_rates |
Sandbox Production |
| GET | /vat_rates/{vat_rate_id} |
Sandbox Production |
| PUT | /vat_rates/{vat_rate_id} |
Sandbox Production |
| DELETE | /vat_rates/{vat_rate_id} |
Sandbox |
| VolumeDiscount | ||
| GET | /volume_discounts |
Sandbox |
| GET | /volume_discounts/{volume_discount_id} |
Sandbox |
| Warehouse | ||
| GET | /warehouses |
Sandbox Production |
| POST | /warehouses |
Sandbox Production |
| GET | /warehouses/{warehouse_id} |
Sandbox Production |
| PUT | /warehouses/{warehouse_id} |
Sandbox Production |
| DELETE | /warehouses/{warehouse_id} |
Sandbox |