Introduction
Platforme API enables any e-commerce website to support digital customisation, personalisation, dynamic pricing, product visualisation and production order managing.
Concepts
Before start using Platforme API, there are some important concepts to be conscious of. If you are not familiarized, you recommend you to read the Dev Portal's Concepts section.
Errors
The API returns standard HTTP success or error status codes. For errors, the response includes extra information about what went wrong encoded in the response as JSON.
| Status Code | |
|---|---|
| 200 | The request was successful. |
| 400 | Bad request - Due to an apparent client error (ie: malformed request syntax, invalid input, etc) |
| 401 | Unauthorized - Similar to 403 Forbidden, but specifically for use when authentication is required and has failed or has not yet been provided. |
| 403 | Forbidden - The user might not have the necessary permissions for a resource. |
| 404 | Not Found - The requested resource could not be found. |
| 500 | Internal Server Error. |
CORS
Platforme API supports cross-origin HTTP requests (aka CORS), meaning that one can call API resources using Javascript from any browser. A note of caution: it’s important to remember that one should never publicly expose API keys or credentials - CORS is mainly useful with unauthenticated endpoints, and there're an handful of endpoints intended for server-to-server scenarios.
Render Endpoints
Compose
Example Request
curl "https://ripe-core-sbx.platforme.com/api/compose?\
brand=swear&\
model=vyner&\
frame=0&\
p=lining:calf_lining:white&\
p=front:nappa:grey&\
p=side:nappa:navy&\
p=sole:rubber:yellow&\
p=laces:nylon:burnt_orange&\
p=logo:metal:gold&\
p=hardware:metal:gold&\
p=shadow:default:default&\
format=png&\
background=f5f5f5"
Example Response
Example Request
curl "https://ripe-core-sbx.platforme.com/api/compose?\
brand=swear&\
model=vyner&\
frame=top&\
p=lining:calf_lining:white&\
p=front:nappa:grey&\
p=side:nappa:navy&\
p=sole:rubber:yellow&\
p=laces:nylon:burnt_orange&\
p=logo:metal:gold&\
p=hardware:metal:gold&\
initials_profile=gold&\
initials=SW"
Example Response
This endpoint is used to render a frame of a given customization.
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/compose
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| brand | no | text | null |
The brand's model. |
| model | no | text | null |
The model to compose. |
| variant | no | text | null |
The variant (or sub-variant) of the specified model . |
| product_id | no | numeric | null |
The product's unique identification (ID). |
| p | no | text | null |
The configuration of the model, set this parameter for each triplet (part:material:color). If it is not defined then the default parts are used. |
| frame | no | text | 0 |
The frame of the model to be presented. |
| cache | no | boolean | true |
If a cached version of the frame should be used if available. |
| format | no | text | png |
The format of the image. Many formats are supported, like png, jpeg, or webp. |
| size | no | numeric | 1000 |
The size of the image in pixels. This value applies to both its width and height. |
| width | no | numeric | 1000 |
The width of the image in pixels, overrides the size value. |
| height | no | numeric | 1000 |
The height of the image in pixels, overrides the size value . |
| rotation | no | numeric | null |
The angle in degrees of the rotation to apply on the model. |
| crop | no | boolean | false |
If true then the outer blank parts of the image will be removed. This operation changes the size of the image. |
| bounding_box | no | numeric list | null |
Two comma separated values for width and height to apply a resize operation on the image. |
| algorithm | no | text | source_over |
The blending algorithm to be used. Supports source_over, multiplicative, disjoint_over and disjoint_under. |
| background | no | text | #000000 |
The hex value of the background color to be used. If the format is png, webp or sgi then the default background is transparent. |
| initials_profile | no | list | null |
The name of the profile to be used. A profile what what defines a premade configuration in a specific product. The configuration can set the values such as the font type, color and size, the initials position and rotation. This supports the use of namespacing. |
| initials_x | no | number | null |
Overrides the initials_profile's position on the x axis. |
| initials_y | no | number | null |
Overrides the initials_profile's position on the y axis. |
| initials_width | no | number | null |
Overrides the initials_profile's width. |
| initials_height | no | number | null |
Overrides the initials_profile's height. |
| initials_viewport | no | list | null |
Overrides the initials_profile's viewport. Viewport is a window (specified by [x, y, width, height]) that defines a region to be shown with a zoom. It is used to showcase the initials. |
| initials_color | no | text | 000000 |
Overrides the initials_profile's color to be applied to the initials. |
| initials_opacity | no | number | null |
Overrides the initials_profile's opacity to be applied to the initials. This value ranges from 0 to 1. |
| initials_align | no | text | null |
Overrides the initials_profile's orientation of the initials to be applied. This field can be left, right or center. |
| initials_vertical | no | text | null |
Overrides the initials_profile's vertical alignment on the initials. This field can be top, bottom or middle. |
| initials_embossing | no | text | null |
Overrides the initials_profile's embossing type of the initials. The available options vary with each model. |
| initials_rotation | no | number | null |
Overrides the initials_profile's rotation angle, in degrees, to be applied to the initials. |
| initials_pattern | no | text | null |
Overrides the initials_profile's initials pattern, that defines a regular expression to validate the initials. |
| initials_exclusion | no | text | null |
Overrides the initials_profile's initials exclusion. This is a list that defines which parts are excluded from the custumization. |
| initials_image_rotation | no | number | null |
Overrides the initials_profile's rotation angle, in degrees, to be applied to image. |
| font_family | no | text | null |
Overrides the initials_profile's font to be applied on the initials. |
| font_weight | no | text | null |
Overrides the initials_profile's font weight to be applied on the initials. |
| font_size | no | text | null |
Overrides the initials_profile's font size to be applied on the initials. |
| font_spacing | no | text | null |
Overrides the initials_profile's spacing between each letter. |
| font_trim | no | boolean | null |
Overrides the initials_profile's font trim, which defines wether the extra spaces are ignored or not. |
| shadow | no | boolean | true |
Overrides the initials_profile's shadow, which defines if the initials have a shadow. |
| shadow_color | no | text | ffffff |
Overrides the initials_profile's color of the shadow to be used. |
| shadow_offset | no | text | null |
Overrides the initials_profile's offset to be applied on the shadow. |
Mask
Example Request
curl "https://ripe-core-sbx.platforme.com/api/mask?brand=swear&model=vyner&part=side"
Example Response
This endpoint returns a masked version of the model, where the parts have a black overlay. It can be used to highlight a specific part.
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/mask
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| brand | no | text | null |
The brand's model. |
| model | no | text | null |
The model to compose. |
| part | no | text | null |
The part to be masked. If not defined then all masks are shown. |
| frame | no | text | 0 |
The frame of the model to be presented. |
| format | no | text | png |
The format of the image, one of png, jpeg, or webp. |
| size | no | numeric | 1000 |
The size of the image in pixels. This value applies to both its width and height. |
Swatches
curl "https://ripe-core-sbx.platforme.com/api/swatch/swear/nappa/red.png"
This endpoint gets the swatch of a material on a particular color.
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/swatch/<text:brand>/<text:material>/<text:color>.png
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| brand | yes | text | The brand’s that the material belongs to. | |
| material | yes | text | The desired material to render the swatch. | |
| color | yes | text | The color of the material to render the swatch. | |
| retina | no | boolean | false |
If true, will render the swatch on retina resolution (2x the source resolution). |
Config Endpoints
Info
The Info endpoint returns the customization information for the queryable context.
Using this API one can resolve a customization by:
product_iddkuskuwithin adomain- the base customization of a
model's variant
Example Request
curl "https://ripe-core-sbx.platforme.com/api/config/info?\
brand=swear&\
model=vyner&\
p=lining:calf_lining:white&\
p=front:nappa:grey&\
p=side:nappa:navy&\
p=sole:rubber:yellow&\
p=laces:nylon:burnt_orange&\
p=logo:metal:gold&\
p=hardware:metal:gold&\
p=shadow:default:default"
Example Response
{
"brand": "swear",
"model": "vyner",
"version": "178",
"product_id": null,
"variant": null,
"parts": {
"lining": {
"material": "calf_lining",
"color": "white"
},
"front": {
"material": "nappa",
"color": "grey"
},
"side": {
"material": "nappa",
"color": "navy"
},
"sole": {
"material": "rubber",
"color": "yellow"
},
"laces": {
"material": "nylon",
"color": "burnt_orange"
},
"logo": {
"material": "metal",
"color": "gold"
},
"hardware": {
"material": "metal",
"color": "gold"
},
"shadow": {
"material": "default",
"color": "default"
}
},
"hash": "520683e3be7c71fbe71fba7116610b39",
"dku": "swear.vyner.178.3:5.0:1.0:3.0:3.4:6.0:6.4:0:1.5:0:0",
"query": "brand=swear&model=vyner&version=178&p=front:nappa:grey&p=hardware:metal:gold&p=laces:nylon:burnt_orange&p=lining:calf_lining:white&p=logo:metal:gold&p=shadow:default:default&p=side:nappa:navy&p=sole:rubber:yellow"
}
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/config/info
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| brand | no | text | null |
The model's brand. |
| model | no | text | null |
The model's name. |
| variant | no | text | null |
The variant (or sub-variant) of the specified model. |
| product_id | no | numeric | null |
The product's unique identification (ID) assigned to a particular configuration. |
| sku | no | text | null |
The Stock Keeping Unit (SKU) assigned to a particular configuration. |
| dku | no | text | null |
The Dynamic Keeping Unit (DKU) that represents a particular configuration. |
| domain | no | text | brand |
The SKU domain (falls back to brand value). |
| p | no | text | null |
The configuration of the model, described as a set of triplets in the form of part:material:color. |
Price
Example Request
curl "https://ripe-core-sbx.platforme.com/api/config/price?\
brand=swear&\
model=vyner&\
p=side:nappa:white&\
p=hardware:metal:silver"
Example Response
{
"components": {
"side": {
"rule_id": 18680,
"rule_count": 4,
"price_taxes": 15.01,
"vat": 2.81,
"vat_rate": 23.0,
"price": 12.2,
"currency": "EUR",
"hs_code": 6403999065,
"notes": [
"Nappa Leather"
],
"hs_code_priority": 1,
"price_original": 15.0,
"vat_included": true,
"ddp_included": false,
"fixed_price": false,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": "PT-EUR",
"cites": false
},
"hardware": {
"rule_id": 20441,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 23.0,
"price": 0.0,
"currency": "EUR",
"hs_code": 6403999065,
"notes": [],
"hs_code_priority": 1,
"price_original": 0.0,
"vat_included": true,
"ddp_included": false,
"fixed_price": false,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": "PT-EUR",
"cites": false
}
},
"total": {
"price_final": 12.2,
"price_taxes": 12.2,
"vat": 0.0,
"ddp": 0.0,
"ddp_percent": 0.0,
"vat_rate": 0.0,
"price": 12.2,
"currency": "EUR",
"country": "US",
"hs_codes": [
6403999065
],
"hs_code_priority": 1,
"shipping": 0.0,
"notes": [
"Nappa Leather"
],
"diag": {
"no_round": {
"price_final": 12.2,
"price_taxes": 12.2,
"price": 12.2,
"vat": 0.0,
"ddp": 0.0
},
"patch": true,
"round_value": true,
"is_vat": false,
"is_ddp": true,
"is_european": false,
"is_rounded": false,
"vat_included": true,
"ddp_included": false,
"fixed_price": false,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": "PT-EUR"
},
"cites": false
}
}
The price information of a customized model according to all provided parameters, such as the presence of initials, each part material or even the client's country code. Besides the total product price, each component's price is also calculated.
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/config/price
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| brand | no | text | null |
The model's brand. |
| model | no | text | null |
The model's name. |
| variant | no | text | null |
The variant (or sub-variant) of the specified model. |
| product_id | no | numeric | null |
The product's unique identification (ID). |
| currency | no | text | EUR |
The ISO 4217 currency code in which the price shall be calculated with. |
| country | no | text | US |
The ISO 3166-2 code of the country to which the product is going to be purchased. |
| initials | no | text | null |
The initials value used to personalize the model. |
| engraving | no | text | null |
The properties of the personalization, with the format property_name1:property_type1.property_name2:property_type2 (recommended) or property_name1.property_name2. |
| p | no | text | null |
The configuration of the model, described as a set of triplets in the form of part:material:color. |
Availability
Example Request
curl "https://ripe-core-sbx.platforme.com/api/config/availability?\
brand=swear&\
model=vyner&\
product_id=11221602&\
p=front:nappa:white&\
p=side:nappa:white&\
p=hardware:metal:silver&\
p=laces:nylon:white&\
p=lining:calf_lining:white&\
p=sole:rubber:white&\
p=shadow:default:default"
Example Response
{
"components": {
"front": {
"delivery": 12,
"quantity": 1,
"rule_id": 18660,
"rule_count": 4,
"price_taxes": 10.0,
"vat": 1.87,
"vat_rate": 23.0,
"price": 8.13,
"currency": "EUR",
"hs_code": 6403999065,
"notes": [
"Nappa Leather"
],
"hs_code_priority": 1,
"price_original": 10.0,
"vat_included": true,
"ddp_included": false,
"fixed_price": false,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": "PT-EUR",
"cites": false
},
"side": {
"delivery": 12,
"quantity": 1,
"rule_id": 18680,
"rule_count": 4,
"price_taxes": 15.01,
"vat": 2.81,
"vat_rate": 23.0,
"price": 12.2,
"currency": "EUR",
"hs_code": 6403999065,
"notes": [
"Nappa Leather"
],
"hs_code_priority": 1,
"price_original": 15.0,
"vat_included": true,
"ddp_included": false,
"fixed_price": false,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": "PT-EUR",
"cites": false
},
"hardware": {
"delivery": 12,
"quantity": 1,
"rule_id": 20441,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 23.0,
"price": 0.0,
"currency": "EUR",
"hs_code": 6403999065,
"notes": [],
"hs_code_priority": 1,
"price_original": 0.0,
"vat_included": true,
"ddp_included": false,
"fixed_price": false,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": "PT-EUR",
"cites": false
},
"laces": {
"delivery": 12,
"quantity": 1,
"rule_id": 18673,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 23.0,
"price": 0.0,
"currency": "EUR",
"hs_code": 6403999065,
"notes": [],
"hs_code_priority": 1,
"price_original": 0.0,
"vat_included": true,
"ddp_included": false,
"fixed_price": false,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": "PT-EUR",
"cites": false
},
"lining": {
"delivery": 12,
"quantity": 1,
"rule_id": 20442,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 23.0,
"price": 0.0,
"currency": "EUR",
"hs_code": 6403999065,
"notes": [],
"hs_code_priority": 1,
"price_original": 0.0,
"vat_included": true,
"ddp_included": false,
"fixed_price": false,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": "PT-EUR",
"cites": false
},
"sole": {
"delivery": 12,
"quantity": 1,
"rule_id": 20444,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 23.0,
"price": 0.0,
"currency": "EUR",
"hs_code": 6403999065,
"notes": [
"Rubber"
],
"hs_code_priority": 1,
"price_original": 0.0,
"vat_included": true,
"ddp_included": false,
"fixed_price": false,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": "PT-EUR",
"cites": false
},
"shadow": {
"delivery": 12,
"quantity": 1,
"rule_id": 20424,
"rule_count": 3,
"price_taxes": 130.0,
"vat": 24.31,
"vat_rate": 23.0,
"price": 105.69,
"currency": "EUR",
"hs_code": 6403999065,
"notes": [],
"hs_code_priority": 1,
"price_original": 130.0,
"vat_included": true,
"ddp_included": false,
"fixed_price": false,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": "PT-EUR",
"cites": false
}
},
"total": {
"delivery": 12,
"quantity": 1,
"price_final": 126.02,
"price_taxes": 126.02,
"vat": 0.0,
"ddp": 0.0,
"ddp_percent": 0.0,
"vat_rate": 0.0,
"price": 126.02,
"currency": "EUR",
"country": "US",
"hs_codes": [
6403999065
],
"hs_code_priority": 1,
"shipping": 0.0,
"notes": [
"Nappa Leather",
"Rubber"
],
"diag": {
"no_round": {
"price_final": 126.02,
"price_taxes": 126.02,
"price": 126.02,
"vat": 0.0,
"ddp": 0.0
},
"patch": true,
"round_value": true,
"is_vat": false,
"is_ddp": true,
"is_european": false,
"is_rounded": false,
"vat_included": true,
"ddp_included": false,
"fixed_price": false,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": "PT-EUR"
},
"cites": false
},
"info": {
"brand": "swear",
"model": "vyner",
"product_id": 12212972,
"parts": {
"front": {
"material": "nappa",
"color": "white"
},
"side": {
"material": "nappa",
"color": "white"
},
"hardware": {
"material": "metal",
"color": "silver"
},
"laces": {
"material": "nylon",
"color": "white"
},
"lining": {
"material": "calf_lining",
"color": "white"
},
"sole": {
"material": "rubber",
"color": "white"
},
"shadow": {
"material": "default",
"color": "default"
}
},
"hash": "63477738dec39f87397f18b65df2f58f"
}
}
Get the stock availability of a given model according to its configuration and availability rules. For instance, check if a customized model is available for a given country/flag.
Meaning if a country/flag is specified the availability will be calculated accordingly: for example, some exotic materials might not be allowed under a country's law or when the flag is set to an arbitrary value, ie vegan.
The response also list the availability of each component passed as parameter, since there might be cases where some of them are not available.
The pricing parameter should be set to false whether it is not desirable to get any pricing information on the response.
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/config/availability
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| brand | no | text | null |
The model's brand. |
| model | no | text | null |
The model's name. |
| variant | no | text | null |
The variant (or sub-variant) of the specified model. |
| product_id | no | numeric | null |
The product's unique identification (ID). |
| country | no | text | US |
The ISO 3166-2 code of the country to which the product is going to be purchased. |
| flag | no | text | null |
The flag value, which is used to identify arbitrary contexts (ie: seasonal promo, special event, among others) |
| initials | no | text | null |
The initials value used to personalize the model. |
| engraving | no | text | null |
The properties of the personalization, with the format property_name1:property_type1.property_name2:property_type2 (recommended) or property_name1.property_name2. |
| pricing | no | boolean | true |
Defines if the pricing information appears on the response. |
| validate | no | boolean | false |
If the product configuration is to be validated. |
| p | no | text | null |
The configuration of the model, described as a set of triplets in the form of part:material:color. |
SKU
A SKU (Stock Keeping Unity) is a code assigned to a product to identify the price, product options and the manufacturer.
This endpoint resolves a customization defined by its query part to a mapped SKU string.
The mapping rules that define this mapping process are defined at the Platforme's back-end.
Example Request
curl "https://ripe-core-sbx.platforme.com/api/config/sku?\
brand=swear&\
model=vyner&\
p=front:nappa:white&\
p=hardware:metal:silver&\
p=laces:nylon:white&\
p=lining:calf_lining:white&\
p=logo:metal:silver&\
p=shadow:default:default&\
p=side:nappa:white&\
p=sole:rubber:white"
Example Response
{
"brand": "swear",
"model": "vyner",
"product_id": 12212972,
"variant": "",
"parts": {
"front": {
"material": "nappa",
"color": "white"
},
"hardware": {
"material": "metal",
"color": "silver"
},
"laces": {
"material": "nylon",
"color": "white"
},
"lining": {
"material": "calf_lining",
"color": "white"
},
"logo": {
"material": "metal",
"color": "silver"
},
"shadow": {
"material": "default",
"color": "default"
},
"side": {
"material": "nappa",
"color": "white"
},
"sole": {
"material": "rubber",
"color": "white"
}
},
"initials": null,
"engraving": null,
"initials_extra": null,
"sku": "271828"
}
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/config/sku
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| brand | yes | text | The model's brand. | |
| model | yes | text | The model's name. | |
| variant | no | text | null |
The variant (or sub-variant) of the specified model. |
| initials | no | text | null |
The initials value used to personalize the model. |
| engraving | no | text | null |
The properties of the personalization, with the format property_name1:property_type1.property_name2:property_type2 (recommended) or property_name1.property_name2. |
| initials_extra | no | text | null |
The properties of the personalization, with the format group_name1:property_name1:property_type1.group_name2:property_name2:property_type2. |
| product_id | no | numeric | null |
The product's unique identification (ID). |
| domain | no | text | brand |
The SKU domain (falls back to brand value). |
| p | yes | text | The configuration of the model, described as a set of triplets in the form of part:material:color. |
Resolve
Example Request
curl "https://ripe-core-sbx.platforme.com/api/config/resolve/271828"
Example Response
{
"brand": "swear",
"model": "vyner",
"variant": null,
"description": "SWEAR Vyner",
"observations": "",
"gender": "male",
"product_id": 271828,
"parts": null,
"extras_m": {},
"meta": {}
}
Get the configuration of a product identified by its unique product ID.
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/config/resolve/<int:product_id>
Resources
Info
| Field | Type | Description |
|---|---|---|
| brand | text | Product's brand. |
| name | text | Product's name. |
| variant | text | Product's variant. |
| product_id | number | Product's id. |
| parts | dictionary | Specific customization (part, material, color). |
| hash | text | Config's hash. |
Price
| Field | Type | Description |
|---|---|---|
| total | dictionary | Total pricing information (see Price Total). |
| components | dictionary | Pricing information per customization component (see Price Component). |
Price Total
| Field | Type | Description |
|---|---|---|
| price | number | Base price result. |
| price_final | number | Base price + VAT + DDP. |
| price_taxes | number | Base price + VAT. |
| vat | number | VAT value. |
| vat_rate | number | VAT rate. |
| ddp | number | DDP value. |
| ddp_percent | number | DDP percentage. |
| currency | text | Currency used for pricing calculation (ISO 4217). |
| country | text | Country used for pricing calculation (ISO 3166-2). |
| shipping | number | Shipping value. |
| hs_codes | list of numbers | Complete set of HS codes. |
| hs_code_priority | number | The HS code priority. |
| diag | dictionary | Complementary diagnosis information. |
| notes | dictionary | Complementary information. |
Price Component
| Field | Type | Description |
|---|---|---|
| price | number | Price value (could be rounded). |
| price_original | number | Base price. |
| price_taxes | number | Base price + vat. |
| fixed_price | boolean | Is fixed price. |
| vat_included | boolean | Is vat included. |
| vat | number | VAT value. |
| vat_rate | number | VAT rate. |
| ddp_included | boolean | Is ddp included. |
| hs_code | number | HS code value. |
| hs_code_priority | number | HS code priority. |
| round_price | boolean | Is the price rounded. |
| currency | text | Currency used for pricing calculation (ISO 4217). |
| exchanged | boolean | Is the price exchanged. |
| notes | dictionary | Complementary information. |
Availability
| Field | Type | Description |
|---|---|---|
| brand | text | Product's brand. |
| name | text | Product's name. |
| variant | text | Product's variant. |
| product_id | number | Product's id. |
| parts | dictionary | Specific customization (part, material, color). |
| hash | text | Customization's hash. |
| total | dictionary | Total pricing information (see Availability Total). |
| components | dictionary | Pricing information per customization component (see Availability Component). |
Availability Total
| Field | Type | Description |
|---|---|---|
| price | number | Base price result. |
| price_final | number | Base price + vat + ddp. |
| price_taxes | number | Base price + vat. |
| vat | number | VAT value. |
| vat_rate | number | VAT rate. |
| ddp | number | DDP value. |
| ddp_percent | number | DDP percentage. |
| currency | text | Currency used for pricing calculation (ISO 4217). |
| country | text | Country used for pricing calculation (ISO 3166-2). |
| shipping | number | Shipping value. |
| hs_codes | list of numbers | Complete set of HS codes. |
| hs_code_priority | number | The HS code priority. |
| diag | dictionary | Complementary diagnosis information. |
| notes | dictionary | Complementary information. |
Availability Component
| Field | Type | Description |
|---|---|---|
| price | number | Price value (could be rounded). |
| price_original | number | Base price. |
| price_taxes | number | Base price + VAT. |
| fixed_price | boolean | Is fixed price. |
| vat_included | boolean | Is vat included. |
| vat | number | VAT value. |
| vat_rate | number | VAT rate. |
| ddp_included | boolean | Is DDP included. |
| hs_code | number | HS code value. |
| hs_code_priority | number | HS code priority. |
| round_price | boolean | Is the price rounded. |
| currency | text | Currency used for pricing calculation (ISO 4217). |
| exchanged | boolean | Is the price exchanged. |
| notes | dictionary | Complementary information. |
| quantity | number | Number of raw material in stock. |
SKU
| Field | Type | Description |
|---|---|---|
| brand | text | Product's brand. |
| name | text | Product's name. |
| variant | text | Product's variant. |
| product_id | number | Product's id. |
| parts | dictionary | Specific customization (part, material, color). |
| sku | text | SKU value. |
SKU Endpoints
Create
Creates a mapping between SKU within a domain to a customization
This API functions on an upsert basis, meaning that either creates or on the basis of preceding existance updates.
Example Request
curl "https://ripe-core-sbx.platforme.com/api/skus" \
-H "Content-Type: application/json" \
-H "X-Secret-Key: $RIPE_KEY" \
-d '{
"domain": "swear",
"identifier": "7481dccc-1939-4486-b9ca-a25d2e22cd17",
"spec": {
"brand": "swear",
"model": "vyner",
"parts": {
"lining": {
"color": "white",
"material": "calf_lining"
},
"sole": {
"color": "red",
"material": "rubber"
},
"hardware": {
"color": "silver",
"material": "metal"
},
"laces": {
"color": "white",
"material": "nylon"
},
"front": {
"color": "white",
"material": "nappa"
},
"logo": {
"color": "silver",
"material": "metal"
},
"shadow": {
"color": "default",
"material": "default"
},
"side": {
"color": "white",
"material": "nappa"
}
}
}
}'
Example Response
{
"_id": "5fa3fd8dd5b3435b0ce10eb4",
"id": 157695,
"domain": "swear",
"identifier": "7481dccc-1939-4486-b9ca-a25d2e22cd17",
"spec": {
"brand": "swear",
"model": "vyner",
"parts": {
"lining": {
"color": "white",
"material": "calf_lining"
},
"sole": {
"color": "red",
"material": "rubber"
},
"hardware": {
"color": "silver",
"material": "metal"
},
"laces": {
"color": "white",
"material": "nylon"
},
"front": {
"color": "white",
"material": "nappa"
},
"logo": {
"color": "silver",
"material": "metal"
},
"shadow": {
"color": "default",
"material": "default"
},
"side": {
"color": "white",
"material": "nappa"
}
}
},
"enabled": true,
"description": null,
"meta": {},
"brand_t": null,
"retailer_t": null,
"vendor_t": null,
"hash": "1251eade274c0d89e4410a7082d2766f",
"created": 1604582797,
"modified": 1604582797
}
HTTP Request
POST https://ripe-core-sbx.platforme.com/api/skus
Header Fields
| Field | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| X-Secret-Key | yes | text | The X-Secret-Key to authenticate the request. |
POST Body
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| identifier | yes | text | The model's brand. | |
| domain | yes | text | The model's name. | |
| spec | yes | text | The object describing the product (brand, model, variant, parts, initials, engraving, etc.) |
Resources
SKU
| Field | Type | Description |
|---|---|---|
| identifier | text | The SKU string that should identify an unique specification inside a certain domain. |
| domain | text | The string value used to separate resolution of SKUs so that no collisions occur between identifiers |
| spec | dictionary | The object describing the product (brand, model, variant, parts, initials, engraving, etc.) |
Locale Endpoints
Locale
This endpoint is used to get the corresponding text of one value defined on a locale.
Example Request
curl "https://ripe-core-sbx.platforme.com/api/locale/calf_hair?&locale=es_es"
Example Response
{
"value": "calf_hair",
"value_l": "calf_hair",
"locale": "es_es"
}
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/locale/<value>
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| value | yes | text | The value which one wants to get the locale of. | |
| locale | no | text | en-us |
The locale which one wants to get the value from. |
| context | no | text | null |
The context at which the locale is bounded to. |
Locale Values
This endpoint is used to get the corresponding text of one or more values defined on a locale.
Example Request
curl "https://ripe-core-sbx.platforme.com/api/locale?\
values=scales.it:clothing&\
locale=it_it"
Example Response
{
"values": [
"scales.it:clothing"
],
"values_l": [
"IT"
],
"locale": "it_it"
}
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/locale
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| values | yes | list of text | The values which one wants to get the locale of. | |
| locale | no | text | en-us |
The locale which one wants to get the value from. |
| context | no | text | null |
The locale's context scope. |
Locale Bundle
This endpoint is used to get the complete locale bundle of a specific context.
Example Request
curl "https://ripe-core-sbx.platforme.com/api/locale/bundle?\
context=sandbox&\
locale=en_us"
Example Response
{
"customise": "customize",
"body": "Body",
"lining": "Lining",
"veau_epsom_hrm": "Veau Epsom",
"veau_swift_hrm": "Veau Swift",
"abricot": "Abricot",
"bleu_indigo": "Bleu Indigo",
"bleu_electrique": "Bleu Electrique",
"rouge_grenat": "Rouge Grenat"
}
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/locale/bundle
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| context | no | text | null |
The context at which the locale is bounded to. |
| locale | no | text | en-us |
The locale which one wants to get the bundle from. |
Resources
Locale
| Field | Type | Description |
|---|---|---|
| locale | text | The locale identifier following the format language-country, respectively in ISO 639-1 and ISO 3166-2 formats. |
| value | text | The value requested to get the locale of. |
| value_l | text | The localized value. |
Locale values
| Field | Type | Description |
|---|---|---|
| locale | text | The locale identifier following the format language-country, respectively in ISO 639-1 and ISO 3166-2 formats. |
| values | text | The list of values requested to get the locale of. |
| values_l | text | The list of localized values. |
Product Endpoints
Logo
Example Request
curl "https://ripe-core-sbx.platforme.com/api/brands/swear/logo.png?size=large"
Example Response
This endpoint gets the brand's logo.
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/brands/<text:brand>/logo.<format>
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| format | yes | text | The format of the image, (eg: png, jpg, svg, etc.) |
|
| size | no | text | medium | Logo's size, one of small, medium or large. |
Config
Example Request
curl "https://ripe-core-sbx.platforme.com/api/brands/swear/models/vyner/config"
Example Response
{
"name": "vyner",
"brand": "swear",
"version": "178",
"parts": [
{
"name": "front",
"materials": [
{
"name": "nappa",
"colors": [
"white",
"black",
"navy",
"red",
"beige",
"forest_green",
"dark_cherry",
"blush",
"grey",
"taupe"
]
},
{
"name": "suede",
"colors": [
"white",
"black",
"navy",
"red",
"beige",
"forest_green",
"grey",
"taupe"
]
},
{
"name": "hairy_calf",
"colors": [
"white",
"black",
"navy",
"red",
"leopard",
"camouflage"
]
},
{
"name": "python",
"colors": [
"white",
"black",
"natural",
"silver",
"gold",
"neon_white",
"grey",
"nude"
]
},
{
"name": "crocodile",
"colors": [
"white",
"black",
"navy",
"red",
"chestnut",
"nude",
"silver"
]
},
{
"name": "grain_metallic",
"colors": [
"purple",
"emerald",
"gold",
"silver"
]
}
]
},
{
"name": "side",
"materials": [
{
"name": "nappa",
"colors": [
"white",
"black",
"navy",
"red",
"beige",
"forest_green",
"dark_cherry",
"blush",
"grey",
"taupe"
]
},
{
"name": "suede",
"colors": [
"white",
"black",
"navy",
"red",
"beige",
"forest_green",
"grey",
"taupe"
]
},
{
"name": "metallic",
"colors": [
"silver",
"gold",
"copper",
"navy",
"fuchsia"
]
},
{
"name": "hairy_calf",
"colors": [
"white",
"black",
"navy",
"red",
"leopard",
"camouflage"
]
},
{
"name": "python",
"colors": [
"white",
"black",
"natural",
"silver",
"gold",
"neon_white",
"grey",
"nude"
]
},
{
"name": "crocodile",
"colors": [
"white",
"black",
"navy",
"red",
"chestnut",
"nude",
"silver"
]
},
{
"name": "grain_metallic",
"colors": [
"purple",
"emerald",
"gold",
"silver"
]
}
]
},
{
"name": "lining",
"materials": [
{
"name": "calf_lining",
"colors": [
"white",
"black",
"tan",
"beige"
]
}
]
},
{
"name": "laces",
"materials": [
{
"name": "nylon",
"colors": [
"white",
"black",
"grey",
"navy",
"cobalt",
"red",
"fuchsia",
"taupe",
"copper_brown",
"forest_green",
"golden_yellow",
"burnt_orange",
"blush",
"dark_cherry"
]
}
]
},
{
"name": "sole",
"materials": [
{
"name": "rubber",
"colors": [
"white",
"black",
"grey",
"tan",
"yellow",
"pink",
"red"
]
}
]
},
{
"name": "hardware",
"materials": [
{
"name": "metal",
"colors": [
"silver",
"gold"
]
}
]
},
{
"name": "logo",
"materials": [
{
"name": "metal",
"colors": [
"silver",
"gold",
"copper"
]
}
]
},
{
"name": "shadow",
"materials": [
{
"name": "default",
"colors": [
"default"
]
}
]
}
],
"description": "vyner",
"title": "lace up round toe",
"style": "low",
"scale": {
"male": "it",
"female": "it",
"other": "it",
"all": "it"
},
"gender": "both",
"observations": "A contemporary take on the classic lace-up sneaker, the fully-customisable Vyner is all about comfort with its cushioned piping and padded collar. The low-top comes complete with a round toe and rubber sole, in addition to flat laces.",
"toe": "round",
"type": "very-large",
"tags": [
"initials_type_zoom",
"initials_uppercase"
],
"sizes": {
"it:female": [
19,
21,
23,
25,
27,
29,
31
],
"it:male": [
25,
27,
29,
31,
33,
35,
37,
39,
41,
43,
45
]
},
"frames": 24,
"faces": [
"side",
"top"
],
"faces_m": {
"side": {
"frames": 24,
"thumbnail": true
},
"top": {
"frames": 1,
"thumbnail": true
}
},
"thumbnails": [
{
"name": "side-0",
"face": "side",
"frame": 0
},
{
"name": "top-0",
"face": "top",
"frame": 0
}
],
"hidden": [
"logo",
"shadow"
],
"blacklist": {
"rules": [
[
"",
"",
"terracotta"
],
[
"",
"veg_tan",
""
],
[
"",
"hairy_calf",
"beige"
],
[
"",
"ostrich",
""
],
[
"",
"python",
"blush"
],
[
"laces",
"",
"rose"
],
[
"laces",
"",
"chocolate"
],
[
"laces",
"",
"beige"
],
[
"laces",
"",
"neon_yellow"
],
[
"hardware",
"metal",
"copper"
]
],
"materials": {
"front": [
"metallic"
]
}
},
"sync": {
"hardware": [
"hardware",
"logo"
]
},
"defaults": {
"lining": {
"material": "calf_lining",
"color": "white",
"face": "top"
},
"front": {
"material": "nappa",
"color": "white",
"face": "side"
},
"side": {
"material": "nappa",
"color": "white",
"face": "side",
"frame": 0
},
"sole": {
"material": "rubber",
"color": "white",
"face": "side"
},
"laces": {
"material": "nylon",
"color": "white",
"face": "top"
},
"logo": {
"hidden": true,
"material": "metal",
"color": "silver"
},
"hardware": {
"material": "metal",
"color": "silver",
"face": "side",
"frame": 0
},
"shadow": {
"hidden": true,
"material": "default",
"color": "default"
}
},
"initials": {
"z_index": 4,
"properties": [
{
"name": "metal_gold",
"type": "font"
},
{
"name": "metal_silver",
"type": "font"
},
{
"name": "metal_copper",
"type": "font"
}
],
"$profiles": {
"base": {
"frame": "top",
"align": "center",
"image_rotation": 270,
"font_family": "SwearGold",
"font_weight": "Regular",
"font_spacing": -10,
"exclusion": [
"logo"
],
"position": [
449,
408
],
"rotation": 0
},
"style::metal_silver": {
"font_family": "SwearSilver"
},
"style::metal_gold": {
"font_family": "SwearGold"
},
"style::metal_copper": {
"font_family": "SwearCopper"
},
"viewport::large": {
"viewport": [
324,
283,
250,
250
]
},
"viewport::medium": {
"viewport": [
349,
308,
200,
200
]
},
"viewport::small": {
"viewport": [
399,
358,
100,
100
]
},
"metal_silver": {
"font_family": "SwearSilver"
},
"metal_gold": {
"font_family": "SwearGold"
},
"metal_copper": {
"font_family": "SwearCopper"
},
"large": {
"viewport": [
324,
283,
250,
250
]
},
"medium": {
"viewport": [
349,
308,
200,
200
]
},
"small": {
"viewport": [
399,
358,
100,
100
]
}
},
"profile": "base",
"$alias": {
"report": [
"viewport::medium"
],
"step::personalization": [
"viewport::large"
],
"step::size": [
"viewport::medium"
]
}
},
"initials_frame": {
"default": "top"
},
"z_index": {
"shadow": 1,
"lining": 2,
"front": 3,
"side": 5,
"sole": 6,
"laces": 7,
"logo": 8,
"hardware": 9,
"overlay": 30000
},
"version_s": "178",
"version_i": 178,
"branch": "master",
"order": {
"models": [
"air_revive",
"air_rev_nitro",
"air_rev_trigger",
"bond",
"crosby_v2",
"maddox",
"marshall",
"nori",
"redchurch",
"vyner",
"vyner_hitop"
],
"parts": [
"front",
"front_panel",
"side",
"upper",
"body",
"ankle_side",
"piping",
"toe_cap",
"back_stay",
"stay",
"heel",
"elastic",
"collar",
"strap_tips",
"metal_toe_cap",
"eye_stay",
"metal_caps",
"lining",
"inside",
"inside_panel",
"outside",
"laces",
"tongue",
"heel_puller",
"swear_tape",
"rubber_strap",
"zip_puller",
"zip",
"straps",
"strap_tip",
"sole",
"outsole",
"hardware",
"logo",
"fringe_hardware",
"fringe",
"trimmings",
"upper1",
"upper2",
"ugly_tape",
"accents",
"eyestay0_side",
"heel0_trimmings",
"heel_tab",
"lace0_eyelet",
"mudguard",
"side0_tongue_detail",
"toe0_tongue",
"tongue_detail",
"tag_left",
"tag_right"
],
"materials": {
"front": [
"nappa",
"suede",
"metallic",
"veg_tan",
"hairy_calf",
"novelty",
"ostrich",
"python",
"crocodile"
],
"side": [
"nappa",
"suede",
"metallic",
"veg_tan",
"hairy_calf",
"novelty",
"ostrich",
"python",
"crocodile",
"nappa10_corso_como"
],
"inside": [
"nappa",
"suede",
"metallic",
"veg_tan",
"patent_leather",
"hairy_calf",
"novelty",
"ostrich",
"python",
"crocodile"
],
"inside_panel": [
"nappa",
"suede",
"metallic",
"veg_tan",
"hairy_calf",
"novelty",
"ostrich",
"python",
"crocodile"
],
"front_panel": [
"nappa",
"suede",
"metallic",
"veg_tan",
"patent_leather",
"hairy_calf",
"novelty",
"ostrich",
"python",
"crocodile"
],
"outside": [
"nappa",
"suede",
"metallic",
"veg_tan",
"hairy_calf",
"novelty",
"ostrich",
"python",
"crocodile"
],
"ankle_side": [
"nappa",
"suede",
"metallic",
"veg_tan",
"hairy_calf",
"novelty",
"ostrich",
"python",
"crocodile"
],
"back_stay": [
"nappa",
"suede",
"metallic",
"veg_tan",
"hairy_calf",
"novelty",
"ostrich",
"python",
"crocodile"
],
"stay": [
"nappa",
"suede",
"metallic",
"veg_tan",
"hairy_calf",
"novelty",
"ostrich",
"python",
"crocodile"
],
"eye_stay": [
"nappa",
"suede",
"metallic",
"veg_tan",
"patent_leather",
"hairy_calf",
"novelty",
"ostrich",
"python",
"crocodile"
],
"heel": [
"nappa",
"suede",
"metallic",
"veg_tan",
"hairy_calf",
"novelty",
"ostrich",
"python",
"crocodile"
],
"elastic": [
"elastic",
"elastic10_corso_como"
],
"hardware": [
"metal",
"nori_metal"
],
"fringe_hardware": [
"metal"
],
"fringe": [
"nappa",
"suede",
"metallic",
"hairy_calf",
"veg_tan"
],
"straps": [
"nappa",
"suede",
"metallic",
"veg_tan",
"hairy_calf",
"novelty",
"ostrich",
"python",
"crocodile"
],
"strap_tip": [
"metal"
],
"strap_tips": [
"metal"
],
"laces": [
"nylon",
"leather",
"nori_nylon",
"nori_reflective_textile"
],
"metal_caps": [
"metal"
],
"toe_cap": [
"nappa",
"suede",
"metallic",
"veg_tan",
"hairy_calf",
"novelty",
"ostrich",
"python",
"crocodile"
],
"lining": [
"calf_lining",
"calf_lining10_corso_como"
],
"sole": [
"rubber",
"rubber_wedge",
"nori_rubber"
],
"metal_toe_cap": [
"metal"
],
"collar": [
"nappa",
"suede",
"metallic",
"veg_tan",
"hairy_calf",
"novelty",
"ostrich",
"python",
"crocodile",
"wax_nubuck",
"wicker_nylon",
"gel_mesh"
],
"logo": [
"metal"
],
"tongue": [
"nappa",
"suede",
"metallic",
"veg_tan",
"patent_leather",
"hairy_calf",
"novelty",
"ostrich",
"python",
"crocodile"
],
"upper": [
"stretch_knit",
"stretch_nappa",
"mesh"
],
"upper1": [
"grain_metallic",
"nori_nylon_upper",
"grain_nappa",
"nappa",
"suede"
],
"upper2": [
"nori_rubber_upper",
"nappa",
"reflective",
"wax_nubuck"
],
"heel_puller": [
"polyester",
"rubber_heel"
],
"swear_tape": [
"polyester",
"rubber_heel"
],
"outsole": [
"rubber"
],
"rubber_strap": [
"rubber_strap"
],
"zip_puller": [
"polyester"
],
"zip": [
"nylon_tape"
],
"body": [
"photo"
],
"trimmings": [
"nori_reflective_textile",
"reflective0_grossgrain"
],
"ugly_tape": [
"rubberHeel"
],
"accents": [
"web_mesh",
"airtech_mesh"
],
"eyestay0_side": [
"nappa",
"suede",
"hairy_calf",
"python",
"crocodile",
"wax_nubuck"
],
"heel0_trimmings": [
"nappa",
"suede"
],
"heel_tab": [
"nappa",
"suede",
"hairy_calf",
"python",
"crocodile",
"wax_nubuck",
"grain_metallic"
],
"lace0_eyelet": [
"nylon0_plastic"
],
"mudguard": [
"nappa",
"suede",
"hairy_calf",
"grain_metallic",
"python",
"crocodile",
"wax_nubuck"
],
"side0_tongue_detail": [
"nappa",
"suede",
"hairy_calf",
"python",
"crocodile",
"wax_nubuck",
"hex_rubber",
"grain_metallic"
],
"toe0_tongue": [
"nappa",
"suede",
"hairy_calf",
"python",
"crocodile",
"wax_nubuck"
],
"tongue_detail": [
"gel_mesh"
],
"tag_left": [
"nappa_tag"
],
"tag_right": [
"nappa_tag"
]
},
"colors": {
"nappa": [
"white",
"black",
"navy",
"cobalt",
"red",
"fuchsia",
"chocolate",
"terracotta",
"beige",
"forest_green",
"khaki",
"neon_yellow",
"dark_cherry",
"blush",
"sky",
"grey",
"taupe",
"off_white"
],
"nappa10_corso_como": [
"black",
"white"
],
"grain_nappa": [
"grey"
],
"suede": [
"white",
"black",
"navy",
"cobalt",
"red",
"fuchsia",
"chocolate",
"terracotta",
"beige",
"forest_green",
"grey",
"taupe",
"orange",
"dark_grey",
"light_grey"
],
"metallic": [
"silver",
"gold",
"copper",
"navy",
"fuchsia"
],
"hairy_calf": [
"white",
"black",
"navy",
"red",
"terracotta",
"leopard",
"camouflage"
],
"ostrich": [
"white",
"black",
"tan",
"grey"
],
"gel_mesh": [
"black",
"off_white",
"red",
"white"
],
"python": [
"white",
"black",
"natural",
"silver",
"gold",
"neon_white",
"blush",
"grey",
"nude"
],
"crocodile": [
"white",
"black",
"navy",
"red",
"chestnut",
"nude",
"silver"
],
"elastic": [
"white",
"black",
"grey",
"navy",
"cobalt",
"red",
"fuchsia",
"rose",
"chocolate",
"tan",
"beige",
"mustard",
"forest_green",
"burnt_orange",
"silver",
"gold"
],
"elastic10_corso_como": [
"black",
"white"
],
"metal": [
"silver",
"gold",
"copper",
"navy",
"fuchsia",
"gunmetal"
],
"nylon": [
"white",
"black",
"grey",
"navy",
"cobalt",
"red",
"fuchsia",
"rose",
"chocolate",
"terracotta",
"taupe",
"copper_brown",
"beige",
"forest_green",
"golden_yellow",
"neon_yellow",
"burnt_orange",
"blush",
"dark_cherry",
"black0_grey",
"white0_grey",
"white0_red"
],
"nylon_tape": [
"black",
"black0_green",
"black0_orange",
"white"
],
"rubber": [
"white",
"black",
"grey",
"tan",
"silver",
"gold",
"yellow",
"clear_white",
"transparent",
"gum"
],
"rubber_wedge": [
"white",
"black",
"gum0_white",
"gum0_black",
"neon_orange",
"pink",
"blue",
"transparent0_white",
"transparent0_black"
],
"calf_lining": [
"white",
"black",
"tan",
"beige"
],
"calf_lining10_corso_como": [
"black",
"white"
],
"novelty": [
"black_mesh",
"cobalt_mesh",
"fuchsia_mesh",
"orange_mesh",
"neon_mesh",
"prism"
],
"leather": [
"black",
"beige",
"chocolate",
"cobalt",
"grey",
"red",
"terracotta",
"white"
],
"airtech_mesh": [
"neon_orange",
"neon_yellow",
"red",
"white"
],
"patent_leather": [
"white",
"black",
"grey",
"cobalt",
"red",
"chocolate",
"terracotta",
"beige"
],
"reflective0_grossgrain": [
"blue0_blue0_white",
"white0_black0_white",
"yellow0_yellow0_white"
],
"veg_tan": [
"raw"
],
"photo": [
"white",
"blue",
"black",
"orange",
"red",
"gold",
"pink",
"denim",
"multi",
"blue_grey",
"blue_reflective",
"green",
"grey_reflective",
"neon_pink",
"yellow_pink"
],
"nori_metal": [
"gold",
"silver"
],
"nori_reflective_textile": [
"black",
"navy",
"neon_pink",
"neon_yellow",
"red",
"white"
],
"nori_nylon": [
"black",
"blush",
"burnt_orange",
"golden_yellow",
"grey",
"navy",
"red",
"white"
],
"nori_rubber": [
"black",
"red",
"white",
"yellow"
],
"nori_nylon_upper": [
"black",
"navy",
"white"
],
"nori_rubber_upper": [
"black",
"navy",
"white"
],
"reflective": [
"grey"
],
"stretch_knit": [
"black",
"blue",
"green",
"white",
"grey",
"orange",
"red"
],
"polyester": [
"neon_orange",
"neon_pink",
"neon_yellow",
"off_white",
"blue",
"grey"
],
"reflective_textile": [
"neon_orange",
"neon_pink",
"neon_yellow",
"off_white",
"blue",
"grey"
],
"rubber_strap": [
"black",
"blue0_orange",
"transparent0_white",
"black0_white"
],
"rubber_heel": [
"black",
"black0_red",
"black0_white",
"blue",
"white0_black",
"neon_green0_black",
"neon_orange",
"pink"
],
"stretch_nappa": [
"black",
"white"
],
"mesh": [
"black",
"blue",
"neon_orange",
"neon_pink",
"neon_yellow",
"orange",
"pink"
],
"rubberHeel": [
"orange0_black"
],
"web_mesh": [
"white",
"black"
],
"wax_nubuck": [
"grey",
"black"
],
"wicker_nylon": [
"emerald",
"violet",
"white",
"black"
],
"nylon0_plastic": [
"black",
"white"
],
"hex_rubber": [
"emerald",
"violet",
"white",
"black"
],
"nappa_tag": [
"black"
],
"grain_metallic": [
"purple",
"emerald",
"gold",
"silver"
]
}
},
"initials_patch": {
"suede": {
"white": {
"material": "nappa",
"color": "white"
},
"black": {
"material": "nappa",
"color": "black"
},
"navy": {
"material": "nappa",
"color": "navy"
},
"cobalt": {
"material": "nappa",
"color": "cobalt"
},
"red": {
"material": "nappa",
"color": "red"
},
"fuchsia": {
"material": "nappa",
"color": "fuchsia"
},
"chocolate": {
"material": "nappa",
"color": "chocolate"
},
"terracotta": {
"material": "nappa",
"color": "terracotta"
},
"beige": {
"material": "nappa",
"color": "beige"
},
"forest_green": {
"material": "nappa",
"color": "forest_green"
}
},
"hairy_calf": {
"white": {
"material": "nappa",
"color": "white"
},
"black": {
"material": "nappa",
"color": "black"
},
"navy": {
"material": "nappa",
"color": "navy"
},
"cobalt": {
"material": "nappa",
"color": "cobalt"
},
"red": {
"material": "nappa",
"color": "red"
},
"fuchsia": {
"material": "nappa",
"color": "fuchsia"
},
"terracotta": {
"material": "nappa",
"color": "terracotta"
},
"tan": {
"material": "nappa",
"color": "beige"
},
"mustard": {
"material": "nappa",
"color": "mustard"
},
"burnt_orange": {
"material": "nappa",
"color": "burnt_orange"
},
"leopard": {
"material": "nappa",
"color": "beige"
},
"camouflage": {
"material": "nappa",
"color": "forest_green"
}
},
"ostrich": {
"white": {
"material": "nappa",
"color": "white"
},
"black": {
"material": "nappa",
"color": "black"
},
"tan": {
"material": "nappa",
"color": "terracotta"
},
"neon_yellow": {
"material": "nappa",
"color": "neon_yellow"
},
"grey": {
"material": "nappa",
"color": "grey"
}
},
"python": {
"white": {
"material": "nappa",
"color": "white"
},
"black": {
"material": "nappa",
"color": "black"
},
"natural": {
"material": "nappa",
"color": "off_white"
},
"silver": {
"material": "metallic",
"color": "silver"
},
"gold": {
"material": "metallic",
"color": "gold"
},
"neon_white": {
"material": "nappa",
"color": "off_white"
}
},
"crocodile": {
"white": {
"material": "nappa",
"color": "white"
},
"black": {
"material": "nappa",
"color": "black"
},
"navy": {
"material": "nappa",
"color": "navy"
},
"red": {
"material": "nappa",
"color": "red"
},
"tan": {
"material": "nappa",
"color": "terracotta"
},
"nude": {
"material": "nappa",
"color": "beige"
},
"silver": {
"material": "metallic",
"color": "silver"
},
"antique_gold": {
"material": "metallic",
"color": "gold"
}
}
},
"initials_patch_materials": [
"embossed"
],
"initials_dot_materials": [
"embossed"
],
"initials_pivot_part": "front",
"always_patch": false,
"alias": {},
"restrictions": [],
"meta": {},
"locales": [
"en_us",
"ar",
"da_dk",
"de_de",
"es_es",
"fr_fr",
"it_it",
"ja_jp",
"ko_kr",
"nl_nl",
"pt_br",
"ru_ru",
"sv_se",
"zh_cn"
],
"size": [
1000,
1000
]
}
This endpoint gets a configuration based on a specific brand and model. If a country/flag is specified then only the materials available to that country will be provided. For example, some exotic materials might not be allowed under a country's law or when the flag is set to an arbitrary value, ie vegan.
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/brands/<text:brand>/models/<text:model>/config
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| country | no | text | null |
The ISO 3166-2 code of the country. |
| flag | no | text | null |
The flag value. |
| filter | no | text | true |
If the configuration should be filtered by the country and/or flag. |
Validate
Example Request
curl "https://ripe-core-sbx.platforme.com/api/brands/swear/models/vyner/validate?p=laces:nylon:white"
Example Response
{
"valid": false,
"issues": [
"Mandatory part 'lining' not defined",
"Mandatory part 'front' not defined",
"Mandatory part 'side' not defined",
"Mandatory part 'sole' not defined",
"Mandatory part 'logo' not defined",
"Mandatory part 'hardware' not defined",
"Mandatory part 'shadow' not defined"
]
}
This endpoint verifies a configuration based on a specific brand and model. If a required part is missing or if the part:material:color combination has invalid values, the configuration will not be validated.
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/brands/<text:brand>/models/<text:model>/validate
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| p | no | text | null |
The configuration of the model, described as a sequence of triplets in the form of part:material:color. |
Defaults
Example Request
curl "https://ripe-core-sbx.platforme.com/api/brands/swear/models/vyner/defaults"
Example Response
{
"model": "vyner",
"parts": {
"lining": {
"material": "calf_lining",
"color": "white",
"face": "top"
},
"front": {
"material": "nappa",
"color": "white",
"face": "side"
},
"side": {
"material": "nappa",
"color": "white",
"face": "side",
"frame": 0
},
"sole": {
"material": "rubber",
"color": "white",
"face": "side"
},
"laces": {
"material": "nylon",
"color": "white",
"face": "top"
},
"logo": {
"hidden": true,
"material": "metal",
"color": "silver"
},
"hardware": {
"material": "metal",
"color": "silver",
"face": "side",
"frame": 0
},
"shadow": {
"hidden": true,
"material": "default",
"color": "default"
}
}
}
This endpoint gets a the default customization of a specific brand and model. The default customization is the suggested customization to be used on the base product.
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/brands/<text:brand>/models/<text:model>/defaults
Factory
Example Request
curl "https://ripe-core-sbx.platforme.com/api/brands/swear/models/vyner/factory"
Example Response
{
"brand": "swear",
"model": "vyner",
"factory": "FLAJ",
"production_time": 10
}
Gets the factory information where a specific model is made, specifically its name and the estimated production time in days.
HTTP Request
GET /api/brands/<text:brand>/models/<text:model>/factory
Resources
Config
| Field | Type | Description |
|---|---|---|
| brand | text | Product's brand. |
| name | text | Product's name. |
| description | text | Product description text. |
| title | text | Product marketing name. |
| style | text | Style (as an open string) of the model. |
| scale | text | Scale available for the product. |
| gender | text | The gender of the product, it can be "male", "female" or "both". |
| observations | text | Complementary description text. |
| tags | list | List of tags that define certain behaviours for the product. |
| sizes | dictionary | The start, end, and step for each scale of each available gender. |
| frames | number | The number of side frames, all other views are considered to have only one frame. |
| faces | list of text | The available perspective of the product. |
| faces_m | dictionary | The number of frames of each face and a boolean to define if there is a thumbnail or not. |
| parts | dictionary | Describes all customization products part and correspondent materials and colors. |
| defaults | dictionary | Default material and color for every part. |
| hidden | list of text | The parts that can't be customized by the end user. |
| order | dictionary | Defines the order in which the original parts, materials and colors should be presented in the layout. |
| alias | dictionary | Defines visual alias for part, materials or colors, note that a fully qualified name may be used to reduce ambiguity. |
| blacklist | dictionary | Prevent combinations of appearing. |
| restrictions | list of dictionary | Prevents parts or pairs of material-color from appearing together, meaning that when one is present on the customization, the other won't appear in the UI for selection, special cases exist for a single element item where that combination is always excluded from the UI (hard restriction). |
| sync | dictionary | the parts that must have the same material and color, when one is changed the others should also change to the same combination. |
| z_index | list of text | Defines the part's priorities for drawing, this should ensure proper layering of the model (no hidden parts). |
Defaults
See Config's defaults field.
Order Endpoints
An order includes general information about a product's transaction entry and processing. Platforme API allows to access to that information from the already existing orders but also to import new orders to the system. Furthermore, production order reports may be generated.
Show
Example Request
curl "https://ripe-core-sbx.platforme.com/api/orders/4683" \
-H "X-Secret-Key: $RIPE_KEY"
Example Response
{
"_id": "5fa3fd91b080aee841e10914",
"id": 17113,
"number": 17113,
"enabled": true,
"description": null,
"created": 1604582801,
"modified": 1604582801,
"meta": {
"sku": "ccfe3ff8-6d73-46db-aaaa-c2eddee402d4"
},
"brand_t": "swear",
"retailer_t": null,
"vendor_t": null,
"key": "aae9690df387ba3f1e3cd28c9ebb8e5b4a8f2fcd",
"status": "created",
"status_index": 1,
"production_status": "unset",
"production": "produce",
"gender": "female",
"currency": "USD",
"country": "US",
"price": 205.0,
"prices": {
"components": {
"front": {
"rule_id": 18660,
"rule_count": 4,
"price_taxes": 10.0,
"vat": 1.87,
"vat_rate": 23.0,
"price": 8.13,
"currency": "USD",
"hs_code": 6403999065,
"notes": [
"Nappa Leather"
],
"hs_code_priority": 1,
"price_original": 10.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"hardware": {
"rule_id": 20441,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 23.0,
"price": 0.0,
"currency": "USD",
"hs_code": 6403999065,
"notes": [],
"hs_code_priority": 1,
"price_original": 0.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"laces": {
"rule_id": 18673,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 23.0,
"price": 0.0,
"currency": "USD",
"hs_code": 6403999065,
"notes": [],
"hs_code_priority": 1,
"price_original": 0.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"lining": {
"rule_id": 20442,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 23.0,
"price": 0.0,
"currency": "USD",
"hs_code": 6403999065,
"notes": [],
"hs_code_priority": 1,
"price_original": 0.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"side": {
"rule_id": 18680,
"rule_count": 4,
"price_taxes": 20.0,
"vat": 3.74,
"vat_rate": 23.0,
"price": 16.26,
"currency": "USD",
"hs_code": 6403999065,
"notes": [
"Nappa Leather"
],
"hs_code_priority": 1,
"price_original": 20.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"sole": {
"rule_id": 20444,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 23.0,
"price": 0.0,
"currency": "USD",
"hs_code": 6403999065,
"notes": [
"Rubber"
],
"hs_code_priority": 1,
"price_original": 0.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"logo": {
"rule_id": 18690,
"rule_count": 2,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 23.0,
"price": 0.0,
"currency": "USD",
"hs_code": 6403999065,
"notes": [],
"hs_code_priority": 1,
"price_original": 0.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"shadow": {
"rule_id": 20424,
"rule_count": 3,
"price_taxes": 175.0,
"vat": 32.72,
"vat_rate": 23.0,
"price": 142.28,
"currency": "USD",
"hs_code": 6403999065,
"notes": [],
"hs_code_priority": 1,
"price_original": 175.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": null,
"cites": false
}
},
"total": {
"price_final": 205.0,
"price_taxes": 205.0,
"vat": 0.0,
"ddp": 0.0,
"ddp_percent": 0.0,
"vat_rate": 0.0,
"price": 205.0,
"currency": "USD",
"country": "US",
"hs_codes": [
6403999065
],
"hs_code_priority": 1,
"shipping": 0.0,
"notes": [
"Nappa Leather",
"Rubber"
],
"diag": {
"no_round": {
"price_final": 205.0,
"price_taxes": 205.0,
"price": 205.0,
"vat": 0.0,
"ddp": 0.0
},
"patch": true,
"round_value": true,
"is_vat": false,
"is_ddp": true,
"is_european": false,
"is_rounded": false,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": null
},
"cites": false
}
},
"brand": "swear",
"shoe": "vyner",
"variant": null,
"shoe_query": "model=vyner&brand=swear&p=front:nappa:white&p=side:nappa:white&p=lining:calf_lining:white&p=laces:nylon:white&p=sole:rubber:white&p=hardware:metal:silver&p=logo:metal:silver&p=shadow:default:default",
"shoe_url": "/config/customization?model=vyner&brand=swear&p=front:nappa:white&p=side:nappa:white&p=lining:calf_lining:white&p=laces:nylon:white&p=sole:rubber:white&p=hardware:metal:silver&p=logo:metal:silver&p=shadow:default:default",
"image_url": "/compose?model=vyner&brand=swear&p=front:nappa:white&p=side:nappa:white&p=lining:calf_lining:white&p=laces:nylon:white&p=sole:rubber:white&p=hardware:metal:silver&p=logo:metal:silver&p=shadow:default:default",
"minify_hash": "Mzk4NjU",
"image_hash": "Mzk4NjY",
"image_o_hash": "Mzk4Njc",
"top_hash": "Mzk4Njg",
"top_o_hash": "Mzk4Njk",
"bottom_hash": "Mzk4NzA",
"bottom_o_hash": "Mzk4NzE",
"back_hash": "Mzk4NzI",
"side_hash": "Mzk4NzM",
"structure": "{\"brand\": \"swear\", \"model\": \"vyner\", \"variant\": null, \"parts\": [{\"material\": \"nappa\", \"color\": \"white\", \"name\": \"front\", \"hidden\": false, \"optional\": false}, {\"material\": \"nappa\", \"color\": \"white\", \"name\": \"side\", \"hidden\": false, \"optional\": false}, {\"material\": \"calf_lining\", \"color\": \"white\", \"name\": \"lining\", \"hidden\": false, \"optional\": false}, {\"material\": \"nylon\", \"color\": \"white\", \"name\": \"laces\", \"hidden\": false, \"optional\": false}, {\"material\": \"rubber\", \"color\": \"white\", \"name\": \"sole\", \"hidden\": false, \"optional\": false}, {\"material\": \"metal\", \"color\": \"silver\", \"name\": \"hardware\", \"hidden\": false, \"optional\": false}, {\"material\": \"metal\", \"color\": \"silver\", \"name\": \"logo\", \"hidden\": true, \"optional\": false}, {\"material\": \"default\", \"color\": \"default\", \"name\": \"shadow\", \"hidden\": true, \"optional\": false}], \"parts_m\": {\"front\": {\"material\": \"nappa\", \"color\": \"white\"}, \"hardware\": {\"material\": \"metal\", \"color\": \"silver\"}, \"laces\": {\"material\": \"nylon\", \"color\": \"white\"}, \"lining\": {\"material\": \"calf_lining\", \"color\": \"white\"}, \"side\": {\"material\": \"nappa\", \"color\": \"white\"}, \"sole\": {\"material\": \"rubber\", \"color\": \"white\"}, \"logo\": {\"material\": \"metal\", \"color\": \"silver\"}, \"shadow\": {\"material\": \"default\", \"color\": \"default\"}}, \"gender\": \"female\", \"size\": 25, \"query\": \"model=vyner&brand=swear&p=front:nappa:white&p=side:nappa:white&p=lining:calf_lining:white&p=laces:nylon:white&p=sole:rubber:white&p=hardware:metal:silver&p=logo:metal:silver&p=shadow:default:default\", \"url\": \"/config/customization?model=vyner&brand=swear&p=front:nappa:white&p=side:nappa:white&p=lining:calf_lining:white&p=laces:nylon:white&p=sole:rubber:white&p=hardware:metal:silver&p=logo:metal:silver&p=shadow:default:default\", \"image\": \"/compose?model=vyner&brand=swear&p=front:nappa:white&p=side:nappa:white&p=lining:calf_lining:white&p=laces:nylon:white&p=sole:rubber:white&p=hardware:metal:silver&p=logo:metal:silver&p=shadow:default:default\", \"extras\": 0}",
"ff_id": null,
"ff_shoe_id": 12212972,
"ff_order_id": "1b6a4686-e0a2-4e32-a7ee-e3c39288d370",
"delivery_time": 10,
"tracking_number": null,
"tracking_url": null,
"report_url_e": null,
"notes": [],
"states": [
{
"_id": "5fa3fd91b080aee841e1091a",
"id": 13559,
"enabled": true,
"description": null,
"created": 1604582801,
"modified": 1604582801,
"meta": {},
"brand_t": null,
"retailer_t": null,
"vendor_t": null,
"name": "created",
"justification": "Order import",
"timestamp": 1604582801,
"email": "docs@platforme.com",
"account": {
"_id": "5c7e68794ce4e7006b5c71c8",
"id": 30,
"enabled": true,
"description": "",
"created": 1551788153,
"modified": 1604582802,
"meta": {},
"username": "docs",
"email": "docs@platforme.com",
"facebook_id": "",
"github_login": "",
"google_id": "",
"live_id": "",
"twitter_username": "",
"type": 1,
"last_login": 1604582802,
"roles": [],
"avatar_url": "https://ripe-core-sbx.platforme.com/admin/accounts/docs/avatar"
}
}
],
"attachments": [],
"account": "docs@platforme.com",
"customer": null,
"ambassador": null,
"store": null,
"number_s": "#017113",
"channel": "digital",
"delivery_d": 1605446801.0,
"scale": "it",
"size_scaled": 38.0,
"details": {
"brand": "swear",
"model": "vyner",
"variant": null,
"parts": [
{
"material": "nappa",
"color": "white",
"name": "front",
"hidden": false,
"optional": false
},
{
"material": "nappa",
"color": "white",
"name": "side",
"hidden": false,
"optional": false
},
{
"material": "calf_lining",
"color": "white",
"name": "lining",
"hidden": false,
"optional": false
},
{
"material": "nylon",
"color": "white",
"name": "laces",
"hidden": false,
"optional": false
},
{
"material": "rubber",
"color": "white",
"name": "sole",
"hidden": false,
"optional": false
},
{
"material": "metal",
"color": "silver",
"name": "hardware",
"hidden": false,
"optional": false
},
{
"material": "metal",
"color": "silver",
"name": "logo",
"hidden": true,
"optional": false
},
{
"material": "default",
"color": "default",
"name": "shadow",
"hidden": true,
"optional": false
}
],
"parts_m": {
"front": {
"material": "nappa",
"color": "white"
},
"hardware": {
"material": "metal",
"color": "silver"
},
"laces": {
"material": "nylon",
"color": "white"
},
"lining": {
"material": "calf_lining",
"color": "white"
},
"side": {
"material": "nappa",
"color": "white"
},
"sole": {
"material": "rubber",
"color": "white"
},
"logo": {
"material": "metal",
"color": "silver"
},
"shadow": {
"material": "default",
"color": "default"
}
},
"gender": "female",
"size": 25,
"query": "model=vyner&brand=swear&p=front:nappa:white&p=side:nappa:white&p=lining:calf_lining:white&p=laces:nylon:white&p=sole:rubber:white&p=hardware:metal:silver&p=logo:metal:silver&p=shadow:default:default",
"url": "/config/customization?model=vyner&brand=swear&p=front:nappa:white&p=side:nappa:white&p=lining:calf_lining:white&p=laces:nylon:white&p=sole:rubber:white&p=hardware:metal:silver&p=logo:metal:silver&p=shadow:default:default",
"image": "/compose?model=vyner&brand=swear&p=front:nappa:white&p=side:nappa:white&p=lining:calf_lining:white&p=laces:nylon:white&p=sole:rubber:white&p=hardware:metal:silver&p=logo:metal:silver&p=shadow:default:default",
"extras": 0
}
}
Get details of a specific order, given its order number. Includes data from the product's composition, price, order tracking and production status.
Authentication credentials required.
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/orders/<number>
Header Fields
| Field | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| X-Secret-Key | yes | text | The X-Secret-Key to authenticate the request. |
Import
Example Request
curl -X POST \
"https://ripe-core-sbx.platforme.com/api/orders/import" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "X-Secret-Key: $RIPE_KEY" \
-d "ff_order_id=f5619fe4-d862-4be7-abdf-e039fd88ddb0" \
-d 'contents={
"brand": "swear",
"model": "vyner",
"variant": "",
"parts": {
"lining": {
"color": "white",
"material": "calf_lining"
},
"sole": {
"color": "white",
"material": "rubber"
},
"hardware": {
"color": "silver",
"material": "metal"
},
"laces": {
"color": "white",
"material": "nylon"
},
"front": {
"color": "white",
"material": "nappa"
},
"logo": {
"color": "silver",
"material": "metal"
},
"shadow": {
"color": "default",
"material": "default"
},
"side": {
"color": "white",
"material": "nappa"
}
},
"engraving": "metal_silver:style",
"initials": "aa",
"size": 25,
"product_id": 11221602
}
' \
-d "meta=sku:{sku_here}" \
-d "notify=1"\
-d "country=US"\
-d "currency=USD"
Example Request
curl -X POST \
"https://ripe-core-sbx.platforme.com/api/orders/import" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "X-Secret-Key: $RIPE_KEY" \
-d "ff_order_id={ff_order_id_here}" \
-d "dku=swear.vyner.-1.3%3A10.0%3A2.0%3A18.0%3A3.4%3A10.0%3A5.4%3A0%3A2.5%3A0%3A0.%24s%3A25" \
-d "notify=1"\
-d "country=US"\
-d "currency=USD"
Example Response
{
"_id": "5fa3fd93b080aee841e10921",
"id": 17114,
"number": 17114,
"enabled": true,
"description": null,
"created": 1604582803,
"modified": 1604582803,
"meta": {
"sku": "0cb300cd-6e88-4cdc-90ce-0686547ff381",
"notified": 1604582803
},
"brand_t": "swear",
"retailer_t": null,
"vendor_t": null,
"key": "607f1f15848ec0af0836cf655d0c91885b32c337",
"status": "created",
"status_index": 1,
"production_status": "unset",
"production": "produce",
"gender": "female",
"currency": "USD",
"country": "US",
"price": 205.0,
"prices": {
"components": {
"lining": {
"rule_id": 20442,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 23.0,
"price": 0.0,
"currency": "USD",
"hs_code": 6403999065,
"notes": [],
"hs_code_priority": 1,
"price_original": 0.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"sole": {
"rule_id": 20444,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 23.0,
"price": 0.0,
"currency": "USD",
"hs_code": 6403999065,
"notes": [
"Rubber"
],
"hs_code_priority": 1,
"price_original": 0.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"hardware": {
"rule_id": 20441,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 23.0,
"price": 0.0,
"currency": "USD",
"hs_code": 6403999065,
"notes": [],
"hs_code_priority": 1,
"price_original": 0.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"laces": {
"rule_id": 18673,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 23.0,
"price": 0.0,
"currency": "USD",
"hs_code": 6403999065,
"notes": [],
"hs_code_priority": 1,
"price_original": 0.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"front": {
"rule_id": 18660,
"rule_count": 4,
"price_taxes": 10.0,
"vat": 1.87,
"vat_rate": 23.0,
"price": 8.13,
"currency": "USD",
"hs_code": 6403999065,
"notes": [
"Nappa Leather"
],
"hs_code_priority": 1,
"price_original": 10.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"logo": {
"rule_id": 18690,
"rule_count": 2,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 23.0,
"price": 0.0,
"currency": "USD",
"hs_code": 6403999065,
"notes": [],
"hs_code_priority": 1,
"price_original": 0.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"shadow": {
"rule_id": 20424,
"rule_count": 3,
"price_taxes": 175.0,
"vat": 32.72,
"vat_rate": 23.0,
"price": 142.28,
"currency": "USD",
"hs_code": 6403999065,
"notes": [],
"hs_code_priority": 1,
"price_original": 175.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"side": {
"rule_id": 18680,
"rule_count": 4,
"price_taxes": 20.0,
"vat": 3.74,
"vat_rate": 23.0,
"price": 16.26,
"currency": "USD",
"hs_code": 6403999065,
"notes": [
"Nappa Leather"
],
"hs_code_priority": 1,
"price_original": 20.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"engraving": {
"rule_id": 20448,
"rule_count": 2,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 23.0,
"price": 0.0,
"currency": "USD",
"price_original": 0.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": null
}
},
"total": {
"price_final": 205.0,
"price_taxes": 205.0,
"vat": 0.0,
"ddp": 0.0,
"ddp_percent": 0.0,
"vat_rate": 0.0,
"price": 205.0,
"currency": "USD",
"country": "US",
"hs_codes": [
6403999065,
null
],
"hs_code_priority": -1,
"shipping": 0.0,
"notes": [
"Nappa Leather",
"Rubber"
],
"diag": {
"no_round": {
"price_final": 205.0,
"price_taxes": 205.0,
"price": 205.0,
"vat": 0.0,
"ddp": 0.0
},
"patch": true,
"round_value": true,
"is_vat": false,
"is_ddp": true,
"is_european": false,
"is_rounded": false,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "PT",
"base_currency": "EUR",
"exchanged": null
},
"cites": false
}
},
"brand": "swear",
"shoe": "vyner",
"variant": "",
"shoe_query": "model=vyner&brand=swear&p=front:nappa:white&p=side:nappa:white&p=lining:calf_lining:white&p=laces:nylon:white&p=sole:rubber:white&p=hardware:metal:silver&p=logo:metal:silver&p=shadow:default:default",
"shoe_url": "/config/customization?model=vyner&brand=swear&p=front:nappa:white&p=side:nappa:white&p=lining:calf_lining:white&p=laces:nylon:white&p=sole:rubber:white&p=hardware:metal:silver&p=logo:metal:silver&p=shadow:default:default",
"image_url": "/compose?model=vyner&brand=swear&p=front:nappa:white&p=side:nappa:white&p=lining:calf_lining:white&p=laces:nylon:white&p=sole:rubber:white&p=hardware:metal:silver&p=logo:metal:silver&p=shadow:default:default",
"minify_hash": "Mzk4NjU",
"image_hash": "Mzk4NjY",
"image_o_hash": "Mzk4Njc",
"top_hash": "Mzk4Njg",
"top_o_hash": "Mzk4Njk",
"bottom_hash": "Mzk4NzA",
"bottom_o_hash": "Mzk4NzE",
"back_hash": "Mzk4NzI",
"side_hash": "Mzk4NzM",
"structure": "{\"brand\": \"swear\", \"model\": \"vyner\", \"variant\": \"\", \"parts\": [{\"color\": \"white\", \"material\": \"nappa\", \"name\": \"front\", \"hidden\": false, \"optional\": false}, {\"color\": \"white\", \"material\": \"nappa\", \"name\": \"side\", \"hidden\": false, \"optional\": false}, {\"color\": \"white\", \"material\": \"calf_lining\", \"name\": \"lining\", \"hidden\": false, \"optional\": false}, {\"color\": \"white\", \"material\": \"nylon\", \"name\": \"laces\", \"hidden\": false, \"optional\": false}, {\"color\": \"white\", \"material\": \"rubber\", \"name\": \"sole\", \"hidden\": false, \"optional\": false}, {\"color\": \"silver\", \"material\": \"metal\", \"name\": \"hardware\", \"hidden\": false, \"optional\": false}, {\"color\": \"silver\", \"material\": \"metal\", \"name\": \"logo\", \"hidden\": true, \"optional\": false}, {\"color\": \"default\", \"material\": \"default\", \"name\": \"shadow\", \"hidden\": true, \"optional\": false}], \"parts_m\": {\"lining\": {\"color\": \"white\", \"material\": \"calf_lining\"}, \"sole\": {\"color\": \"white\", \"material\": \"rubber\"}, \"hardware\": {\"color\": \"silver\", \"material\": \"metal\"}, \"laces\": {\"color\": \"white\", \"material\": \"nylon\"}, \"front\": {\"color\": \"white\", \"material\": \"nappa\"}, \"logo\": {\"color\": \"silver\", \"material\": \"metal\"}, \"shadow\": {\"color\": \"default\", \"material\": \"default\"}, \"side\": {\"color\": \"white\", \"material\": \"nappa\"}}, \"gender\": \"female\", \"size\": 25, \"query\": \"model=vyner&brand=swear&p=front:nappa:white&p=side:nappa:white&p=lining:calf_lining:white&p=laces:nylon:white&p=sole:rubber:white&p=hardware:metal:silver&p=logo:metal:silver&p=shadow:default:default\", \"url\": \"/config/customization?model=vyner&brand=swear&p=front:nappa:white&p=side:nappa:white&p=lining:calf_lining:white&p=laces:nylon:white&p=sole:rubber:white&p=hardware:metal:silver&p=logo:metal:silver&p=shadow:default:default\", \"image\": \"/compose?model=vyner&brand=swear&p=front:nappa:white&p=side:nappa:white&p=lining:calf_lining:white&p=laces:nylon:white&p=sole:rubber:white&p=hardware:metal:silver&p=logo:metal:silver&p=shadow:default:default\", \"extras\": 0, \"engraving\": \"metal_silver:style\", \"initials\": \"AA\", \"initials_extra\": {\"main\": {\"initials\": \"AA\", \"engraving\": \"metal_silver:style\"}}}",
"ff_id": null,
"ff_shoe_id": 12212972,
"ff_order_id": "f5619fe4-d862-4be7-abdf-e039fd88ddb0",
"delivery_time": 10,
"tracking_number": null,
"tracking_url": null,
"report_url_e": null,
"notes": [],
"states": [
{
"_id": "5fa3fd93b080aee841e10927",
"id": 13560,
"enabled": true,
"description": null,
"created": 1604582803,
"modified": 1604582803,
"meta": {},
"brand_t": null,
"retailer_t": null,
"vendor_t": null,
"name": "created",
"justification": "Order import",
"timestamp": 1604582803,
"email": "docs@platforme.com",
"account": {
"_id": "5c7e68794ce4e7006b5c71c8",
"id": 30,
"enabled": true,
"description": "",
"created": 1551788153,
"modified": 1604582803,
"meta": {},
"username": "docs",
"email": "docs@platforme.com",
"facebook_id": "",
"github_login": "",
"google_id": "",
"live_id": "",
"twitter_username": "",
"type": 1,
"last_login": 1604582803,
"roles": [],
"avatar_url": "https://ripe-core-sbx.platforme.com/admin/accounts/docs/avatar"
}
}
],
"attachments": [],
"account": "docs@platforme.com",
"customer": null,
"ambassador": null,
"store": null,
"number_s": "#017114",
"channel": "digital",
"delivery_d": 1605446803.0,
"scale": "it",
"size_scaled": 38.0,
"details": {
"brand": "swear",
"model": "vyner",
"variant": "",
"parts": [
{
"color": "white",
"material": "nappa",
"name": "front",
"hidden": false,
"optional": false
},
{
"color": "white",
"material": "nappa",
"name": "side",
"hidden": false,
"optional": false
},
{
"color": "white",
"material": "calf_lining",
"name": "lining",
"hidden": false,
"optional": false
},
{
"color": "white",
"material": "nylon",
"name": "laces",
"hidden": false,
"optional": false
},
{
"color": "white",
"material": "rubber",
"name": "sole",
"hidden": false,
"optional": false
},
{
"color": "silver",
"material": "metal",
"name": "hardware",
"hidden": false,
"optional": false
},
{
"color": "silver",
"material": "metal",
"name": "logo",
"hidden": true,
"optional": false
},
{
"color": "default",
"material": "default",
"name": "shadow",
"hidden": true,
"optional": false
}
],
"parts_m": {
"lining": {
"color": "white",
"material": "calf_lining"
},
"sole": {
"color": "white",
"material": "rubber"
},
"hardware": {
"color": "silver",
"material": "metal"
},
"laces": {
"color": "white",
"material": "nylon"
},
"front": {
"color": "white",
"material": "nappa"
},
"logo": {
"color": "silver",
"material": "metal"
},
"shadow": {
"color": "default",
"material": "default"
},
"side": {
"color": "white",
"material": "nappa"
}
},
"gender": "female",
"size": 25,
"query": "model=vyner&brand=swear&p=front:nappa:white&p=side:nappa:white&p=lining:calf_lining:white&p=laces:nylon:white&p=sole:rubber:white&p=hardware:metal:silver&p=logo:metal:silver&p=shadow:default:default",
"url": "/config/customization?model=vyner&brand=swear&p=front:nappa:white&p=side:nappa:white&p=lining:calf_lining:white&p=laces:nylon:white&p=sole:rubber:white&p=hardware:metal:silver&p=logo:metal:silver&p=shadow:default:default",
"image": "/compose?model=vyner&brand=swear&p=front:nappa:white&p=side:nappa:white&p=lining:calf_lining:white&p=laces:nylon:white&p=sole:rubber:white&p=hardware:metal:silver&p=logo:metal:silver&p=shadow:default:default",
"extras": 0,
"engraving": "metal_silver:style",
"initials": "AA",
"initials_extra": {
"main": {
"initials": "AA",
"engraving": "metal_silver:style"
}
}
}
}
Import an order to the system with a set of parameters used for the creation of that order. If the current email from session exists, it will be retrieved so that it may be used as the owner of the order (ambassador).
Admin authentication is required.
HTTP Request
POST https://ripe-core-sbx.platforme.com/api/orders/import
Besides the order's import, the following generates the respective production order report as a PDF file format.
POST https://ripe-core-sbx.platforme.com/api/orders/import.pdf
Header Fields
| Field | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| X-Secret-Key | yes | text | The X-Secret-Key to authenticate the request. |
POST Body
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| ff_order_id | yes | text | The e-commerce order identifier. | |
| contents | no | text | JSON encoded string values with all the information about the order structure. | |
| dku | no | text | DKU representation of all the information about the order customization. | |
| currency | no | text | EUR |
The ISO 4217 currency code, used for price calculation. |
| country | no | text | US |
The ISO 3166-2 country code, used for price calculation. |
| meta | no | text | null |
Complementary information to be added, key:value comma separated format (ie: key1:value1,key2:value2). |
| notify | no | boolean | false |
Mark order to trigger notification after creation. |
| pending | no | boolean | false |
Sets the order's initial status as "Pending" so it has to be confirmed. |
Report
Example Request
curl "https://ripe-core-sbx.platforme.com/api/orders/5650/report.pdf?\
key=fd90212e5ebf4135da14ca511b84811ff4fc6b8a"
> report_order_5650.pdf
The above command returns a PDF file
Example Request
curl "https://ripe-core-sbx.platforme.com/api/orders/5650/report.png?\
key=fd90212e5ebf4135da14ca511b84811ff4fc6b8a"
> report_order_5650.png
The above command returns an image with the PNG file extension
Get a production order report, regarding the given order number, in PDF or PNG file formats. This report is mainly issued to the production factory, summarizing multiple aspects of the ordered product's composition, customization and personalization. It also provides a barcode and a QR (Quick Response) code to be scanned.
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/orders/<number>/report.pdf
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/orders/<number>/report.png
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| key | yes | text | The order's unique secret key value used for private information access. |
Factory
Example Request
curl "https://ripe-core-sbx.platforme.com/api/orders/4683/factory" \
-H "X-Secret-Key: $RIPE_KEY"
Example Response
{
"number": 4683,
"factory": "FLAJ"
}
Get the factory name of a specific order, given its order number.
Authentication credentials required.
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/orders/<number>/factory
Header Fields
| Field | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| X-Secret-Key | yes | text | The X-Secret-Key to authenticate the request. |
Resources
Order
| Field | Type | Description |
|---|---|---|
| id | number | Order production identifier. |
| key | number | Order production key identifier. |
| number | number | Order production number. |
| number_s | text | Order production number in text format. |
| ff_order_id | number | Order production's related order sales identifier. |
| shoe_url | text | Canonical customization URL. |
| states | list of states | List of states that the order production has gone through. |
| shoe | text | Model name. |
| ff_id | text | The concrete identifier of the model that represents the entry point for a specific customization of a product (customization alias). |
| ff_shoe_id | text | The model identifier of the base shoe that is used for the order production. |
| image_url | text | URL to a rendered order's model image. |
| image_hash | text | Minified URL to a rendered order's model image. |
| image_o_hash | text | Minified URL to a rendered overlayed order's model image. |
| side_hash | text | Minified URL to a rendered order's model side view image. |
| back_hash | text | Minified URL to a rendered order's model back view image. |
| top_hash | text | Minified URL to a rendered order's model top view image. |
| top_o_hash | text | Minified URL to a rendered overlayed order's model top view image. |
| bottom_hash | text | Minified URL to a rendered order's model bottom view image. |
| bottom_o_hash | text | Minified URL to a rendered overlayed order's model bottom view image. |
| minify_hash | text | Minified version of the canonical customization URL. |
| production | text | Kind of production strategy (one of "produce", "prototype", "reference"). |
| store | text | The store from which this order was generated, this is only populated in case the a store is defined for the source of the order. |
| status | text | Order production's status (one of pending, created, production, ready, sent, received, returned, canceled). |
| account | text | System account responsible for the handling of the production order. |
| ambassador | text | In case it's set, defines the ambassador to which this production order belongs. |
| customer | text | Reference to the account of the customer (or an employee representing him) to which this order belongs. |
| gender | text | Order production's model gender. |
| country | text | Order production's product country destination. |
| currency | text | Currency used to calculate the price. |
| meta | dictionary | Complementary order production data. |
| price | number | Order's production customization cost price. |
| prices | dictionary | Order's production structured price information (see Price Component). |
| shoe_query | text | Canonical customization query. |
| tracking_number | text | Shipping tracking number. |
| tracking_url | text | URL to the Postal Service shipping information page. |
| structure | text | Structured information about the order's production (JSON encoded data.). |
| details | dictionary | Structured information about the order's production (contents of structure parsed). |
| created | date time | Date when the order production was initially created. |
| modified | date time | The date and time of the latest modification operation. |
Sizes Endpoints
Sizes
Example Request
curl "https://ripe-core-sbx.platforme.com/api/sizes"
Example Response
{
"it": [
"female",
"male"
],
"it_kirkwood": [
"female"
],
"it_n21": [
"male"
],
"fr": [
"female"
],
"uk": [
"female",
"male"
],
"us": [
"female",
"male"
],
"ch": [
"female",
"male"
],
"jp": [
"female",
"male"
],
"bag": [
"female"
],
"one_size": [
"female",
"male"
],
"us:clothing": [
"female",
"male"
],
"std:clothing": [
"female",
"kids",
"male"
],
"it:clothing": [
"female"
],
"fr:clothing": [
"female"
],
"au:clothing": [
"female"
],
"fr:belt": [
"female",
"male"
]
}
This endpoint provides a list of the available size scales. It is used to find out which scales can be used in the convertions from and to the specified scale.
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/sizes
Native To Size
Example Request
curl "https://ripe-core-sbx.platforme.com/api/sizes/native_to_size?gender=male&scale=it&value=41"
Example Response
{
"value": 48.0
}
This endpoint converts a native size value to corresponding value in the specified scale.
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/sizes/native_to_size
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| scale | yes | text | The scale which one wants to convert to. | |
| value | yes | numeric | The value which one wants to convert. | |
| gender | yes | text | The gender of the scale and value to be converted. The available genders are listed using the sizes api. |
Size To Native
Example Request
curl "https://ripe-core-sbx.platforme.com/api/sizes/size_to_native?gender=male&scale=it&value=48"
Example Response
{
"scale": "it",
"value": 41,
"native": 41
}
This endpoint converts a size value in the specified scale to the corresponding native size.
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/sizes/size_to_native
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| scale | yes | text | The scale which one wants to convert from. | |
| value | yes | numeric | The value which one wants to convert. | |
| gender | yes | text | The gender of the scale and value to be converted. The available genders are listed using the sizes api. |
Build Endpoints
Logo
curl "https://ripe-core-sbx.platforme.com/api/builds/swear/logo.png?size=large"
This endpoint gets the vendor's logo.
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/builds/<text:vendor>/logo.<format>
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| format | yes | text | The format of the image, (eg: png, jpg, svg, etc.). |
|
| size | no | text | null |
Logo's size, (eg: small, medium, large, etc.). |
Locale
Example Request
curl "https://ripe-core-sbx.platforme.com/api/builds/swear/locale?\
locale=es_es&\
values=\
part:side,\
material:nappa,\
color:green,\
property:gold,\
color:red:side:nappa"
Example Response
{
"brand": "swear",
"model": null,
"version": null,
"values": [
"part:side",
"material:nappa",
"color:green",
"property:gold",
"color:red:side:nappa"
],
"values_l": [
"Lateral",
"Napa",
"Verde",
"properties.gold",
"Rojo"
],
"locale": "es_es"
}
This endpoint is used to get the resolve of one or more values defined on a locale within a specific build.
The values field have specific semantic: a value is composed by a group of tokens separated by :.
The first and second tokens (scope and value respectively), define the section and value being translated and the remaining tokens are optional and are used to provide more specific contextual information.
Examples:
part:sidedenote the intent to resolve the valuesidewhen the scope ispartcolor:greendenote the intent to resolve the valuegreenwhen the scope iscolorcolor:red:side:nappadenote the intent to resolve thecolorredwhenpartissideand thematerialisnappa.
The most commonly used scopes are: part, material, color, property.
HTTP Request
GET /api/builds/<text:brand>/locale
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| model | no | text | The model's name at which the locale is bounded to. | |
| values | no | list of text | empty list | The values which one wants to get the locale of. |
| locale | no | text | en-us |
The locale which one wants to get the value from. |
Resources
Locale
| Field | Type | Description |
|---|---|---|
| brand | text | Vendor's name. |
| model | text | Models's name. |
| locale | text | The locale identifier following the format language-country, respectively in ISO 639-1 and ISO 3166-2 formats. |
| values | list of text | The list of values requested to get the locale of. |
| values_l | list of text | The list of localized values. |
Availability Rule Endpoints
List
The list endpoint returns the existing availability rules according to the given parameters. If no parameters are given, it will be returned all the availability rules the user has permissions to access. A user only has permission to access and modify data related to him, meaning that he can only access data from the brands he is responsible for.
Query support can be consulted here
Example Request
curl "https://ripe-core-sbx.platforme.com/api/availability_rules?filters[]=shoe:eq:vyner" \
-H "X-Secret-Key: $RIPE_KEY"
Example Response
[
{
"_id": "5fa3fc35d5b3435b0ce10eb1",
"id": 749,
"available": true,
"country": "US",
"flag": "no_exotic",
"brand": "swear",
"shoe": "vyner",
"part": "front",
"material": "nappa",
"color": "nappa",
"enabled": true,
"description": null,
"meta": {},
"brand_t": "swear",
"retailer_t": null,
"vendor_t": null,
"name": null,
"priority": null,
"variant": null,
"created": 1604582453,
"modified": 1604582453
},
{
"_id": "5fa3fc35c402e4dd1fe10253",
"id": 750,
"available": true,
"country": "US",
"flag": "no_exotic",
"brand": "swear",
"shoe": "vyner",
"part": "front",
"material": "nappa",
"color": "nappa",
"enabled": true,
"description": null,
"meta": {},
"brand_t": "swear",
"retailer_t": null,
"vendor_t": null,
"name": null,
"priority": null,
"variant": null,
"created": 1604582453,
"modified": 1604582453
},
{
"_id": "5fa3fc354c0880580fe103b8",
"id": 751,
"available": true,
"country": "US",
"flag": "no_exotic",
"brand": "swear",
"shoe": "vyner",
"part": "front",
"material": "nappa",
"color": "nappa",
"enabled": true,
"description": null,
"meta": {},
"brand_t": "swear",
"retailer_t": null,
"vendor_t": null,
"name": null,
"priority": null,
"variant": null,
"created": 1604582453,
"modified": 1604582453
}
]
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/availability_rules
Parameters
This request receives 2 parameters: filter_operator and filters. If filters is defined but not filter_operator, its default value will be $and.
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| filter_operator | no | text | $and |
The logic operator that unites all the options given in filters. |
| filters | no | text | null |
The filters that will be applied to the availability rules query. Must have the structure <parameter>:<operator>:<value>. More than one filter can be given to the query, and their application together is based on the filter_operator given. |
Filter Operator Values
| Value | Description |
|---|---|
| $and | The results given must comply with all the filters. |
| $or | The results given must comply with at least on of the filters. |
Filters Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| available | no | boolean | null |
The availability of the combination specified. |
| country | no | text | null |
The ISO 3166-2 code of the country to which the product is going to be purchased. |
| flag | no | text | null |
The flag value, which is used to identify arbitrary contexts (ie: seasonal promo, special event, among others) . |
| brand | no | text | null |
The model's brand. |
| shoe | no | text | null |
The model's name. |
| variant | no | text | null |
The variant (or sub-variant) of the specified model. |
| part | no | text | null |
The part of the model to which the availability rule will be applied. |
| material | no | text | null |
The material of the part to which the availability rule will be applied. |
| color | no | text | null |
The color of the material of the part to which the availability rule will be applied. |
| priority | no | number | null |
The priority of the availability rule. |
| name | no | text | null |
The name of the availability rule. |
Create
Creates an availability order for a specific combination of part, material and color of a model of a brand. If the user does not have permission for the given brand, an error is returned.
Example Request
curl -s -X POST \
"https://ripe-core-sbx.platforme.com/api/availability_rules" \
-H "Content-Type: application/json" \
-H "X-Secret-Key: $RIPE_KEY" \
-d '{
"available":"true",
"country":"US",
"flag":"no_exotic",
"brand":"swear",
"model":"vyner",
"part":"front",
"material":"nappa",
"color":"nappa"
}'
Example Response
{
"_id": "5fa3fd9621b62934fee10633",
"id": 753,
"available": true,
"country": "US",
"flag": "no_exotic",
"brand": "swear",
"shoe": "vyner",
"part": "front",
"material": "nappa",
"color": "nappa",
"enabled": true,
"description": null,
"meta": {},
"brand_t": "swear",
"retailer_t": null,
"vendor_t": null,
"name": null,
"priority": null,
"variant": null,
"created": 1604582806,
"modified": 1604582806
}
HTTP Request
POST https://ripe-core-sbx.platforme.com/api/availability_rules
POST Body
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| available | yes | boolean | null |
The availability of the combination specified. |
| country | yes | text | null |
The ISO 3166-2 code of the country to which the product is going to be purchased. |
| flag | no | text | null |
The flag value, which is used to identify arbitrary contexts (ie: seasonal promo, special event, among others) |
| brand | no | text | null |
The model's brand. |
| shoe | no | text | null |
The model's name. |
| variant | no | text | null |
The variant (or sub-variant) of the specified model. |
| part | no | text | null |
The part of the model to which the availability rule will be applied. |
| material | no | text | null |
The material of the part to which the availability rule will be applied. |
| color | no | text | null |
The color of the material of the part to which the availability rule will be applied. |
| priority | no | number | null |
The priority of the availability rule. |
| name | no | text | null |
The name of the availability rule. |
Show
Returns the availability with the given ID. If the user does not have permissions to access the rule's brand, returns a Not Found Exception (404) error.
Example Request
curl "https://ripe-core-sbx.platforme.com/api/availability_rules/<id>" \
-H "X-Secret-Key: $RIPE_KEY"
Example Response
{
"_id": "5fa3fd97d5b3435b0ce10eb7",
"id": 754,
"available": true,
"country": "US",
"flag": "no_exotic",
"brand": "swear",
"shoe": "vyner",
"part": "front",
"material": "nappa",
"color": "nappa",
"enabled": true,
"description": null,
"meta": {},
"brand_t": "swear",
"retailer_t": null,
"vendor_t": null,
"name": null,
"priority": null,
"variant": null,
"created": 1604582807,
"modified": 1604582807
}
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/availability_rules/<id>
Update
Updates the availability with the given ID. If the user does not have permissions to update the rule's brand, returns a Not Found Exception (404) error.
Example Request
curl -s -X PUT \
"https://ripe-core-sbx.platforme.com/api/availability_rules/1" \
-H "Content-Type: application/json" \
-H "X-Secret-Key: $RIPE_KEY" \
-d '{
"available":"true",
"country":"US",
"flag":"no_exotic",
"brand":"swear",
"shoe":"vyner",
"part":"front",
"material":"nappa",
"color":"nappa"
}'
Example Response
{
"_id": "5fa3fd9819a73fb8fee10583",
"id": 755,
"available": true,
"country": "US",
"flag": "no_exotic",
"brand": "swear",
"shoe": "vyner",
"part": "front",
"material": "nappa",
"color": "nappa",
"enabled": true,
"description": null,
"meta": {},
"brand_t": "swear",
"retailer_t": null,
"vendor_t": null,
"name": null,
"priority": null,
"variant": null,
"created": 1604582808,
"modified": 1604582808
}
HTTP Request
PUT https://ripe-core-sbx.platforme.com/api/availability_rules/<number>
POST Body
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| available | yes | boolean | null |
The availability of the combination specified. |
| country | yes | text | null |
The ISO 3166-2 code of the country to which the product is going to be purchased. |
| flag | no | text | null |
The flag value, which is used to identify arbitrary contexts (ie: seasonal promo, special event, among others) |
| brand | no | text | null |
The model's brand. |
| shoe | no | text | null |
The model's name. |
| variant | no | text | null |
The variant (or sub-variant) of the specified model. |
| part | no | text | null |
The part of the model to which the availability rule will be applied. |
| material | no | text | null |
The material of the part to which the availability rule will be applied. |
| color | no | text | null |
The color of the material of the part to which the availability rule will be applied. |
| priority | no | number | null |
The priority of the availability rule. |
| name | no | text | null |
The name of the availability rule. |
Delete
Deletes the availability with the given ID. If the user does not have permissions to access the rule's brand, returns a Not Found Exception (404) error.
Example Request
curl -s -X DELETE "https://ripe-core-sbx.platforme.com/api/config/availability/1" \
-H "X-Secret-Key: $RIPE_KEY"
Example Response
{
"result": "success"
}
HTTP Request
DELETE https://ripe-core-sbx.platforme.com/api/availability_rules/<number>
Webhooks Endpoints
List
Lists all webhooks that one has subscribed to, displaying webhooks subscription data such as the url and arguments.
For a complete list of names for the webhooks available use this reference.
Example Request
curl "https://ripe-core-sbx.platforme.com/api/webhooks" \
-H "X-Secret-Key: $RIPE_KEY"
Example Response
[
{
"id": 101,
"event": "order.created",
"username": "docs",
"url": "https://domain.tld/path101",
"arguments": {}
},
{
"id": 102,
"event": "order.ready",
"username": "docs",
"url": "https://domain.tld/path102",
"arguments": {}
},
{
"id": 103,
"event": "order.send",
"username": "docs",
"url": "https://domain.tld/path103",
"arguments": {}
}
]
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/webhooks
Header Fields
| Field | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| X-Secret-Key | yes | text | The X-Secret-Key to authenticate the request. |
Show
Shows the subscription data of registered webhook, identified by its id.
For a complete list of names for the webhooks available use this reference.
Example Request
curl "https://ripe-core-sbx.platforme.com/api/webhooks/101" \
-H "X-Secret-Key: $RIPE_KEY"
Example Response
{
"id": 101,
"event": "order.created",
"username": "docs",
"url": "https://domain.tld/path101",
"arguments": {}
}
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/webhooks/<number>
Header Fields
| Field | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| X-Secret-Key | yes | text | The X-Secret-Key to authenticate the request. |
Subscribe
Subscribes a webhook to an event. Every time there's a new occurrence the webhook will be triggered with the event's payload.
For a complete list of names for the webhooks available use this reference.
Example Request
curl -X POST \
"https://ripe-core-sbx.platforme.com/api/webhooks" \
-H "X-Secret-Key: $RIPE_KEY" \
-d '{
"event": "order.created",
"url": "https://domain.tld/path"
}'
Example Response
{
"event": "order.created",
"url": "https://domain.tld/path",
"id": 1,
"username": "docs",
"arguments": {}
}
HTTP Request
POST https://ripe-core-sbx.platforme.com/api/webhooks
Header Fields
| Field | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| X-Secret-Key | yes | text | The X-Secret-Key to authenticate the request. |
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| event | yes | text | The event name. | |
| url | yes | text | The webhook url. | |
| arguments | no | dictionary | A pair (key, value) of arguments to the specific event. |
Unsubscribe
Unsubscribes an webhook from the system.
For a complete list of names for the webhooks available use this reference.
Example Request
curl -X DELETE \
"https://ripe-core-sbx.platforme.com/api/webhooks/101" \
-H "X-Secret-Key: $RIPE_KEY"
Example Response
{
"id": 101,
"event": "order.created",
"username": "docs",
"url": "https://domain.tld/path101",
"arguments": {}
}
HTTP Request
DELETE https://ripe-core-sbx.platforme.com/api/webhooks/101
Header Fields
| Field | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| X-Secret-Key | yes | text | The X-Secret-Key to authenticate the request. |
Appendix
Filters Operators
| Operator | Description |
|---|---|
| eq / equals | Matches values that are equal to a specified value. |
| ne / not_equals | Matches all values that are not equal to a specified value. |
| in | Matches any of the values specified in an array. |
| nin / not_in | Matches none of the values specified in an array. |
| like | Selects results using a case sensitive regular expression where its values contain the value given. |
| likei | Selects results using a case insensitive regular expression where its values contain the value given. |
| llike | Selects results using a case sensitive regular expression where its values end with the value given. |
| llikei | Selects results using a case insensitive regular expression where its values end with the value given. |
| rlike | Selects results using a case sensitive regular expression where its values start with the value given. |
| rlikei | Selects results using a case insensitive regular expression where its values start with the value given. |
| gt / greater | Matches values that are greater than a specified value. |
| gte / greater_equal | Matches values that are greater than or equal to a specified value. |
| lt / lesser | Matches values that are less than a specified value. |
| lte / lesser_equal | Matches values that are less than or equal to a specified value. |
| null / is_null | Matches values that are null. |
| not_null / is_not_null | Matches values that are not null. |
| contains | Matches arrays that contain all elements specified in the filter. |