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.
Authentication
There are two ways to include authentication in our API requests:
- RIPE Session ID (recommended)
- RIPE Key
RIPE Session ID
RIPE Session ID will allow authenticated RIPE requests but to get a session id we need a Platforme token.
Obtaining a Platforme token
Getting a Platforme token can be done using the browser.
When using the browser, login into Platforme ID and click the tokens button and then "generate" at the top, a new page will load and display your generated Platforme token.
Redeeming a Platforme token (optional)
Optionally we can redeem the token with Platforme ID API to verify that the token is valid and obtain information about the token's account.
Example Request
curl "https://id.platforme.com/api/tokens/redeem?token=token"
Example Response
{
"account": {
"username": "dummy@platforme.com",
"meta": {
"justification": "We need a dummy account for documentation purposes",
"name": "Dummy",
"list": true,
"label": "Viewer (Sandbox)",
"ripe-core-prod": {
"brand_t": [
"dummy"
]
},
"requester": "joao@platforme.com"
},
"email": "dummy@platforme.com"
},
"acl": {
"tokens": [
"account.acl",
"account.me",
"account.show",
"ripe-core-sandbox.*",
"tech-website.ideas",
"tech-website.ideas.create",
"tech-website.pages.deployments",
"tech-website.pages.faq",
"tech-website.pages.glossary",
"tech-website.pages.home",
"tech-website.pages.library",
"tech-website.pages.presentations",
"tech-website.pages.products",
"tech-website.releases",
"tech-website.reps",
"tech-website.requests",
"tech-website.requests.create",
"tech-website.workshops",
"user"
],
"type": 3,
"acl": [
"account.acl",
"account.me",
"account.show",
"ripe-core-sandbox.*",
"tech-website.ideas",
"tech-website.ideas.create",
"tech-website.pages.deployments",
"tech-website.pages.faq",
"tech-website.pages.glossary",
"tech-website.pages.home",
"tech-website.pages.library",
"tech-website.pages.presentations",
"tech-website.pages.products",
"tech-website.releases",
"tech-website.reps",
"tech-website.requests",
"tech-website.requests.create",
"tech-website.workshops",
"user"
]
}
}
HTTP Request
GET https://id.platforme.com/api/tokens/redeem?token=<token>
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| token | yes | text | null |
The Platforme ID API token. |
Now that we have our Platforme ID Token, we will be using it to obtain a RIPE session id.
Obtaining a RIPE Session ID
In order to obtain our session id we simply need to make a request to RIPE API.
Example Request
curl "https://ripe-core-sbx.platforme.com/api/signin_pid?token=token"
Example Response
{
"sid": "9b1d2e7bdd4d17ba412a1b8193775d7d4e07b330b44d008f1192a51a948decaf",
"session_id": "9b1d2e7bdd4d17ba412a1b8193775d7d4e07b330b44d008f1192a51a948decaf",
"username": "dummy@platforme.com",
"name": "dummy@platforme.com",
"email": "dummy@platforme.com",
"tokens": []
}
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/signin_pid?token=<token>
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| token | yes | text | null |
The Platforme ID API token. |
After obtaining the RIPE session_id, it should be included as a parameter, provided as the value of "sid" parameter.
RIPE Key
The RIPE Key is only internally provided as an access key. It should not be used by everyone, thus, if you don't have one, please authenticate by RIPE Session ID.
The RIPE Key should be included in the request headers, provided as the value of X-Secret-Key.
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. |
| options | no | text | null |
The composition options, set this parameter for each tuplet (option:value). Supports quality, dpi, locale and country. |
Video
Example Request
curl "https://ripe-core-sbx.platforme.com/api/video?\
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
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/video
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| brand | no | text | null |
The brand's model. |
| model | no | text | null |
The model to compose. |
| version | no | numeric | null |
The version of the specified model . |
| p | no | text | null |
The configuration of the model, set this parameter for each triplet (part:material:color). |
| name | no | text | null |
The name of the video of the model. |
Video Thumbnail
Example Request
curl "https://ripe-core-sbx.platforme.com/api/video/thumbnail?\
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
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/video/thumbnail
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| brand | no | text | null |
The brand's model. |
| model | no | text | null |
The model to compose. |
| version | no | numeric | null |
The version of the specified model . |
| p | no | text | null |
The configuration of the model, set this parameter for each triplet (part:material:color). |
| name | no | text | null |
The name of the video of the model. |
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 |
|---|---|---|---|---|
| model | yes | text | The model to compose. | |
| brand | no | text | null |
The brand's model. |
| 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 | model size | The size of the image in pixels. This value applies to both its width and height. Defaults to the model size in its specification. |
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
Path Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| brand | yes | text | The brand's name 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. |
GET Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| model | no | text | null |
The model's name that the material belongs to. |
| version | no | number | latest | The model's build's version. |
| part | no | text | null |
The part the material belongs to. |
| retina | no | boolean | false |
If true, will render the swatch on retina resolution (2x the source resolution). |
| variant | no | text | null |
The model's variant. |
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": "184",
"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.184.3:5.0:1.0:3.0:3.4:6.0:6.4:0:1.5:0:0",
"query": "brand=swear&model=vyner&version=184&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. |
| version | no | numeric | latest | The version for the specified model. |
| 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 | dictionary | null |
An object representing personalization (initials and engraving) for each personalization group. |
| p | no | list of text | null |
The configuration of the model, described as a set of triplets in the form of part:material:color. |
| size | no | numeric | null |
The model's size. |
| gender | no | text | null |
The model's gender. |
| meta | no | text | null |
The model's metadata. |
| 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). |
| guess | no | boolean | null |
A flag normally used to guess the brand and version if those parameters are not provided. |
| params | no | boolean | null |
The extra meta information associated with the model. |
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": 26445,
"rule_count": 4,
"price_taxes": 195.0,
"vat": 32.5,
"vat_rate": 20.0,
"price": 162.5,
"currency": "EUR",
"hs_code": 6403999065,
"notes": [
"Nappa Leather"
],
"hs_code_priority": 1,
"price_original": 195.0,
"vat_included": true,
"ddp_included": false,
"fixed_price": false,
"round_price": false,
"base_country": "EU",
"base_currency": "EUR",
"exchanged": "EU-EUR",
"cites": false
},
"hardware": {
"rule_id": 26452,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": "EU-EUR",
"cites": false
}
},
"total": {
"price_final": 165.77,
"price_taxes": 162.5,
"vat": 0.0,
"ddp": 3.27,
"ddp_percent": 2.0128,
"vat_rate": 0.0,
"price": 162.5,
"currency": "EUR",
"country": "US",
"hs_codes": [
6403999065
],
"hs_code_priority": 1,
"shipping": 0.0,
"notes": [
"Nappa Leather"
],
"diag": {
"no_round": {
"price_final": 165.77,
"price_taxes": 162.5,
"price": 162.5,
"vat": 0.0,
"ddp": 3.27
},
"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": "EU",
"base_currency": "EUR",
"exchanged": "EU-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. |
| version | no | numeric | latest | The version for the specified model. |
| cites | no | boolean | null |
The flag that specifies if the price should have the CITES (Convention on International Trade in Endangered Species) |
| 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. |
| letters | no | text | null |
The initials value used to personalize the model. Similar to the initials parameter. |
| 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. |
| embossing | 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. Similar to the engraving parameter. |
| p | no | list of text | null |
The configuration of the model, described as a set of triplets in the form of part:material:color. |
Prices
Example Request
curl "https://ripe-core-sbx.platforme.com/api/config/prices?\
brand=swear&\
model=vyner&\
p0=side:nappa:white&\
p1=hardware:metal:silver&\
initials0=AA&\
engraving0=metal_gold:font"
Example Response
[
{
"components": {
"side": {
"rule_id": 26445,
"rule_count": 4,
"price_taxes": 195.0,
"vat": 32.5,
"vat_rate": 20.0,
"price": 162.5,
"currency": "EUR",
"hs_code": 6403999065,
"notes": [
"Nappa Leather"
],
"hs_code_priority": 1,
"price_original": 195.0,
"vat_included": true,
"ddp_included": false,
"fixed_price": false,
"round_price": false,
"base_country": "EU",
"base_currency": "EUR",
"exchanged": "EU-EUR",
"cites": false
},
"engraving": {
"rule_id": 26459,
"rule_count": 2,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.0,
"price": 0.0,
"currency": "EUR",
"price_original": 0.0,
"vat_included": true,
"ddp_included": false,
"fixed_price": false,
"round_price": false,
"base_country": "EU",
"base_currency": "EUR",
"exchanged": "EU-EUR"
}
},
"total": {
"price_final": 165.77,
"price_taxes": 162.5,
"vat": 0.0,
"ddp": 3.27,
"ddp_percent": 2.0128,
"vat_rate": 0.0,
"price": 162.5,
"currency": "EUR",
"country": "US",
"hs_codes": [
6403999065,
null
],
"hs_code_priority": -1,
"shipping": 0.0,
"notes": [
"Nappa Leather"
],
"diag": {
"no_round": {
"price_final": 165.77,
"price_taxes": 162.5,
"price": 162.5,
"vat": 0.0,
"ddp": 3.27
},
"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": "EU",
"base_currency": "EUR",
"exchanged": "EU-EUR"
},
"cites": false
}
},
{
"components": {
"hardware": {
"rule_id": 26452,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": "EU-EUR",
"cites": false
}
},
"total": {
"price_final": 0.0,
"price_taxes": 0.0,
"vat": 0.0,
"ddp": 0.0,
"ddp_percent": 0.0,
"vat_rate": 0.0,
"price": 0.0,
"currency": "EUR",
"country": "US",
"hs_codes": [
6403999065
],
"hs_code_priority": 1,
"shipping": 0.0,
"notes": [],
"diag": {
"no_round": {
"price_final": 0.0,
"price_taxes": 0.0,
"price": 0.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": false,
"fixed_price": false,
"round_price": false,
"base_country": "EU",
"base_currency": "EUR",
"exchanged": "EU-EUR"
},
"cites": false
}
}
]
The price information for each part 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. The total product price is returned for each part of the model, instead of the total price of the product, as in the endpoint Price.
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/config/prices
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. |
| version | no | numeric | latest | The version for the specified model. |
| cites | no | boolean | null |
The flag that specifies if the price should have the CITES (Convention on International Trade in Endangered Species) |
| 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. There can be several initials parameters, each parameter must have an index, for example initials0, which will match with the respective engraving and p with the same index. |
| letters |
no | text | null |
The initials value used to personalize the model. Similar to the initials parameter. |
| 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. There can be several engraving parameters, each parameter must have an index, for example engraving0, which will match with the respective initials and p with the same index. |
| embossing |
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. Similar to the engraving parameter. |
| p |
no | list of text | null |
The configuration of the model, described as a set of triplets in the form of part:material:color. There can be several p parameters, each parameter must have an index, for example p0, which will match with the respective initials and engraving with the same index. |
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": 26545,
"rule_count": 5,
"price_taxes": 360.0,
"vat": 60.0,
"vat_rate": 20.0,
"price": 300.0,
"currency": "EUR",
"hs_code": 6403999065,
"notes": [
"Nappa Leather"
],
"hs_code_priority": 1,
"price_original": 300.0,
"vat_included": false,
"ddp_included": false,
"fixed_price": false,
"round_price": false,
"base_country": "EU",
"base_currency": "EUR",
"exchanged": "EU-EUR",
"cites": false
},
"side": {
"delivery": 12,
"quantity": 1,
"rule_id": 26445,
"rule_count": 4,
"price_taxes": 195.0,
"vat": 32.5,
"vat_rate": 20.0,
"price": 162.5,
"currency": "EUR",
"hs_code": 6403999065,
"notes": [
"Nappa Leather"
],
"hs_code_priority": 1,
"price_original": 195.0,
"vat_included": true,
"ddp_included": false,
"fixed_price": false,
"round_price": false,
"base_country": "EU",
"base_currency": "EUR",
"exchanged": "EU-EUR",
"cites": false
},
"hardware": {
"delivery": 12,
"quantity": 1,
"rule_id": 26452,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": "EU-EUR",
"cites": false
},
"laces": {
"delivery": 12,
"quantity": 1,
"rule_id": 26456,
"rule_count": 2,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": "EU-EUR",
"cites": false
},
"lining": {
"delivery": 12,
"quantity": 1,
"rule_id": 26453,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": "EU-EUR",
"cites": false
},
"sole": {
"delivery": 12,
"quantity": 1,
"rule_id": 26455,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": "EU-EUR",
"cites": false
},
"shadow": {
"delivery": 12,
"quantity": 1,
"rule_id": 26458,
"rule_count": 2,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": "EU-EUR",
"cites": false
}
},
"total": {
"delivery": 12,
"quantity": 1,
"price_final": 534.32,
"price_taxes": 495.0,
"vat": 0.0,
"ddp": 39.32,
"ddp_percent": 7.9426272,
"vat_rate": 0.0,
"price": 495.0,
"currency": "EUR",
"country": "US",
"hs_codes": [
6403999065
],
"hs_code_priority": 1,
"shipping": 0.0,
"notes": [
"Nappa Leather",
"Rubber"
],
"diag": {
"no_round": {
"price_final": 534.32,
"price_taxes": 495.0,
"price": 495.0,
"vat": 0.0,
"ddp": 39.32
},
"patch": true,
"round_value": true,
"is_vat": false,
"is_ddp": true,
"is_european": false,
"is_rounded": false,
"vat_included": false,
"ddp_included": false,
"fixed_price": false,
"round_price": false,
"base_country": "EU",
"base_currency": "EUR",
"exchanged": "EU-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. |
| version | no | numeric | latest | The version for 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. |
| letters | no | text | null |
The initials value used to personalize the model. Similar to the initials parameter. |
| 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. |
| embossing | 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. Similar to the engraving parameter. |
| 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 | list of 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": null,
"variant": null,
"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,
"size": null,
"gender": null,
"sku": "teste2"
}
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/config/sku
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. |
| 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 initials and properties of the personalization, with the format group_name1:initials_1:property_type1.group_name2:initials_2:property_type2. |
| product_id | no | numeric | null |
The product's unique identification (ID). |
| size | no | numeric | null |
The product's size. |
| gender | no | text | null |
The model's gender. |
| domain | no | text | brand | The SKU domain (falls back to brand value). |
| p | no | list of text | null |
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": null,
"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>
Path Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| product_id | yes | numeric | The product's unique identification (ID). |
Defaults
Example Request
curl "https://ripe-core-sbx.platforme.com/api/config/defaults/vyner"
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"
},
"patch": {
"hidden": true,
"optional": true
},
"eyelets": {
"material": "metal",
"color": "silver",
"face": "side",
"frame": 0
},
"metal_toe_cap": {
"optional": true,
"face": "top"
},
"shadow": {
"hidden": true,
"material": "default",
"color": "default"
}
}
}
Get the default parts for the model give.
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/config/defaults/<text:model>
Path Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| model | yes | text | The model's name. |
Resources
Info
| Field | Type | Description |
|---|---|---|
| brand | text | Product's brand. |
| name | text | Product's name. |
| variant | text | Product's variant. |
| 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
List
The list endpoint returns the existing SKUs according to the given parameters. If no parameters are given, a maximum of 10 SKUs will be returned.
Query support can be consulted here.
Example Request
curl "https://ripe-core-sbx.platforme.com/api/skus?filters[]=domain:eq:dummy" \
-H "X-Secret-Key: $RIPE_KEY"
Example Response
[
{
"_id": "5e84bcfc85d32604ca51a363",
"id": 153976,
"identifier": "6d1a5bab-acc3-4f8c-a7c8-03cdb7ce152a",
"domain": "dummy",
"spec": {
"brand": "dummy",
"model": "dummy",
"parts": {
"piping": {
"material": "leather_dmy",
"color": "black"
},
"side": {
"material": "leather_dmy",
"color": "black"
},
"top0_bottom": {
"material": "leather_dmy",
"color": "black"
},
"shadow": {
"material": "default",
"color": "default"
}
}
},
"enabled": false,
"description": null,
"meta": {},
"brand_t": null,
"retailer_t": null,
"vendor_t": null,
"hash": "5cd82b0b122e1678cf8994fda9b03659",
"created": 1585757436,
"modified": 1630670807
},
{
"_id": "5dfcad058727f6df6545228f",
"id": 114894,
"identifier": "fd458150-2804-4a02-9840-26c9c1ba65b7",
"domain": "dummy",
"spec": {
"brand": "dummy",
"model": "dummy",
"parts": {
"piping": {
"material": "leather_dmy",
"color": "black"
},
"side": {
"material": "leather_dmy",
"color": "black"
},
"top0_bottom": {
"material": "leather_dmy",
"color": "black"
},
"shadow": {
"material": "default",
"color": "default"
}
}
},
"enabled": false,
"description": null,
"meta": {},
"brand_t": null,
"retailer_t": null,
"vendor_t": null,
"hash": "5cd82b0b122e1678cf8994fda9b03659",
"created": 1576840453,
"modified": 1630670807
},
{
"_id": "5dfba8783d01d2a1e545215f",
"id": 114837,
"identifier": "7529c424-2276-46dd-90a5-fb74efbe7554",
"domain": "dummy",
"spec": {
"brand": "dummy",
"model": "dummy",
"parts": {
"piping": {
"material": "leather_dmy",
"color": "black"
},
"side": {
"material": "leather_dmy",
"color": "black"
},
"top0_bottom": {
"material": "leather_dmy",
"color": "black"
},
"shadow": {
"material": "default",
"color": "default"
}
}
},
"enabled": false,
"description": null,
"meta": {},
"brand_t": null,
"retailer_t": null,
"vendor_t": null,
"hash": "5cd82b0b122e1678cf8994fda9b03659",
"created": 1576773752,
"modified": 1630670807
},
{
"_id": "5dfba88547a0976b21452398",
"id": 114838,
"identifier": "c030f298-69fa-4db2-abce-a51619e6240d",
"domain": "dummy",
"spec": {
"brand": "dummy",
"model": "dummy",
"parts": {
"piping": {
"material": "leather_dmy",
"color": "black"
},
"side": {
"material": "leather_dmy",
"color": "black"
},
"top0_bottom": {
"material": "leather_dmy",
"color": "black"
},
"shadow": {
"material": "default",
"color": "default"
}
}
},
"enabled": false,
"description": null,
"meta": {},
"brand_t": null,
"retailer_t": null,
"vendor_t": null,
"hash": "5cd82b0b122e1678cf8994fda9b03659",
"created": 1576773765,
"modified": 1630670807
},
{
"_id": "5dfca84a4e8056fcc1452446",
"id": 114888,
"identifier": "c968aaff-8505-437f-b290-2413e08ac528",
"domain": "dummy",
"spec": {
"brand": "dummy",
"model": "dummy",
"parts": {
"piping": {
"material": "leather_dmy",
"color": "black"
},
"side": {
"material": "leather_dmy",
"color": "black"
},
"top0_bottom": {
"material": "leather_dmy",
"color": "black"
},
"shadow": {
"material": "default",
"color": "default"
}
}
},
"enabled": false,
"description": null,
"meta": {},
"brand_t": null,
"retailer_t": null,
"vendor_t": null,
"hash": "5cd82b0b122e1678cf8994fda9b03659",
"created": 1576839242,
"modified": 1630670807
},
{
"_id": "5e84bcdb821e60837751a65c",
"id": 153973,
"identifier": "87d2e034-7a32-44cf-b8f6-0d6403c82d06",
"domain": "dummy",
"spec": {
"brand": "dummy",
"model": "dummy",
"parts": {
"piping": {
"material": "leather_dmy",
"color": "black"
},
"side": {
"material": "leather_dmy",
"color": "black"
},
"top0_bottom": {
"material": "leather_dmy",
"color": "black"
},
"shadow": {
"material": "default",
"color": "default"
}
}
},
"enabled": false,
"description": null,
"meta": {},
"brand_t": null,
"retailer_t": null,
"vendor_t": null,
"hash": "5cd82b0b122e1678cf8994fda9b03659",
"created": 1585757403,
"modified": 1630670807
},
{
"_id": "5dfbabc88727f6df654521fd",
"id": 114842,
"identifier": "e1c51305-439d-4395-b531-5e87c83d42ba",
"domain": "dummy",
"spec": {
"brand": "dummy",
"model": "dummy",
"parts": {
"piping": {
"material": "leather_dmy",
"color": "black"
},
"side": {
"material": "leather_dmy",
"color": "black"
},
"top0_bottom": {
"material": "leather_dmy",
"color": "black"
},
"shadow": {
"material": "default",
"color": "default"
}
}
},
"enabled": false,
"description": null,
"meta": {},
"brand_t": null,
"retailer_t": null,
"vendor_t": null,
"hash": "5cd82b0b122e1678cf8994fda9b03659",
"created": 1576774600,
"modified": 1630670807
},
{
"_id": "5e84be0385d32604ca51a374",
"id": 153983,
"identifier": "98f4450d-2b5c-4d53-821a-02b9b1ff28f2",
"domain": "dummy",
"spec": {
"brand": "dummy",
"model": "dummy",
"parts": {
"piping": {
"material": "leather_dmy",
"color": "black"
},
"side": {
"material": "leather_dmy",
"color": "black"
},
"top0_bottom": {
"material": "leather_dmy",
"color": "black"
},
"shadow": {
"material": "default",
"color": "default"
}
}
},
"enabled": false,
"description": null,
"meta": {},
"brand_t": null,
"retailer_t": null,
"vendor_t": null,
"hash": "5cd82b0b122e1678cf8994fda9b03659",
"created": 1585757699,
"modified": 1630670807
},
{
"_id": "5e84be12821e60837751a674",
"id": 153984,
"identifier": "4879d988-b114-4a5f-995a-3a223b1af08b",
"domain": "dummy",
"spec": {
"brand": "dummy",
"model": "dummy",
"parts": {
"piping": {
"material": "leather_dmy",
"color": "black"
},
"side": {
"material": "leather_dmy",
"color": "black"
},
"top0_bottom": {
"material": "leather_dmy",
"color": "black"
},
"shadow": {
"material": "default",
"color": "default"
}
}
},
"enabled": false,
"description": null,
"meta": {},
"brand_t": null,
"retailer_t": null,
"vendor_t": null,
"hash": "5cd82b0b122e1678cf8994fda9b03659",
"created": 1585757714,
"modified": 1630670807
},
{
"_id": "5dfba8693d01d2a1e545215d",
"id": 114834,
"identifier": "625ae7d7-94f9-46d7-83d7-7d625b34cd67",
"domain": "dummy",
"spec": {
"brand": "dummy",
"model": "dummy",
"parts": {
"piping": {
"material": "leather_dmy",
"color": "black"
},
"side": {
"material": "leather_dmy",
"color": "black"
},
"top0_bottom": {
"material": "leather_dmy",
"color": "black"
},
"shadow": {
"material": "default",
"color": "default"
}
}
},
"enabled": false,
"description": null,
"meta": {},
"brand_t": null,
"retailer_t": null,
"vendor_t": null,
"hash": "5cd82b0b122e1678cf8994fda9b03659",
"created": 1576773737,
"modified": 1630670807
}
]
HTTP Request
GET 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. |
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 SKUs 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. |
| sid | no | text | The RIPE Session ID to authenticate the request. |
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 |
|---|---|---|---|---|
| identifier | no | text | null |
The SKU string that identifies an unique specification inside a certain domain. |
| hash | no | text | null |
The hash value that is used to reverse resolve the SKU value. |
| domain | no | text | null |
The string value used to separate resolution of SKUs so that no collisions occur between identifiers from different domains. |
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": "de1f0ab6-de04-432a-bddf-31e92be9ac82",
"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": "63370a06c0407a28ea32a7cd",
"id": 231339,
"domain": "swear",
"identifier": "de1f0ab6-de04-432a-bddf-31e92be9ac82",
"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": 1664551430,
"modified": 1664551430
}
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. |
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| sid | no | text | The RIPE Session ID 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. See Specification. |
Show
Returns the SKU with the given ID. If the SKU does not exist, returns a Not Found Exception (404) error.
Example Request
curl "https://ripe-core-sbx.platforme.com/api/skus/1" \
-H "X-Secret-Key: $RIPE_KEY"
Example Response
{
"_id": "63370a06c0407a28ea32a7d0",
"id": 231340,
"domain": "dummy",
"identifier": "de1f0ab6-de04-432a-bddf-31e92be9ac82",
"spec": {
"brand": "dummy",
"model": "cube",
"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": "fd066f9810ad2817df83d0989ac817b6",
"created": 1664551430,
"modified": 1664551430
}
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/skus/<number:id>
Header Fields
| Field | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| X-Secret-Key | yes | text | The X-Secret-Key to authenticate the request. |
PATH Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| id | yes | numeric | The SKU's ID. | |
| sid | no | text | The RIPE Session ID to authenticate the request. |
Update
Updates the SKU with the given ID. If the SKU does not exist, returns a Not Found Exception (404) error.
Example Request
curl -s -X PUT \
"https://ripe-core-sbx.platforme.com/api/skus/1" \
-H "Content-Type: application/json" \
-H "X-Secret-Key: $RIPE_KEY" \
-d '{
"domain": "dummy",
"identifier": "de1f0ab6-de04-432a-bddf-31e92be9ac82_2",
"spec": {
"brand": "dummy",
"model": "cube",
"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": "63370a07523cea17e632c11e",
"id": 231341,
"domain": "dummy",
"identifier": "de1f0ab6-de04-432a-bddf-31e92be9ac82_2",
"spec": {
"brand": "dummy",
"model": "dummy",
"parts": {}
},
"enabled": true,
"description": null,
"meta": {},
"brand_t": null,
"retailer_t": null,
"vendor_t": null,
"hash": "e7590f921a2e22dfc049a8b0201d181b",
"created": 1664551431,
"modified": 1664551431
}
HTTP Request
PUT https://ripe-core-sbx.platforme.com/api/skus/<number:id>
Header Fields
| Field | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| X-Secret-Key | yes | text | The X-Secret-Key to authenticate the request. |
PATH Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| id | yes | numeric | The SKU's ID. | |
| sid | no | text | The RIPE Session ID 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.) |
Delete
Deletes the SKU with the given ID. If the SKU does not exist, returns a Not Found Exception (404) error.
Example Request
curl -s -X DELETE "https://ripe-core-sbx.platforme.com/api/skus/1" \
-H "X-Secret-Key: $RIPE_KEY"
Example Response
{
"result": "success"
}
HTTP Request
DELETE https://ripe-core-sbx.platforme.com/api/skus/<number:id>
Header Fields
| Field | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| X-Secret-Key | yes | text | The X-Secret-Key to authenticate the request. |
PATH Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| id | yes | numeric | The SKU's ID. | |
| sid | no | text | The RIPE Session ID to authenticate the request. |
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. |
Brand Endpoints
A brand normally identifies the vendor of a given model. One brand may have many models associated with it. Platforme API allows access to the information of the already existing brands, such as their logo and models. The models information originates from their respective builds.
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.<text:format>
Path Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| brand | yes | text | The respective brand's name. | |
| format | yes | text | The format of the image, (e.g. png, jpg, svg, etc.) |
GET Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| version | no | number | latest | Brand's version. |
| size | no | text | medium | Logo's size, one of small, medium or large. |
| variant | no | text | medium | Logo's variant, can be a size or something else (e.g. small, large, blue, etc.) |
Mesh
Example Request
curl "https://ripe-core-sbx.platforme.com/api/brands/swear/models/vyner/mesh"
Example Response
The above command returns a mesh file
This endpoint returns the model's mesh.
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/brands/<text:brand>/models/<text:model>/mesh
PATH Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| brand | yes | text | The brand's name. | |
| model | yes | text | The models's name. |
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| version | no | number | latest | Build's version. |
| variant | no | text | medium | Logo's variant, one of small, medium or large. |
Config and Spec
Example Request
curl "https://ripe-core-sbx.platforme.com/api/brands/swear/models/vyner/config"
curl "https://ripe-core-sbx.platforme.com/api/brands/swear/models/vyner/spec"
Example Response
{
"name": "vyner",
"brand": "swear",
"version": "184",
"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",
"size": [
1000,
1000
],
"tags": [
"generic",
"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": {
"profile": "base",
"z_index": 4,
"properties": [
{
"name": "metal_copper",
"type": "font"
},
{
"name": "metal_gold",
"type": "font"
},
{
"name": "metal_silver",
"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_copper": {
"font_family": "SwearCopper"
},
"style::metal_gold": {
"font_family": "SwearGold"
},
"style::metal_silver": {
"font_family": "SwearSilver"
},
"viewport::large": {
"viewport": [
324,
283,
250,
250
]
},
"viewport::medium": {
"viewport": [
349,
308,
200,
200
]
},
"viewport::small": {
"viewport": [
399,
358,
100,
100
]
},
"metal_copper": {
"font_family": "SwearCopper"
},
"metal_gold": {
"font_family": "SwearGold"
},
"metal_silver": {
"font_family": "SwearSilver"
},
"large": {
"viewport": [
324,
283,
250,
250
]
},
"medium": {
"viewport": [
349,
308,
200,
200
]
},
"small": {
"viewport": [
399,
358,
100,
100
]
}
},
"$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": "184",
"version_i": 184,
"branch": "master",
"compatibility": 1,
"order": {
"models": [
"air_revive",
"air_rev_nitro",
"air_rev_trigger",
"bond",
"crosby_v2",
"maddox",
"marshall",
"nori",
"redchurch",
"vyner",
"vyner_hitop",
"hoodie"
],
"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"
]
}
Both endpoints return 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
GET https://ripe-core-sbx.platforme.com/api/brands/<text:brand>/models/<text:model>/spec
PATH Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| brand | yes | text | The brand's name. | |
| model | yes | text | The model's name. |
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| version | no | number | latest | The build's version. |
| country | no | text | null |
The ISO 3166-2 code of the country. |
| flag | no | text | null |
The flag value. |
| safe | no | text | true |
If the safe (sanitized) version of the model configuration should be retrieved (shows no confidential information). |
| logic | no | text | true |
If the custom build logic should be run to manipulate the resulting model config according to specific domain rules. |
| filter | no | text | true |
If the configuration should be filtered by the country and/or flag. |
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
PATH Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| brand | yes | text | The brand's name. | |
| model | yes | text | The model's name. |
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| version | no | number | latest | The build's version. |
Combinations
Example Request
curl "https://ripe-core-sbx.platforme.com/api/brands/swear/models/vyner/combinations"
Example Response
{
"brand": "swear",
"model": "vyner",
"combinations": [
[
"vyner",
"front",
"crocodile",
"black"
],
[
"vyner",
"front",
"crocodile",
"chestnut"
],
[
"vyner",
"front",
"crocodile",
"navy"
],
[
"vyner",
"front",
"crocodile",
"nude"
],
[
"vyner",
"front",
"crocodile",
"red"
],
[
"vyner",
"front",
"crocodile",
"silver"
],
[
"vyner",
"front",
"crocodile",
"white"
],
[
"vyner",
"front",
"grain_metallic",
"emerald"
],
[
"vyner",
"front",
"grain_metallic",
"gold"
],
[
"vyner",
"front",
"grain_metallic",
"purple"
],
[
"vyner",
"front",
"grain_metallic",
"silver"
],
[
"vyner",
"front",
"hairy_calf",
"black"
],
[
"vyner",
"front",
"hairy_calf",
"camouflage"
],
[
"vyner",
"front",
"hairy_calf",
"leopard"
],
[
"vyner",
"front",
"hairy_calf",
"navy"
],
[
"vyner",
"front",
"hairy_calf",
"red"
],
[
"vyner",
"front",
"hairy_calf",
"white"
],
[
"vyner",
"front",
"nappa",
"beige"
],
[
"vyner",
"front",
"nappa",
"black"
],
[
"vyner",
"front",
"nappa",
"blush"
],
[
"vyner",
"front",
"nappa",
"dark_cherry"
],
[
"vyner",
"front",
"nappa",
"forest_green"
],
[
"vyner",
"front",
"nappa",
"grey"
],
[
"vyner",
"front",
"nappa",
"navy"
],
[
"vyner",
"front",
"nappa",
"red"
],
[
"vyner",
"front",
"nappa",
"taupe"
],
[
"vyner",
"front",
"nappa",
"white"
],
[
"vyner",
"front",
"python",
"black"
],
[
"vyner",
"front",
"python",
"gold"
],
[
"vyner",
"front",
"python",
"grey"
],
[
"vyner",
"front",
"python",
"natural"
],
[
"vyner",
"front",
"python",
"neon_white"
],
[
"vyner",
"front",
"python",
"nude"
],
[
"vyner",
"front",
"python",
"silver"
],
[
"vyner",
"front",
"python",
"white"
],
[
"vyner",
"front",
"suede",
"beige"
],
[
"vyner",
"front",
"suede",
"black"
],
[
"vyner",
"front",
"suede",
"forest_green"
],
[
"vyner",
"front",
"suede",
"grey"
],
[
"vyner",
"front",
"suede",
"navy"
],
[
"vyner",
"front",
"suede",
"red"
],
[
"vyner",
"front",
"suede",
"taupe"
],
[
"vyner",
"front",
"suede",
"white"
],
[
"vyner",
"hardware",
"metal",
"gold"
],
[
"vyner",
"hardware",
"metal",
"silver"
],
[
"vyner",
"laces",
"nylon",
"black"
],
[
"vyner",
"laces",
"nylon",
"blush"
],
[
"vyner",
"laces",
"nylon",
"burnt_orange"
],
[
"vyner",
"laces",
"nylon",
"cobalt"
],
[
"vyner",
"laces",
"nylon",
"copper_brown"
],
[
"vyner",
"laces",
"nylon",
"dark_cherry"
],
[
"vyner",
"laces",
"nylon",
"forest_green"
],
[
"vyner",
"laces",
"nylon",
"fuchsia"
],
[
"vyner",
"laces",
"nylon",
"golden_yellow"
],
[
"vyner",
"laces",
"nylon",
"grey"
],
[
"vyner",
"laces",
"nylon",
"navy"
],
[
"vyner",
"laces",
"nylon",
"red"
],
[
"vyner",
"laces",
"nylon",
"taupe"
],
[
"vyner",
"laces",
"nylon",
"white"
],
[
"vyner",
"lining",
"calf_lining",
"beige"
],
[
"vyner",
"lining",
"calf_lining",
"black"
],
[
"vyner",
"lining",
"calf_lining",
"tan"
],
[
"vyner",
"lining",
"calf_lining",
"white"
],
[
"vyner",
"logo",
"metal",
"copper"
],
[
"vyner",
"logo",
"metal",
"gold"
],
[
"vyner",
"logo",
"metal",
"silver"
],
[
"vyner",
"side",
"crocodile",
"black"
],
[
"vyner",
"side",
"crocodile",
"chestnut"
],
[
"vyner",
"side",
"crocodile",
"navy"
],
[
"vyner",
"side",
"crocodile",
"nude"
],
[
"vyner",
"side",
"crocodile",
"red"
],
[
"vyner",
"side",
"crocodile",
"silver"
],
[
"vyner",
"side",
"crocodile",
"white"
],
[
"vyner",
"side",
"grain_metallic",
"emerald"
],
[
"vyner",
"side",
"grain_metallic",
"gold"
],
[
"vyner",
"side",
"grain_metallic",
"purple"
],
[
"vyner",
"side",
"grain_metallic",
"silver"
],
[
"vyner",
"side",
"hairy_calf",
"black"
],
[
"vyner",
"side",
"hairy_calf",
"camouflage"
],
[
"vyner",
"side",
"hairy_calf",
"leopard"
],
[
"vyner",
"side",
"hairy_calf",
"navy"
],
[
"vyner",
"side",
"hairy_calf",
"red"
],
[
"vyner",
"side",
"hairy_calf",
"white"
],
[
"vyner",
"side",
"metallic",
"copper"
],
[
"vyner",
"side",
"metallic",
"fuchsia"
],
[
"vyner",
"side",
"metallic",
"gold"
],
[
"vyner",
"side",
"metallic",
"navy"
],
[
"vyner",
"side",
"metallic",
"silver"
],
[
"vyner",
"side",
"nappa",
"beige"
],
[
"vyner",
"side",
"nappa",
"black"
],
[
"vyner",
"side",
"nappa",
"blush"
],
[
"vyner",
"side",
"nappa",
"dark_cherry"
],
[
"vyner",
"side",
"nappa",
"forest_green"
],
[
"vyner",
"side",
"nappa",
"grey"
],
[
"vyner",
"side",
"nappa",
"navy"
],
[
"vyner",
"side",
"nappa",
"red"
],
[
"vyner",
"side",
"nappa",
"taupe"
],
[
"vyner",
"side",
"nappa",
"white"
],
[
"vyner",
"side",
"python",
"black"
],
[
"vyner",
"side",
"python",
"gold"
],
[
"vyner",
"side",
"python",
"grey"
],
[
"vyner",
"side",
"python",
"natural"
],
[
"vyner",
"side",
"python",
"neon_white"
],
[
"vyner",
"side",
"python",
"nude"
],
[
"vyner",
"side",
"python",
"silver"
],
[
"vyner",
"side",
"python",
"white"
],
[
"vyner",
"side",
"suede",
"beige"
],
[
"vyner",
"side",
"suede",
"black"
],
[
"vyner",
"side",
"suede",
"forest_green"
],
[
"vyner",
"side",
"suede",
"grey"
],
[
"vyner",
"side",
"suede",
"navy"
],
[
"vyner",
"side",
"suede",
"red"
],
[
"vyner",
"side",
"suede",
"taupe"
],
[
"vyner",
"side",
"suede",
"white"
],
[
"vyner",
"sole",
"rubber",
"black"
],
[
"vyner",
"sole",
"rubber",
"grey"
],
[
"vyner",
"sole",
"rubber",
"pink"
],
[
"vyner",
"sole",
"rubber",
"red"
],
[
"vyner",
"sole",
"rubber",
"tan"
],
[
"vyner",
"sole",
"rubber",
"white"
],
[
"vyner",
"sole",
"rubber",
"yellow"
]
]
}
This endpoint returns all the possible combinations of material and color for each part of a specific brand and model. The combinations returned can take into account the availability rules for the specific model.
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/brands/<text:brand>/models/<text:model>/combinations
PATH Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| brand | yes | text | The brand's name. | |
| model | yes | text | The model's name. |
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| version | no | number | latest | The build's version. |
| resolve | no | boolean | true |
Resolves the alias mapping. |
| sort | no | boolean | true |
Sorts the combinations. |
| use_name | no | boolean | true |
Adds the model's name to each combination tuple. |
| filter | no | boolean | true |
If the combinations should be filtered by the country and/or flag. |
| country | no | text | null |
The availability rules country. |
| flag | no | text | null |
The availability rules flag. |
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": 7
}
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
PATH Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| brand | yes | text | The brand's name. | |
| model | yes | text | The model's name. |
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 and returns a JSON with a key valid set as true. If a required part is missing or if the part:material:color combination has invalid values, the request will return a JSON with the key valid as false and an array of issues specifying what is wrong.
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/brands/<text:brand>/models/<text:model>/validate
PATH Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| brand | yes | text | The brand's name. | |
| model | yes | text | The model's name. |
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| version | no | number | latest | The build's version. |
| variant | no | text | null |
The model's variant. |
| p | no | text | null |
The configuration of the model, described as a sequence of triplets in the form of part:material:color. |
| initials | no | text | null |
The personalization initials text. |
| engraving | no | text | null |
The personalization engraving properties. |
| initials_extra | no | dictionary | null |
The personalization initials object, containing the initials text and engraving for each group. |
| gender | no | text | null |
The gender of the customization, used to resolve the scale. |
| size | no | number | null |
The size of the customization. |
Logic
Example Request
curl "https://ripe-core-sbx.platforme.com/api/brands/dummy/models/cube/logic"
Example Response
<Logic module for (dummy, cube) version unknown>This endpoint returns the logic script of a specific brand and model. If a method name and its arguments are provided as parameters, the result of the method calling will be returned.
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/brands/<text:brand>/models/<text:model>/logic
PATH Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| brand | yes | text | The brand's name. | |
| model | yes | text | The model's name. |
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| version | no | number | latest | The build's version. |
| format | no | text | py |
The script extension, either py or js. |
| method | no | text | null |
The name of the method present in the logic script. |
Logic Method
Example Request
curl -s -X POST "https://ripe-core-sbx.platforme.com/api/brands/swear/models/vyner/logic/groups"
Example Response
[
"main"
]
This endpoint returns the result of executing the method provided from the logic script. The arguments for the method can be passed through parameters or through the request body.
HTTP Request
POST https://ripe-core-sbx.platforme.com/api/brands/<text:brand>/models/<text:model>/logic
PATH Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| brand | yes | text | The brand's name. | |
| model | yes | text | The model's name. |
POST Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| version | no | number | latest | The build's version. |
On Config
Example Request
curl -s -X POST \
"https://ripe-core-sbx.platforme.com/api/brands/dummy/models/cube/on_config" \
-d '{
"ctx": {
"parts": {}
},
"brand":"dummy",
"model":"cube"
}'
Example Response
{
"parts": {},
"messages": [],
"initials": {
"main": {
"initials": "",
"engraving": null
}
}
}
This endpoint returns the result of executing the method on_config from the logic script. The arguments for the method are passed through the request body.
HTTP Request
POST https://ripe-core-sbx.platforme.com/api/brands/<text:brand>/models/<text:model>/on_config
PATH Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| brand | yes | text | The brand's name. | |
| model | yes | text | The model's name. |
POST Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| version | no | number | latest | The build's version. |
POST Body
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| ctx | no | dictionary | null |
The context of the request. |
| brand | no | text | null |
The brand value used as the method argument. |
| model | no | text | null |
The model value used as the method argument. |
On Part
Example Request
curl -s -X POST \
"https://ripe-core-sbx.platforme.com/api/brands/dummy/models/cube/on_part" \
-d '{
"ctx": {
"parts": {
"top0_bottom": {
"material": "leather_cbe",
"color": "black"
},
"side": {
"material": "leather_cbe",
"color": "black"
}
}
},
"name":"side",
"value": {
"material": "leather_cbe",
"color": "black"
}
}'
Example Response
{
"parts": {
"top0_bottom": {
"material": "leather_cbe",
"color": "black"
},
"side": {
"material": "leather_cbe",
"color": "black"
}
},
"initials": {
"main": {
"initials": "",
"engraving": null
}
},
"messages": [
[
"config",
"top0_bottom - material forced to `leather_cbe`"
]
],
"choices": {}
}
This endpoint returns the result of executing the method on_part from the logic script. The arguments for the method are passed through the request body.
HTTP Request
POST https://ripe-core-sbx.platforme.com/api/brands/<text:brand>/models/<text:model>/on_part
PATH Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| brand | yes | text | The brand's name. | |
| model | yes | text | The model's name. |
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| version | no | number | latest | The build's version. |
POST Body
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| ctx | no | dictionary | null |
The context of the request. |
| name | no | text | null |
The part's name. |
| value | no | dictionary | null |
The part's value (material and color). |
On Initials
Example Request
curl -s -X POST \
"https://ripe-core-sbx.platforme.com/api/brands/dummy/models/cube/on_initials" \
-d '{
"ctx": {
"initials": {
"main": {
"initials": "DOG",
"engraving": "grey:style"
}
}
},
"group":"main",
"initials": "DOG",
"engraving": "grey:style"
}'
Example Response
{
"initials": {
"main": {
"initials": "",
"engraving": null
}
},
"messages": [
[
"initials",
"Blacklisted word detected"
]
],
"choices": {}
}
This endpoint returns the result of executing the method on_initials from the logic script. The arguments for the method are passed through the request body.
HTTP Request
POST https://ripe-core-sbx.platforme.com/api/brands/<text:brand>/models/<text:model>/on_initials
PATH Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| brand | yes | text | The brand's name. | |
| model | yes | text | The model's name. |
Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| version | no | number | latest | The build's version. |
POST Body
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| ctx | no | dictionary | null |
The context of the request. |
| group | no | text | null |
The initials' group. |
| initials | no | text | null |
The initials' text. |
| engraving | no | text | null |
The initials' engraving. |
Resources
Config
| Field | Type | Description |
|---|---|---|
| brand | text | Build's brand. |
| name | text | Model's name. |
| description | text | Model description text. |
| title | text | Model 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 behaviors for the model. |
| 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 model. |
| 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 models 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
| Field | Type | Description |
|---|---|---|
| model | text | Build's name. |
| parts | dictionary | Default material and color for every part. |
Product Endpoints
Create
Example Request
curl -s -X POST \
"https://ripe-core-sbx.platforme.com/api/products" \
-H "Content-Type: application/json" \
-H "X-Secret-Key: $RIPE_KEY" \
-d '{
"brand":"swear",
"name":"vyner",
"gender":"Male",
"price_eur": 10.0,
"price_usd": 11.0,
"price_gbp": 12.0
}'
Example Response
{
"_id": "63370a0f523cea17e632c124",
"id": 272002,
"brand": "swear",
"name": "vyner",
"gender": "Male",
"price_eur": 10.0,
"price_usd": 11.0,
"price_gbp": 12.0,
"enabled": true,
"description": null,
"meta": {},
"brand_t": null,
"retailer_t": null,
"vendor_t": null,
"variant": null,
"observations": null,
"default_scale": null,
"ff_id": null,
"created": 1664551439,
"modified": 1664551439
}
This endpoint returns the created Product.
HTTP Request
POST https://ripe-core-sbx.platforme.com/api/products
POST Body
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| brand | yes | text | The brand associated with the product. | |
| name | yes | text | The product's identifier. | |
| variant | no | text | null |
The variant (or sub-variant) of the product that serves to specialize the type of the product. |
| observations | no | text | null |
Description of the product. |
| gender | yes | text | The gender of the product (one of Male, Female, Kids and Unknown). |
|
| price_eur | no | float | null |
The product's price, in euros EUR. |
| price_usd | no | float | null |
The product's price, in dollars USD. |
| price_gbp | no | float | null |
The product's price, in british pound GBP. |
| default_scale | no | text | null |
The default scale to be used when processing the product's size. |
| ff_id | no | number | null |
Identifier of the product. |
Config
Example Request
curl "https://ripe-core-sbx.platforme.com/api/products/swear/vyner/config"
Example Response
{
"name": "vyner",
"brand": "swear",
"version": "184",
"path": "/data/builds/swear/models/vyner",
"parts": [
{
"name": "front",
"materials": [
{
"name": "nappa",
"colors": [
"white",
"black",
"navy",
"red",
"terracotta",
"beige",
"forest_green",
"dark_cherry",
"blush",
"grey",
"taupe"
]
},
{
"name": "suede",
"colors": [
"white",
"black",
"navy",
"red",
"terracotta",
"beige",
"forest_green",
"grey",
"taupe"
]
},
{
"name": "veg_tan",
"colors": [
"raw"
]
},
{
"name": "hairy_calf",
"colors": [
"white",
"black",
"navy",
"red",
"terracotta",
"leopard",
"camouflage",
"beige"
]
},
{
"name": "ostrich",
"colors": [
"white",
"black",
"tan",
"grey"
]
},
{
"name": "python",
"colors": [
"white",
"black",
"natural",
"silver",
"gold",
"neon_white",
"blush",
"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",
"terracotta",
"beige",
"forest_green",
"dark_cherry",
"blush",
"grey",
"taupe"
]
},
{
"name": "suede",
"colors": [
"white",
"black",
"navy",
"red",
"terracotta",
"beige",
"forest_green",
"grey",
"taupe"
]
},
{
"name": "metallic",
"colors": [
"silver",
"gold",
"copper",
"navy",
"fuchsia"
]
},
{
"name": "veg_tan",
"colors": [
"raw"
]
},
{
"name": "hairy_calf",
"colors": [
"white",
"black",
"navy",
"red",
"terracotta",
"leopard",
"camouflage",
"beige"
]
},
{
"name": "ostrich",
"colors": [
"white",
"black",
"tan",
"grey"
]
},
{
"name": "python",
"colors": [
"white",
"black",
"natural",
"silver",
"gold",
"neon_white",
"blush",
"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",
"rose",
"chocolate",
"terracotta",
"taupe",
"copper_brown",
"beige",
"forest_green",
"golden_yellow",
"neon_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",
"copper"
]
}
]
},
{
"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",
"size": [
1000,
1000
],
"tags": [
"generic",
"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": null,
"sync": null,
"defaults": null,
"initials": {
"profile": "base",
"z_index": 4,
"properties": [
{
"name": "metal_copper",
"type": "font"
},
{
"name": "metal_gold",
"type": "font"
},
{
"name": "metal_silver",
"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_copper": {
"font_family": "SwearCopper"
},
"style::metal_gold": {
"font_family": "SwearGold"
},
"style::metal_silver": {
"font_family": "SwearSilver"
},
"viewport::large": {
"viewport": [
324,
283,
250,
250
]
},
"viewport::medium": {
"viewport": [
349,
308,
200,
200
]
},
"viewport::small": {
"viewport": [
399,
358,
100,
100
]
},
"metal_copper": {
"font_family": "SwearCopper"
},
"metal_gold": {
"font_family": "SwearGold"
},
"metal_silver": {
"font_family": "SwearSilver"
},
"large": {
"viewport": [
324,
283,
250,
250
]
},
"medium": {
"viewport": [
349,
308,
200,
200
]
},
"small": {
"viewport": [
399,
358,
100,
100
]
}
},
"$alias": {
"report": [
"viewport::medium"
],
"step::personalization": [
"viewport::large"
],
"step::size": [
"viewport::medium"
]
}
},
"initials_frame": null,
"z_index": {
"shadow": 1,
"lining": 2,
"front": 3,
"side": 5,
"sole": 6,
"laces": 7,
"logo": 8,
"hardware": 9,
"overlay": 30000
},
"$info": {
"branch": "master",
"build": 184,
"build_fqn": "184",
"build_s": "184",
"config": {
"blend_shadow": {
"maltby": {
"fringe_shadow": "fringe"
}
},
"no_alpha_composite": [
"blue0_orange",
"clear_white",
"transparent0_white",
"white"
],
"opacity_shadow": {
"default": {
"alpha_divisor": 1,
"blur_radius": 1
},
"fringe_shadow": {
"alpha_divisor": 2,
"blur_radius": 3.5
}
},
"priorities": {
"accents": 3,
"collar": 8,
"elastic": 6,
"eyestay0_side": 9,
"fringe": 10000,
"fringe_hardware": 10001,
"front": 3,
"hardware": 7,
"heel0_trimmings": 5,
"heel_tab": 10,
"lace0_eyelet": 11,
"laces": 6,
"metal_caps": 10000,
"metal_toe_cap": 10000,
"mudguard": 7,
"outsole": 10002,
"overlay": 30000,
"rubber_strap": 10000,
"shadow": 1,
"side": 4,
"side0_tongue_detail": 4,
"sole": 12,
"strap_tip": 10000,
"strap_tips": 10000,
"tag_left": 13,
"tag_right": 13,
"toe0_tongue": 6,
"toe_cap": 20000,
"trimmings": 4,
"upper": 2,
"upper1": 2,
"upper2": 3,
"zip": 3
},
"repositions": {
"air_rev_nitro": "auto",
"air_rev_trigger": "auto",
"air_rev_xtra": "auto",
"air_revive": "auto",
"bond": 164,
"carnaby": 78,
"crosby": "auto",
"crosby_p": "auto",
"crosby_v2": "auto",
"element_black": "auto",
"element_blue_grey": "auto",
"element_blue_reflective": "auto",
"element_green": "auto",
"element_grey_reflective": "auto",
"element_neon_pink": "auto",
"element_red": "auto",
"element_yellow_pink": "auto",
"gypsy_denim": "auto",
"gypsy_multi": "auto",
"maltby": 78,
"redchurch": 78,
"regent": 140
},
"shadows": [
"fringe_shadow",
"patch",
"shadow"
],
"skip_colorize": [
"fringe_shadow",
"masks",
"overlay"
],
"skip_repositions": [
"overlay",
"top"
],
"skip_verify_defaults": [
"initials",
"masks",
"overlay",
"static",
"swatches"
],
"specific_colorize": {
"air_rev_nitro": {
"collar": "nappa",
"eyestay0_side": "nappa",
"heel0_trimmings": "nappa",
"heel_tab": "nappa",
"mudguard": "nappa",
"side0_tongue_detail": "nappa",
"toe0_tongue": "nappa"
},
"bond": {
"front": "nappa",
"heel": "nappa",
"side": "nappa",
"straps": "nappa"
},
"conduit": {
"front": "nappa",
"side": "nappa"
},
"dean2": {
"collar": "nappa",
"front": "nappa",
"side": "nappa"
},
"dean54": {
"front": "nappa",
"piping": "nappa",
"side": "nappa",
"toe_cap": "nappa"
},
"hoxton": {
"back_stay": "nappa",
"front": "nappa",
"side": "nappa"
},
"kingsland": {
"collar": "nappa",
"front": "nappa",
"side": "nappa"
},
"maddox": {
"front": "nappa",
"side": "nappa"
},
"maltby": {
"fringe": "nappa",
"front": "nappa",
"side": "nappa"
},
"marshall": {
"eye_stay": "nappa",
"front": "nappa",
"front_panel": "nappa",
"inside": "nappa",
"inside_panel": "nappa",
"outside": "nappa",
"tongue": "nappa"
},
"redchurch": {
"front": "nappa"
},
"regent": {
"ankle_side": "nappa",
"front": "nappa",
"heel": "nappa",
"side": "nappa",
"stay": "nappa"
},
"vyner": {
"front": "nappa",
"side": "nappa"
}
},
"static_dirs": [
"overlay"
],
"vendor": "swear"
},
"description": "Adding model hoodie",
"details": {
"aliyun_bucket": "",
"alpha_composite": true,
"collect": true,
"colorize": true,
"compress": true,
"description": "Adding model hoodie",
"dropbox_folder": "/deploy",
"models": [
"air_rev_nitro",
"air_rev_trigger",
"air_rev_xtra",
"air_revive",
"bond",
"carnaby",
"carnaby_will",
"conduit",
"crosby",
"crosby_p",
"crosby_v2",
"dean",
"dean2",
"dean54",
"element_black",
"element_blue_grey",
"element_blue_reflective",
"element_green",
"element_grey_reflective",
"element_neon_pink",
"element_red",
"element_yellow_pink",
"gypsy_denim",
"gypsy_multi",
"hoodie",
"hoxton",
"kingsland",
"maddox",
"maddox10cc",
"maddox_glitter",
"maltby",
"marshall",
"nori",
"redchurch",
"regent",
"ridge_runner",
"uglyww",
"vyner",
"vyner_glitter",
"vyner_hitop",
"vyner_hitop_glitter"
],
"publish": true,
"reposition": true,
"resave": true,
"source_commit": "10316d930a9650dbf924eaf6c72ab34be8132d7a",
"source_url": "http://gogs.platforme.com/platforme/builds.git",
"start_time": 1637756874.736972,
"strict": true,
"uid": "c3f0a06746a2c910065d9109caa8e3daf60ce117",
"upload": true,
"upload_branch": "master",
"upload_branch_n": "master",
"user": "da",
"user_email": "da@platforme.com",
"user_full": "da <da@platforme.com>"
},
"duration": 1724.7034788131714,
"extension": "zip",
"file_id": "id:P-yUG8Qxd2AAAAAAAAAUqQ",
"file_name": "swear.184.zip",
"file_size": 6455908506,
"file_url": "https://www.dropbox.com/s/eumrfr3a11xzy67/swear.184.zip?dl=0",
"files": [
"./initials",
"./master.json",
"./models",
"./static",
"./swatches",
"./info.json"
],
"installed": 1642062865,
"packager": 2,
"sources": [
"dropbox"
],
"tags": [
"dropbox",
"global",
"us",
"usa"
],
"timestamp": 1637758599,
"user": "da <da@platforme.com>",
"vendor": "swear"
},
"$mtime": 1642062817.203719,
"version_s": "184",
"version_i": 184,
"branch": "master",
"compatibility": 1,
"order": null,
"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": null,
"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"
],
"variant": null
}
This endpoint returns the configuration of a product with the given brand, model and variant.
HTTP Request
GET https://ripe-core-sbx.platforme.com/api/products/<text:brand>/<text:model>/config
PATH Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| brand | yes | text | Brand's name. | |
| model | yes | text | Model's name. |
GET Parameters
| Parameter | Mandatory | Type | Default | Description |
|---|---|---|---|---|
| variant | no | number | null |
The product's variant. |
Resources
Config
| Field | Type | Description |
|---|---|---|
| brand | text | Build's brand. |
| name | text | Build'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). |
Order Endpoints
An order includes general information about a product's transaction entry and processing. Platforme API allows 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.
List
The list endpoint returns the existing orders according to the given parameters. If no parameters are given, it will 10 orders 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/orders?filters[]=shoe:eq:vyner" \
-H "X-Secret-Key: $RIPE_KEY"
Example Response
[
{
"_id": "5c7fe48e4ce4e700625c7213",
"id": 4692,
"number": 4692,
"enabled": true,
"description": null,
"created": 1551885454,
"modified": 1654078565,
"meta": {
"sku": "654a29e7-8cf9-4446-98f4-f7dff2f4dc54",
"notified": 1551885454
},
"key": "51ee733a131bc68d2112aca82626879ceda76de9",
"status": "created",
"production_status": "unset",
"production": "produce",
"gender": "female",
"currency": "USD",
"country": "US",
"price": 400.0,
"prices": {
"components": {
"lining": {
"rule_id": 14931,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"sole": {
"rule_id": 14933,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"hardware": {
"rule_id": 14930,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"laces": {
"rule_id": 15123,
"rule_count": 2,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"front": {
"rule_id": 14912,
"rule_count": 4,
"price_taxes": 135.0,
"vat": 22.5,
"vat_rate": 20.0,
"price": 112.5,
"currency": "USD",
"hs_code": 6403999065,
"notes": [
"Nappa Leather"
],
"hs_code_priority": 1,
"price_original": 135.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"logo": {
"rule_id": 15123,
"rule_count": 2,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"shadow": {
"rule_id": 15123,
"rule_count": 2,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"side": {
"rule_id": 14923,
"rule_count": 4,
"price_taxes": 265.0,
"vat": 44.17,
"vat_rate": 20.0,
"price": 220.83,
"currency": "USD",
"hs_code": 6403999065,
"notes": [
"Nappa Leather"
],
"hs_code_priority": 1,
"price_original": 265.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"engraving": {
"rule_id": 15123,
"rule_count": 2,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.0,
"price": 0.0,
"currency": "USD",
"price_original": 0.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "EU",
"base_currency": "EUR",
"exchanged": null
}
},
"total": {
"price_final": 400.0,
"price_taxes": 400.0,
"vat": 0.0,
"ddp": 0.0,
"ddp_percent": 0.0,
"vat_rate": 0.0,
"price": 400.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": 400.0,
"price_taxes": 400.0,
"price": 400.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": "EU",
"base_currency": "EUR",
"exchanged": null
},
"cites": false
}
},
"brand": "swear",
"shoe": "vyner",
"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\": 24, \"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\"}",
"ff_id": null,
"ff_shoe_id": 12212972,
"ff_order_id": "c7276d0f-b4d2-4300-b05c-4ad6f8e1eed3",
"delivery_time": 10,
"tracking_number": null,
"tracking_url": null,
"states": [],
"attachments": [],
"account": "docs@platforme.com",
"customer": null,
"ambassador": null,
"store": null,
"brand_t": "swear",
"retailer_t": null,
"status_index": 1,
"vendor_t": "FLAJ",
"factory": "FLAJ",
"notes": [],
"report_url_e": null,
"type": "build",
"variant": null,
"chat": null,
"invoicing_info": {},
"last_update_touches": [],
"last_updated": null,
"pickup_number": null,
"priority": null,
"proof_of_delivery_url": null,
"return_tracking_number": null,
"return_tracking_url": null,
"scale_s": null,
"shipping_info": {},
"states_names": [],
"tag": null,
"transport": {},
"transport_ready": false,
"quantity": null,
"number_s": "#004692",
"channel": "digital",
"delivery_d": 1552749454.0,
"scale": "it",
"size_scaled": 37.5,
"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": 24,
"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"
}
},
{
"_id": "5d124f7cc846b3fae05674ae",
"id": 5060,
"number": 5060,
"enabled": true,
"description": null,
"created": 1561481083,
"modified": 1654078565,
"meta": {
"sku": "824de319-5ef7-463b-84b9-cc534712d396",
"notified": 1561481084
},
"brand_t": "swear",
"retailer_t": null,
"vendor_t": "FLAJ",
"key": "7529cb325759db0564c16bba2daa32035b71fee6",
"status": "created",
"status_index": 1,
"production_status": "unset",
"production": "produce",
"gender": "female",
"currency": "USD",
"country": "US",
"price": 400.0,
"prices": {
"components": {
"lining": {
"rule_id": 14931,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"sole": {
"rule_id": 14933,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"hardware": {
"rule_id": 14930,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"laces": {
"rule_id": 15123,
"rule_count": 2,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"front": {
"rule_id": 14912,
"rule_count": 4,
"price_taxes": 135.0,
"vat": 22.5,
"vat_rate": 20.0,
"price": 112.5,
"currency": "USD",
"hs_code": 6403999065,
"notes": [
"Nappa Leather"
],
"hs_code_priority": 1,
"price_original": 135.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"logo": {
"rule_id": 15123,
"rule_count": 2,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"shadow": {
"rule_id": 15123,
"rule_count": 2,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"side": {
"rule_id": 14923,
"rule_count": 4,
"price_taxes": 265.0,
"vat": 44.17,
"vat_rate": 20.0,
"price": 220.83,
"currency": "USD",
"hs_code": 6403999065,
"notes": [
"Nappa Leather"
],
"hs_code_priority": 1,
"price_original": 265.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"engraving": {
"rule_id": 15123,
"rule_count": 2,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.0,
"price": 0.0,
"currency": "USD",
"price_original": 0.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "EU",
"base_currency": "EUR",
"exchanged": null
}
},
"total": {
"price_final": 400.0,
"price_taxes": 400.0,
"vat": 0.0,
"ddp": 0.0,
"ddp_percent": 0.0,
"vat_rate": 0.0,
"price": 400.0,
"currency": "USD",
"country": "US",
"hs_codes": [
6403999065,
null
],
"hs_code_priority": -1,
"shipping": 0.0,
"notes": [
"Rubber",
"Nappa Leather"
],
"diag": {
"no_round": {
"price_final": 400.0,
"price_taxes": 400.0,
"price": 400.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": "EU",
"base_currency": "EUR",
"exchanged": null
},
"cites": false
}
},
"brand": "swear",
"shoe": "vyner",
"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": "71ddafd6-a788-4cf8-93b2-420c2d6bd2e3",
"delivery_time": 10,
"tracking_number": null,
"tracking_url": null,
"states": [
2186
],
"attachments": [],
"account": "docs@platforme.com",
"customer": null,
"ambassador": null,
"store": null,
"factory": "FLAJ",
"notes": [],
"report_url_e": null,
"type": "build",
"variant": null,
"chat": null,
"invoicing_info": {},
"last_update_touches": [],
"last_updated": null,
"pickup_number": null,
"priority": null,
"proof_of_delivery_url": null,
"return_tracking_number": null,
"return_tracking_url": null,
"scale_s": null,
"shipping_info": {},
"states_names": [],
"tag": null,
"transport": {},
"transport_ready": false,
"quantity": null,
"number_s": "#005060",
"channel": "digital",
"delivery_d": 1562345083.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"
}
}
}
},
{
"_id": "5cf798cc8dfda5dfe7567378",
"id": 5014,
"number": 5014,
"enabled": true,
"description": null,
"created": 1559730380,
"modified": 1654078565,
"meta": {
"sku": "42c01b55-c9e4-4c9a-aea8-0fbe42c010f6",
"notified": 1559730380
},
"brand_t": "swear",
"retailer_t": null,
"vendor_t": "FLAJ",
"key": "9b749204d321780bf8f4659fc8c1d25850411a38",
"status": "created",
"status_index": 1,
"production_status": "unset",
"production": "produce",
"gender": "female",
"currency": "USD",
"country": "US",
"price": 400.0,
"prices": {
"components": {
"lining": {
"rule_id": 14931,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"sole": {
"rule_id": 14933,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"hardware": {
"rule_id": 14930,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"laces": {
"rule_id": 15123,
"rule_count": 2,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"front": {
"rule_id": 14912,
"rule_count": 4,
"price_taxes": 135.0,
"vat": 22.5,
"vat_rate": 20.0,
"price": 112.5,
"currency": "USD",
"hs_code": 6403999065,
"notes": [
"Nappa Leather"
],
"hs_code_priority": 1,
"price_original": 135.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"logo": {
"rule_id": 15123,
"rule_count": 2,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"shadow": {
"rule_id": 15123,
"rule_count": 2,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"side": {
"rule_id": 14923,
"rule_count": 4,
"price_taxes": 265.0,
"vat": 44.17,
"vat_rate": 20.0,
"price": 220.83,
"currency": "USD",
"hs_code": 6403999065,
"notes": [
"Nappa Leather"
],
"hs_code_priority": 1,
"price_original": 265.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"engraving": {
"rule_id": 15123,
"rule_count": 2,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.0,
"price": 0.0,
"currency": "USD",
"price_original": 0.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "EU",
"base_currency": "EUR",
"exchanged": null
}
},
"total": {
"price_final": 400.0,
"price_taxes": 400.0,
"vat": 0.0,
"ddp": 0.0,
"ddp_percent": 0.0,
"vat_rate": 0.0,
"price": 400.0,
"currency": "USD",
"country": "US",
"hs_codes": [
6403999065,
null
],
"hs_code_priority": -1,
"shipping": 0.0,
"notes": [
"Rubber",
"Nappa Leather"
],
"diag": {
"no_round": {
"price_final": 400.0,
"price_taxes": 400.0,
"price": 400.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": "EU",
"base_currency": "EUR",
"exchanged": null
},
"cites": false
}
},
"brand": "swear",
"shoe": "vyner",
"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": "a8d2da57-a2fc-4da0-be01-184907ba4084",
"delivery_time": 10,
"tracking_number": null,
"tracking_url": null,
"states": [
2142
],
"attachments": [],
"account": "docs@platforme.com",
"customer": null,
"ambassador": null,
"store": null,
"factory": "FLAJ",
"notes": [],
"report_url_e": null,
"type": "build",
"variant": null,
"chat": null,
"invoicing_info": {},
"last_update_touches": [],
"last_updated": null,
"pickup_number": null,
"priority": null,
"proof_of_delivery_url": null,
"return_tracking_number": null,
"return_tracking_url": null,
"scale_s": null,
"shipping_info": {},
"states_names": [],
"tag": null,
"transport": {},
"transport_ready": false,
"quantity": null,
"number_s": "#005014",
"channel": "digital",
"delivery_d": 1560594380.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"
}
}
}
},
{
"_id": "5e270081c4b8546c39d37083",
"id": 9238,
"number": 9238,
"enabled": true,
"description": null,
"created": 1579614337,
"modified": 1654078565,
"meta": {
"sku": "9aafb745-b5b9-4319-8772-057e52c8d46a"
},
"brand_t": "swear",
"retailer_t": null,
"vendor_t": "FLAJ",
"key": "64ab967932131ec89b06a8d8775741b78a370dac",
"status": "created",
"status_index": 1,
"production_status": "unset",
"production": "produce",
"gender": "female",
"currency": "USD",
"country": "US",
"price": 260.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": 18669,
"rule_count": 3,
"price_taxes": 20.0,
"vat": 3.74,
"vat_rate": 23.0,
"price": 16.26,
"currency": "USD",
"hs_code": 6403999065,
"notes": [],
"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
},
"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": 18672,
"rule_count": 3,
"price_taxes": 20.0,
"vat": 3.74,
"vat_rate": 23.0,
"price": 16.26,
"currency": "USD",
"hs_code": 6403999065,
"notes": [],
"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
},
"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": 18670,
"rule_count": 3,
"price_taxes": 15.01,
"vat": 2.81,
"vat_rate": 23.0,
"price": 12.2,
"currency": "USD",
"hs_code": 6403999065,
"notes": [
"Rubber"
],
"hs_code_priority": 1,
"price_original": 15.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": 18671,
"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": 260.0,
"price_taxes": 260.0,
"vat": 0.0,
"ddp": 0.0,
"ddp_percent": 0.0,
"vat_rate": 0.0,
"price": 260.0,
"currency": "USD",
"country": "US",
"hs_codes": [
6403999065
],
"hs_code_priority": 1,
"shipping": 0.0,
"notes": [
"Rubber",
"Nappa Leather"
],
"diag": {
"no_round": {
"price_final": 260.0,
"price_taxes": 260.0,
"price": 260.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": "936ee106-f154-4a86-9da1-0e99b5fb8abf",
"delivery_time": 10,
"tracking_number": null,
"tracking_url": null,
"notes": [],
"states": [
5282
],
"attachments": [],
"account": "docs@platforme.com",
"customer": null,
"ambassador": null,
"store": null,
"factory": "FLAJ",
"report_url_e": null,
"type": "build",
"chat": null,
"invoicing_info": {},
"last_update_touches": [],
"last_updated": null,
"pickup_number": null,
"priority": null,
"proof_of_delivery_url": null,
"return_tracking_number": null,
"return_tracking_url": null,
"scale_s": null,
"shipping_info": {},
"states_names": [],
"tag": null,
"transport": {},
"transport_ready": false,
"quantity": null,
"number_s": "#009238",
"channel": "digital",
"delivery_d": 1580478337.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
}
},
{
"_id": "5cb5ade04ce4e7006b14a194",
"id": 4861,
"number": 4861,
"enabled": true,
"description": null,
"created": 1555410399,
"modified": 1654078565,
"meta": {
"sku": "d890de5c-fbe8-46e5-bbc9-62e15ae7a59d",
"notified": 1555410400
},
"key": "525ff4756cd6e0d965e034717f50b202d69727fd",
"status": "created",
"production_status": "unset",
"production": "produce",
"gender": "female",
"currency": "USD",
"country": "US",
"price": 400.0,
"prices": {
"components": {
"lining": {
"rule_id": 14931,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"sole": {
"rule_id": 14933,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"hardware": {
"rule_id": 14930,
"rule_count": 3,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"laces": {
"rule_id": 15123,
"rule_count": 2,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"front": {
"rule_id": 14912,
"rule_count": 4,
"price_taxes": 135.0,
"vat": 22.5,
"vat_rate": 20.0,
"price": 112.5,
"currency": "USD",
"hs_code": 6403999065,
"notes": [
"Nappa Leather"
],
"hs_code_priority": 1,
"price_original": 135.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"logo": {
"rule_id": 15123,
"rule_count": 2,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"shadow": {
"rule_id": 15123,
"rule_count": 2,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.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": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"side": {
"rule_id": 14923,
"rule_count": 4,
"price_taxes": 265.0,
"vat": 44.17,
"vat_rate": 20.0,
"price": 220.83,
"currency": "USD",
"hs_code": 6403999065,
"notes": [
"Nappa Leather"
],
"hs_code_priority": 1,
"price_original": 265.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "EU",
"base_currency": "EUR",
"exchanged": null,
"cites": false
},
"engraving": {
"rule_id": 15123,
"rule_count": 2,
"price_taxes": 0.0,
"vat": 0.0,
"vat_rate": 20.0,
"price": 0.0,
"currency": "USD",
"price_original": 0.0,
"vat_included": true,
"ddp_included": true,
"fixed_price": true,
"round_price": false,
"base_country": "EU",
"base_currency": "EUR",
"exchanged": null
}
},
"total": {
"price_final": 400.0,
"price_taxes": 400.0,
"vat": 0.0,
"ddp": 0.0,
"ddp_percent": 0.0,
"vat_rate": 0.0,
"price": 400.0,
"currency": "USD",
"country": "US",
"hs_codes": [
6403999065,
null
],
"hs_code_priority": -1,
"shipping": 0.0,
"notes": [
"Rubber",
"Nappa Leather"
],
"diag": {<