Listing B2B config templates
API reference B2BConfigTemplateAPI
Overview
This endpoint can be used to get the list of the B2B config templates available for your account
Method access
GET https://api.getbyrd.com/v2/b2b_config_templates
Request Headers
Authorization: Bearer token-from >
Authentication
Content-Type: application/json
User-Agent: your user-agent >
How to call the APIs
Successful response
{
"data": [
{
"key": "amazon",
"id": "4d10fb38-2203-463c-8b81-c371408ff479",
"linkToWiki": "http://en-wiki",
"warehouseInstructionsHTML": "<h1>Pallet requirements</h1>Please follow the <b>next</b> instructions:<ul><li>1. Get the products</li><li>2. Pack the products</li><li>3. Spray some magic powder</li><li>4. Ship the products</li><li>5. Go have fun</li><ul>",
"description": "Description",
"customerInputSchema": {
"insurance_value": {
"type": "number",
"label": "Insurance value",
"maximum": 1000,
"minimum": 10,
"multipleOf": 10,
"description": "Compensation value if lost or damaged"
},
"product_labelling": {
"enum": [
"byrd",
"amazon"
],
"type": "string",
"label": "Product Label",
"description": "The product label to use"
},
"amazon_reference_id": {
"type": "string",
"label": "Amazon Reference ID",
"pattern": "[a-zA-Z0-9]{8}",
"description": "A unique number issued by Amazon"
},
"use_plastic_wrapping": {
"type": "boolean",
"label": "Plastic Wrapping",
"default": false,
"description": "Whether to use plastic wrapping"
}
},
"title": "Amazon",
"linkToPDF": "http://en.pdf",
"warehouseIDs": [
"e8403a54-33ee-4503-83b5-bccac6c58c93",
"570ee5d2-cdf5-46e6-91d1-7127cb8435f8",
"afe0f9e2-f5b3-4a1b-a682-e8bed11ce810"
]
},
{
"key": "byrd",
"id": "16291bc7-20b8-4643-a66b-3b4e5b55406a",
"linkToWiki": "http://wiki.com",
"warehouseInstructionsHTML": "<h1>Pallet requirments (EN)</h1>Please follow the <b>next</b> instructions:<ul><li>1. Get the products</li><li>2. Pack the products</li><li>3. Ship the products</li><li>4. Go have fun</li><ul>",
"description": "Another test template",
"customerInputSchema": {
"fragile_goods": {
"type": "boolean",
"label": "Fragile",
"default": false,
"description": "Fragile handle with care"
},
"container_type": {
"enum": [
"pallet",
"container"
],
"type": "string",
"label": "Container type",
"description": "The type of container to use"
},
"insurance_value": {
"type": "number",
"label": "Insurance value",
"maximum": 500,
"minimum": 10,
"multipleOf": 10,
"description": "Compensation value if lost or damaged"
},
"reference_number": {
"type": "string",
"label": "Reference number",
"pattern": "[0-9]{6}",
"description": "A unique reference number"
}
},
"title": "Byrd-en",
"linkToPDF": "http://pdf-link.com",
"warehouseIDs": [
"570ee5d2-cdf5-46e6-91d1-7127cb8435f8",
"afe0f9e2-f5b3-4a1b-a682-e8bed11ce810"
]
}
]
}
Updated over 1 year ago