Retrieving Recipes

Method : GET

https://os.vucustom.com/api/:api_version/recipes/:recipe_id

Path Variables

Field Name
Description

recipe_id

The 8 character token that represents the recipe, the data structure that contains selections made during the customization session. This is user generated.

api_version

current version is v1

Example Request
curl --location 'https://admin.vucustom.com/api/recipes/:recipe_id'

200 Successful response example

{
    "data": {
        "token": "85e2fa21",
        "user_id": null,
        "sku": "XRS",
        "body": {
            "shell": {
                "tab": {
                    "name": "Shell",
                    "code": "shell"
                },
                "element": {
                    "type": "material",
                    "name": "Shell Color",
                    "code": "shell"
                },
                "value": {
                    "name": "White",
                    "code": "W",
                    "upcharge": 0,
                    "swatch": "#FFFFFF",
                    "companions": []
                },
                "companions": []
            },
            "jawbone": {
                "tab": {
                    "name": "Jawbone",
                    "code": "jawbone"
                },
                "element": {
                    "type": "material",
                    "name": "Jawbone",
                    "code": "jawbone"
                },
                "value": {
                    "name": "White",
                    "code": "W",
                    "upcharge": 0,
                    "swatch": "#FFFFFF",
                    "companions": []
                },
                "companions": []
            },
            "chinstrap": {
                "tab": {
                    "name": "Chinstrap",
                    "code": "chinstrap"
                },
                "element": {
                    "type": "material",
                    "name": "Chinstrap",
                    "code": "chinstrap"
                },
                "value": {
                    "name": "Scarlet Red",
                    "code": "S",
                    "upcharge": 9.99,
                    "swatch": "#FF0000",
                    "companions": []
                },
                "companions": [
                    {
                        "element": "chin_cup",
                        "value": "white"
                    }
                ]
            },
            "chin_washer": {
                "tab": {
                    "name": "Chin & Washer",
                    "code": "chin_washer"
                },
                "element": {
                    "type": "material",
                    "name": "Chin & Washer",
                    "code": "chin_washer"
                },
                "value": {
                    "name": "White",
                    "code": "W",
                    "upcharge": 0,
                    "swatch": "#FFFFFF",
                    "companions": []
                },
                "companions": []
            },
            "mask": {
                "tab": {
                    "name": "Mask",
                    "code": "mask"
                },
                "element": {
                    "type": "material",
                    "name": "Mask",
                    "code": "mask"
                },
                "value": {
                    "name": "White Pearl",
                    "code": "XPWP",
                    "upcharge": 30,
                    "swatch": "#FFFFFF",
                    "companions": []
                },
                "companions": []
            },
            "throat_guard": {
                "tab": {
                    "name": "Goalie Throat Guard",
                    "code": "throat_guard"
                },
                "element": {
                    "type": "material",
                    "name": "Goalie Throat Guard",
                    "code": "throat_guard"
                },
                "value": {
                    "name": "No Throat Guard",
                    "code": "none",
                    "upcharge": 0,
                    "swatch": "#FAFAFA",
                    "companions": []
                },
                "companions": []
            },
            "quick_clip": {
                "tab": {
                    "name": "Chinstrap",
                    "code": "chinstrap"
                },
                "element": {
                    "type": "list",
                    "name": "Fastener",
                    "code": "quick_clip"
                },
                "value": {
                    "name": "Traditional",
                    "code": "no",
                    "upcharge": "0"
                }
            },
            "black": {
                "tab": {
                    "name": "Ancillary Items",
                    "code": "ancillary_items",
                    "hidden": true
                },
                "element": {
                    "type": "material",
                    "name": "Black",
                    "code": "black"
                },
                "value": {
                    "name": "Black",
                    "code": "black",
                    "upcharge": 0,
                    "swatch": "#000000",
                    "companions": []
                },
                "companions": []
            },
            "metallics": {
                "tab": {
                    "name": "Ancillary Items",
                    "code": "ancillary_items",
                    "hidden": true
                },
                "element": {
                    "type": "material",
                    "name": "Metallics",
                    "code": "metallics"
                },
                "value": {
                    "name": "Silver",
                    "code": "silver",
                    "upcharge": 0,
                    "swatch": "#d8d8d8",
                    "companions": []
                },
                "companions": []
            },
            "grey": {
                "tab": {
                    "name": "Ancillary Items",
                    "code": "ancillary_items",
                    "hidden": true
                },
                "element": {
                    "type": "material",
                    "name": "Grey",
                    "code": "grey"
                },
                "value": {
                    "name": "Grey",
                    "code": "grey",
                    "upcharge": 0,
                    "swatch": "#707372",
                    "companions": []
                },
                "companions": []
            },
            "chin_cup": {
                "tab": {
                    "name": "Ancillary Items",
                    "code": "ancillary_items",
                    "hidden": true
                },
                "element": {
                    "type": "material",
                    "name": "Chin Cup",
                    "code": "chin_cup"
                },
                "value": {
                    "name": "White",
                    "code": "white",
                    "upcharge": 0,
                    "swatch": "#FFFFFF",
                    "companions": []
                },
                "companions": []
            }
        },
        "created_at": "2023-12-06T19:27:10.785+00:00",
        "images": {
            "shell": "https://silhouette3.jtbcustom.com/api/recipes/85e2fa21/images/shell",
            "thumbnail": "https://silhouette3.jtbcustom.com/api/recipes/85e2fa21/images/thumbnail"
        }
    }
}
PreviousOverviewNextOverview

Last updated