WJ Partners API
Base URI
https://api.wonderjewel.co
Welcome to the WJ Partners API documentation.
Now we provide 1.0 version of service. This param is important part of endpoints urls.
The WJ Partners API allows you to manage personalized inventory in a simple, programmatic way using conventional HTTP requests. The endpoints are intuitive and powerful, allowing you to easily make calls to retrieve information or to execute actions using Rest.
The API documentation will start with a general overview about the technology that has been implemented, followed by reference information about specific endpoints.
Any tool that is fluent in REST can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. Also all response data and request body data is in JSON format and encrypted by Base64 (if request - data object).
The interface responds to different methods depending on the action required.
REQUEST FOR AUTHENTICATE
JSON:
{
"data": {
"api_key": "api key",
"secret_key": "secret key"
}
}
ENCODED:
{
"data": ewogICAgICAiYXBpX2tleSI6ICJhcGkga2V5IiwKICAgICAgInNlY3JldF9rZXkiOiAic2VjcmV0IGtleSIKfQ==
}
| Method | Usage |
|---|---|
| GET | For simple retrieval of information about your content, you should use the GET method. Any request using the GET method is read-only and will not affect any of the objects you are querying. |
| POST | To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint. |
| PUT | To update a object, your request should specify the PUT method. The PUT request can includes attributes available to update in object. When you wish to update an existing object, send a PUT request to the target endpoint. |
Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses.
In general, in the event of a problem, the status will contain the error code and message. While the specific internal problem was encountered, the status code is in the 200 range, but response will contain special error data.
In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered or specific internal error was encountered.
Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed.
If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having an issue on our end and cannot fulfill your request currently.
EXAMPLE ERROR RESPONSE
HTTP/1.1 401 Unauthorized
EXAMPLE INTERNAL ERROR RESPONSE
HTTP/1.1 200
JSON:
{
"status": "error",
"error_code": 2,
"error_message": "Incorrect token",
"data": {}
}
FINAL(JSON in BASE64):
ewogICJzdGF0dXMiOiAiZXJyb3IiLAogICJlcnJvcl9jb2RlIjogMiwKICAiZXJyb3JfbWVzc2FnZSI6ICJJbmNvcnJlY3QgdG9rZW4iLAogICJkYXRhIjoge30KfQ==
INTERNAL ERRORS (code: message)
{
"0": "no errors",
"1": "Params error",
"2": "Incorrect token",
"3": "Incorrect authkey",
"4": "Incorrect data",
"5": "Can not logout",
"6": "Incorrect Role",
"7": "Failed to save data. Try later",
"8": "Incorrect Email format",
"9": "Incorrect Password format",
"10": "Phone is required",
"11": "Email is required",
"12": "First Name is required",
"13": "Last Name is required",
"14": "Country is required",
"15": "City is required",
"16": "Password is required",
"17": "Role required",
"20": "User is waiting to approve",
"21": "User is disable",
"22": "User not deleted",
"23": "User not found",
"24": "This email address has been registered",
"25": "User email is not verified",
"30": "Multipart form-data and POST required",
"31": "File format is not allowed",
"32": "File not recognized",
"33": "No such file or directory",
"34": "File not found",
"35": "Can't save file",
"40": "Server Side Exception",
"41": "Error Email Sending",
"50": "This user already have store company",
"51": "Sub domain already exist",
"70": "WorkBag not found",
"71": "Purchase Order not found",
"72": "Product not found",
"73": "Products configuration not found",
"74": "POS not found",
"75": "Order product not found",
"76": "Order not found",
"77": "Company not found",
"78": "Customer not found",
"80": "Error during save",
"81": "Error during getting results",
"82": "Cannot save order products",
"83": "Cannot save order",
"84": "Cannot save customer",
"90": "Validate error(s)",
"91": "Limit is too long",
"92": "Offset is too long",
"93": "Empty required params",
"100": "Vendor model is empty",
"101": "No data to update",
"102": "Empty configuration id value",
"103": "Cannot get id",
"104": "Cannot get customer"
}
When a request is successful, a response body will typically be sent back in the form of a JSON object, which encoded by Base64.
Inside of this JSON object, the resource root that was the target of the request will be set as the key inside data object.
The value can contain object, array, string, integer, float or empty value.
For example, if you send a GET request to /1.0/product/RPD117 or if you send the GET request to /1.0/product without identify param at the end, you will get back an collection of product objects.
RESPONSE FOR A SPECIFY OBJECT
{
"status": "success",
"error_code": 0,
"error_message": "",
"data": {
"products": [
{
"vendor_model": "RPD117",
"partner_id": "123123",
"title": "Diamond heart Pendant",
"description": "1-3 Stones heart style Pendant",
"jewelryType": "7",
"product_type": "1",
"plp_image": "https://j4z2x5e8.stackpathcdn.com/zbuilder/reeds/pendant/PD117/PD117-PLP.png",
"created_at": 1558717240,
"updated_at": 1558717240,
"status": 2,
"retail_start": 1899.99,
"gender": 1,
"options": {
"chain": {
"metal": [
{
"material_sku": "f",
"material_title": "14K GOLD",
"sort": 1,
"color": [
{
"sku": "R",
"title": "Rose"
}
]
}
]
},
"pendant": {
"stones_max": 7,
"stone": [
{
"sku": "jsp",
"title": "June",
"description": "Pearl",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 1
}
],
"metal": [
{
"material_sku": "f",
"material_title": "14K GOLD",
"sort": 1,
"color": [
{
"sku": "R",
"title": "Rose"
}
]
}
]
},
"shank": {
"stone": [
{
"sku": "jsp",
"title": "June",
"description": "Pearl",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 1
}
],
"metal": [
{
"material_sku": "f",
"material_title": "14K GOLD",
"sort": 1,
"color": [
{
"sku": "R",
"title": "Rose"
}
]
}
]
},
"engraving": {
"enabled": 1,
"min_chars": 1,
"max_chars": 12,
"fonts": [
{
"sku": "Satisfy",
"title": "Satisfy"
}
]
}
}
}
]
}
}
RESPONSE FOR AN ALL OBJECTS
{
"status": "success",
"error_code": 0,
"error_message": "",
"data": {
"products": [
{
"vendor_model": "RPD117",
"partner_id": "123123",
"title": "Diamond heart Pendant",
"description": "1-3 Stones heart style Pendant",
"jewelryType": "7",
"product_type": "1",
"plp_image": "https://j4z2x5e8.stackpathcdn.com/zbuilder/reeds/pendant/PD117/PD117-PLP.png",
"created_at": 1558717240,
"updated_at": 1558717240,
"status": 2,
"retail_start": 1899.99,
"gender": 1,
"options": {
"chain": {
"metal": [
{
"material_sku": "f",
"material_title": "14K GOLD",
"sort": 1,
"color": [
{
"sku": "R",
"title": "Rose"
}
]
}
]
},
"pendant": {
"stones_max": 7,
"stone": [
{
"sku": "jsp",
"title": "June",
"description": "Pearl",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 1
}
],
"metal": [
{
"material_sku": "f",
"material_title": "14K GOLD",
"sort": 1,
"color": [
{
"sku": "R",
"title": "Rose"
}
]
}
]
},
"shank": {
"stone": [
{
"sku": "jsp",
"title": "June",
"description": "Pearl",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 1
}
],
"metal": [
{
"material_sku": "f",
"material_title": "14K GOLD",
"sort": 1,
"color": [
{
"sku": "R",
"title": "Rose"
}
]
}
]
},
"engraving": {
"enabled": 1,
"min_chars": 1,
"max_chars": 12,
"fonts": [
{
"sku": "Satisfy",
"title": "Satisfy"
}
]
}
}
}
]
}
}
Info
In order to interact with the WJ Partners API, you or your application must authenticate.
All WJ Partners recieve own special credentials (Secret and Api keys):
api_key
secret_key
The WJ Partners API handles this through OAuth, an open standard for authorization. OAuth allows you to delegate access to your account in full or in read-only mode.
An OAuth token functions as a complete authentication request. In effect, it acts as a substitute for a username and password pair.
Because of this, it is absolutely essential that you keep your OAuth tokens secure.
How to Authenticate with OAuth
You can authenticate sending your Secret and Api key to /1.0/sign_in. You’ll recieve a token which you must send in authkey Header to generate other requests.
authkey
string
required
Authentication token, required in most requests.
Example:
prtLoYWuLOirlFN7XkiXlJseuBXYnX3U
Operations:
Create Single Order, Customer, Order Product
Get All Order Info
Get Bridal Ring Product
Get product by Partner ID
Get product By Vendor Model
Get Product Configuration Data
Get product list
Get Single Order by ID
Jewelry Types
Metal Lock
Product Types
Stone Lock
Stone Weight
Update Order Status
language
string
optional
Desired language for translate response content (when it is possible).
Default:
en-EN
Example:
en-EN
Operations:
Authenticate
Create Single Order, Customer, Order Product
Currency
Get All Order Info
Get Bridal Ring Product
Get product by Partner ID
Get product By Vendor Model
Get product list
Get Single Order by ID
Jewelry Types
Metal Lock
Product Status
Product Types
Stone Lock
Stone Weight
Update Order Status
POST
/1.0/user/login
POST
/1.0/user/login
Authentication
Open
Authenticate account
Request headers
Request body
Object
data
Object
api_key
string
Example:
Provided Api key
secret_key
string
Example:
Provided Secret key
Responses
200
OK
Body
Object
status
string
Example:
success
error_code
integer
error_message
string
data
Object
Example
POST https://api.wonderjewel.co/1.0/user/login HTTP/1.1
language: en-EN
{
"data": {
"api_key": "Provided Api key",
"secret_key": "Provided Secret key"
}
}
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "success",
"error_code": 1,
"error_message": "",
"data": {
"authkey": "authkey"
}
}
GET
/1.0/dir/productGender
GET
/1.0/dir/productStatus
GET
/1.0/dir/currency
GET
/1.0/dir/stoneWeight
GET
/1.0/dir/stoneLock
GET
/1.0/dir/metalLock
GET
/1.0/dir/productType
GET
/1.0/dir/jewelryType
GET
/1.0/dir/productGender
Get possible Product Genders
Responses
200
OK
Body
Object
status
string
Example:
success
error_code
integer
error_message
string
data
Object
list
Array
Object
id
number
Value of Gender
Example:
0
title
string
Title of Gender
Example:
Empty
Example 1
GET https://api.wonderjewel.co/1.0/dir/productGender HTTP/1.1
authkey: prtLoYWuLOirlFN7XkiXlJseuBXYnX3U
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "success",
"error_code": 0,
"error_message": "",
"data": {
"list": [
{
"id": 0,
"title": "Empty"
},
{
"id": 1,
"title": "Woman"
},
{
"id": 2,
"title": "Man"
},
{
"id": 3,
"title": "Another"
}
]
}
}
GET
/1.0/dir/productStatus
Get possible Product Statuses
Request headers
Responses
200
OK
Body
Object
status
string
Responce status [success/error]
Example:
success
error_code
integer
Error code (see error codes list)
error_message
string
Text error message
data
Object
list
Array
Object
id
number
Value of Status
Example:
0
title
string
Title of Status
Example:
New
Example 1
GET https://api.wonderjewel.co/1.0/dir/productStatus HTTP/1.1
authkey: prtLoYWuLOirlFN7XkiXlJseuBXYnX3U
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "success",
"error_code": 1,
"error_message": "",
"data": {
"list": [
{
"id": 0,
"title": "New"
},
{
"id": 1,
"title": "Created"
},
{
"id": 2,
"title": "Finalized"
},
{
"id": 9,
"title": "Disabled"
},
{
"id": 10,
"title": "Deleted"
}
]
}
}
GET
/1.0/dir/currency
Authentication
OAuth2
List of all possible currencies
Request headers
Responses
200
OK
Body
Object
status
string
Responce status [success/error]
Example:
success
error_code
integer
Error code (see error codes list)
error_message
string
Text error message
Example:
no errors
data
Object
base64 Encoded object
list
Array
List of supported currencies
Object
id
integer
Currency id
Example:
1
code
string
Internatiol code
Example:
USD
sign
string
Currency sign
Example:
$
number
integer
International currency number
Example:
840
exponent
integer
Number of characters after point
Example:
2
currency
string
Currency title
Example:
U.S. dollar
rate
integer
Currency rate
Example:
1
default
integer
Is default value
Example 1
GET https://api.wonderjewel.co/1.0/dir/currency HTTP/1.1
authkey: prtLoYWuLOirlFN7XkiXlJseuBXYnX3U
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "success",
"error_code": 1,
"error_message": "no errors",
"data": {
"list": {
{
"id": 1,
"code": "USD",
"sign": "$",
"number": 840,
"exponent": 2,
"currency": "U.S. dollar",
"rate": 1,
"default": 1
},
{
"id": 2,
"code": "EUR",
"sign": "€",
"number": 978,
"exponent": 2,
"currency": "European Currency Unit",
"rate": 1.14,
"default": 1
},
{
"id": 4,
"code": "CNY",
"sign": "元 / ¥",
"number": 156,
"exponent": 2,
"currency": "Renminbi",
"rate": 0.14,
"default": 1
}
}
}
}
GET
/1.0/dir/stoneWeight
Authentication
OAuth2
Iformation about stone weight
Request headers
Responses
200
OK
Body
Object
status
string
Responce status [success/error]
Example:
success
error_code
integer
Error code (see error codes list)
error_message
string
Text error message
Example:
no errors
data
Object
base64 Encoded object
list
Array
Stone weights list
Object
sku
string
Sku of stone weight type
Example:
e
title
number
Title of stone weight type
Example:
0.25
description
string
Description of stone weight type
status
integer
Status of stone weight type
Example:
1
Examples
{
"status": "success",
"error_code": 1,
"error_message": "no errors",
"data": {
"list": [
{
"sku": "e",
"title": 0.25,
"description": "",
"status": 1
}
]
}
}Example 1
{
"status": "success",
"error_code": 1,
"error_message": "no errors",
"data": {
"list": [
{
"sku": "e",
"title": 0.25,
"description": "",
"status": 1
}
]
}
}
GET
/1.0/dir/stoneLock
Authentication
OAuth2
Current Stone lock price
Request headers
Responses
200
OK
Body
Object
status
string
Responce status [success/error]
Example:
success
error_code
integer
Error code (see error codes list)
error_message
string
Text error message
Example:
no errors
data
Object
base64 Encoded object
list
Array
Stone locks list
Object
material_sku
string
Sku of stone type
Example:
dmnd
material_title
string
Title of stone type
Example:
Diamond
weight_from
number
Minimal stone weight
Example:
0.25
weight_to
number
Max. stone weight
Example:
0.25
weight_stone
string
Stone weight
Example:
e
stone_shape
string
Sku of stone shape
Example:
rd
quality
string
Sku of stone quality value
Example:
VS2
cost
integer
Cost of current lock item
Example:
350
Example 1
GET https://api.wonderjewel.co/1.0/dir/stoneLock HTTP/1.1
authkey: prtLoYWuLOirlFN7XkiXlJseuBXYnX3U
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "success",
"error_code": 0,
"error_message": "no errors",
"data": {
"list": [
{
"material_sku": "dmnd",
"material_title": "Diamond",
"weight_from": 0.25,
"weight_to": 0.25,
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"cost": 350
},
{
"material_sku": "dmnd",
"material_title": "Diamond",
"weight_from": 0.33000000000000002,
"weight_to": 0.33000000000000002,
"weight_stone": "f",
"stone_shape": "rd",
"quality": "VS2",
"cost": 575
},
{
"material_sku": "dmnd",
"material_title": "Diamond",
"weight_from": 0.375,
"weight_to": 0.375,
"weight_stone": "g",
"stone_shape": "rd",
"quality": "VS2",
"cost": 775
}
]
}
}
GET
/1.0/dir/metalLock
Authentication
OAuth2
Current metal lock price
Request headers
Responses
200
OK
Body
Object
status
string
Responce status [success/error]
Example:
success
error_code
integer
Error code (see error codes list)
error_message
string
Text error message
Example:
no errors
data
Object
base64 Encoded object
list
Array
List of metal locks
Object
id
integer
Lock item id
Example:
64
material_sku
string
Sku of metal lock type
Example:
c
material_title
string
Title of material lock type
Example:
9K GOLD
cost
number
Current lock item cost
Example:
18.52
Example 1
GET https://api.wonderjewel.co/1.0/dir/metalLock HTTP/1.1
authkey: prtLoYWuLOirlFN7XkiXlJseuBXYnX3U
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "success",
"error_code": 0,
"error_message": "no errors",
"data": {
"list": [
{
"id": 64,
"material_sku": "c",
"material_title": "9K GOLD",
"cost": 18.52
},
{
"id": 65,
"material_sku": "k",
"material_title": "10k GOLD",
"cost": 20.550000000000001
},
{
"id": 66,
"material_sku": "f",
"material_title": "14K GOLD",
"cost": 28.789999999999999
},
{
"id": 67,
"material_sku": "q",
"material_title": "18K GOLD",
"cost": 37.039999999999999
},
{
"id": 68,
"material_sku": "s",
"material_title": "STERLING SILVER",
"cost": 0.52000000000000002
},
{
"id": 69,
"material_sku": "r",
"material_title": "PLAT 90",
"cost": 27.73
},
{
"id": 70,
"material_sku": "p",
"material_title": "PLAT 95",
"cost": 29.27
}
]
}
}
GET
/1.0/dir/productType
Authentication
OAuth2
Product types list
Request headers
Responses
200
OK
Body
Object
status
string
Responce status [success/error]
Example:
success
error_code
integer
Error code (see error codes list)
error_message
string
Text error message
Example:
no errors
data
Object
base64 Encoded object
list
Array
Product types list
Object
id
integer
Product type id
title
string
Title of product type item
Example:
Simple
description
string
Description of type item
Example:
Simple
status
integer
Product type status
Example:
1
Example 1
GET https://api.wonderjewel.co/1.0/dir/productType HTTP/1.1
authkey: prtLoYWuLOirlFN7XkiXlJseuBXYnX3U
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "success",
"error_code": 0,
"error_message": "no errors",
"data": {
"list": [
{
"id": 1,
"title": "Simple",
"description": "Simple",
"status": 1
},
{
"id": 2,
"title": "Customizable",
"description": "Customizable",
"status": 1
}
]
}
}
GET
/1.0/dir/jewelryType
Authentication
OAuth2
Returns all jewelry types
Request headers
Responses
200
OK
Body
Object
status
string
Responce status [success/error]
Example:
success
error_code
integer
Error code (see error codes list)
error_message
string
Text error message
Example:
no errors
data
Object
base64 Encoded object
list
Array
List of jewerly types
Object
id
integer
id jewerly type
title
string
Jewerly type title
Example:
Ring
description
string
Jewerly type description
Example:
Ring
status
integer
Jewerly type status
Example:
1
Example 1
GET https://api.wonderjewel.co/api/1.0/dir/jewelryType HTTP/1.1
authkey: prtLoYWuLOirlFN7XkiXlJseuBXYnX3U
HTTP/1.1 200 OK
Content-Type: application/json
{
"status": "success",
"error_code": 0,
"error_message": "no errors",
"data": {
"list": [
{
"id": 8,
"title": "Ring",
"description": "Ring",
"status": 1
},
{
"id": 7,
"title": "Necklace",
"description": "Necklace",
"status": 1
},
{
"id": 5,
"title": "Bracelet",
"description": "Bracelet",
"status": 1
},
{
"id": 4,
"title": "Earrings",
"description": "Earrings",
"status": 1
}
]
}
}
GET
/1.0/product
GET
/1.0/product
GET
/1.0/product/
{VENDOR_MODEL}
GET
/1.0/product/
{PARTNER_ID}
POST
/1.0/product-configurations
POST
/1.0/product
POST
/1.0/product
POST
/1.0/product
GET
/1.0/product
Get product list by limit and offset.
IMPORTANT! Below product structure provided for simple products (product type = 1). Check “Get Bridal” method to see Bridal product structure.
Request parameters
limit
integer
optional
Default 50
offset
integer
optional
Default 0
jewelryType
integer
optional
Additional filter by Jewelty Type
productType
integer
optional
Additional filter by Product Type
Request headers
Responses
200
OK
Body
Object
status
string
Responce status [success/error]
Example:
success
error_code
string
Error code (see error codes list)
Example:
0
error_message
string
Text error message
Example:
no-errors
data
Object
products
Array
Product List
Object
vendor_model
string
Factory Vendor model
Example:
RPD117
partner_id
string
Partner product ID
Example:
123123
description
string
Product Description
Example:
1-3 Stones heart style Pendant
jewelry_type
string
Jewelry Type (From Directories)
Example:
7
product_type
string
Product type (From Directories)
Example:
1
plp_image
string
PLP Product image
Example:
https://j4z2x5e8.stackpathcdn.com/zbuilder/reeds/pendant/PD117/PD117-PLP.png
created_at
integer
Unix time
Example:
1558717240
updated_at
integer
Unix time
Example:
1558717240
min_price
number
Minimum Configuration Price
max_price
number
Maximum Configuration Price
status
integer
Product status (From Directories)
Example:
2
retail_start
number
Retail price start from this value
Example:
1899.99
gender
integer
Gender (From Directories)
Example:
1
options
Object
Available product options
chain
Object
Available for Pendants, Necklaces, Circle Links (jewelryType == 7)
metal
Array
Object
material_sku
string
Example:
f
material_title
string
Example:
14K GOLD
sort
integer
color
Array
Object
sku
string
Example:
R
title
string
Example:
Rose
length
Array
of
string
Chain length
Example:
[16,18,20]pendant
Object
Available for Necklaces (jewelryType == 7)
stones
string
Available Stones
Example:
1,2-5,9
stone
Array
Object
sku
string
Example:
jsp
title
string
Example:
June
description
string
Example:
Pearl
image
string
weight_stone
string
Example:
e
stone_shape
string
Example:
rd
quality
string
Example:
VS2
type
integer
Example:
1
sort
integer
metal
Array
Object
material_sku
string
Example:
f
material_title
string
Example:
14K GOLD
sort
integer
color
Array
Object
sku
string
Example:
R
title
string
Example:
Rose
shank
Object
Available for Rings (jewelryType == 8)
stone
Array
Object
sku
string
Example:
jsp
title
string
Example:
June
description
string
Example:
Pearl
image
string
weight_stone
string
Example:
e
stone_shape
string
Example:
rd
quality
string
Example:
VS2
type
integer
Example:
1
sort
integer
metal
Array
Object
material_sku
string
Example:
f
material_title
string
Example:
14K GOLD
sort
integer
color
Array
Object
sku
string
Example:
R
title
string
Example:
Rose
engraving
Object
Product engraving options
enabled
integer
Example:
1
fonts
Array
Object
sku
string
Example:
handlee
title
string
Example:
Handlee
options
Object
e0
Object
s2
Object
stones count
show
boolean
Example:
true
minChar
integer
Example:
2
maxChar
integer
Example:
25
radius
integer
Example:
-600
angle
number
Example:
-0.02
posX
integer
Example:
335
posY
integer
Example:
-147
skewX
integer
skewY
integer
s3
Object
show
boolean
Example:
true
minChar
integer
Example:
2
maxChar
integer
Example:
10
radius
integer
Example:
-500
angle
number
Example:
-0.08
posX
integer
Example:
420
posY
integer
Example:
-130
skewX
integer
skewY
integer
s4
Object
show
boolean
minChar
integer
maxChar
integer
radius
integer
angle
integer
posX
integer
posY
integer
skewX
integer
skewY
integer
e1
Object
s2
Object
show
boolean
Example:
true
minChar
integer
Example:
2
maxChar
integer
Example:
15
radius
integer
Example:
400
angle
number
Example:
1.34
posX
integer
Example:
485
posY
integer
Example:
250
skewX
integer
skewY
integer
s3
Object
show
boolean
minChar
integer
maxChar
integer
radius
integer
angle
integer
posX
integer
posY
integer
skewX
integer
skewY
integer
s4
Object
show
boolean
Example:
true
minChar
integer
Example:
2
maxChar
integer
Example:
8
radius
integer
Example:
300
angle
number
Example:
-0.28
posX
integer
Example:
257
posY
integer
Example:
-136
skewX
integer
skewY
integer
bracelet
Object
Available for Bracelet (jewelryType == 2)
stones_max
integer
Example:
3
stone
Array
Object
sku
string
Example:
jsp
title
string
Example:
June
description
string
Example:
Pearl
image
string
weight_stone
string
Example:
e
stone_shape
string
Example:
rd
quality
string
Example:
VS2
type
integer
Example:
1
sort
integer
metal
Array
Object
material_sku
string
Example:
f
material_title
string
Example:
14K GOLD
sort
integer
color
Array
Object
sku
string
Example:
R
title
string
Example:
Rose
length
Array
Example:
[16,18,20]
integer
Example:
16
earring
Object
Available for Earrings (jewelryType == 4)
stones_max
integer
Example:
3
stone
Array
Object
sku
string
Example:
jsp
title
string
Example:
June
description
string
Example:
Pearl
image
string
weight_stone
string
Example:
e
stone_shape
string
Example:
rd
quality
string
Example:
VS2
type
integer
Example:
1
sort
integer
metal
Array
Object
material_sku
string
Example:
f
material_title
string
Example:
14K GOLD
sort
integer
color
Array
Object
sku
string
Example:
R
title
string
Example:
Rose
products_count
integer
Number of products according to the applied filters.
Example:
29
Examples
{
"status": "success",
"error_code": 0,
"error_message": "no errors",
"data": {
"products": [
{
"vendor_model": "RPD117",
"partner_id": "123123",
"title": "Diamond heart Pendant",
"description": "1-3 Stones heart style Pendant",
"jewelryType": "7",
"product_type": "1",
"plp_image": "https://j4z2x5e8.stackpathcdn.com/zbuilder/necklace/RPD117/RPD117-PLP.png",
"min_price": 150.00,
"max_price": 2150.00,
"created_at": 1558717240,
"updated_at": 1558717240,
"status": 2,
"retail_start": 1899.99,
"gender": 1,
"options": {
"chain": {
"types": {
"C2": {
"sku": "C2",
"title": "Cable Chain",
"images": "https://f7s3m8n7.stackpathcdn.com/static/option/C2.png"
}
},
"metal": [
{
"material_sku": "f",
"material_title": "14K GOLD",
"sort": 0,
"color": [
{
"sku": "R",
"title": "Rose"
},
{
"sku": "Y",
"title": "Yellow"
},
{
"sku": "W",
"title": "White"
}
]
}
],
"length": [
16.18,
20
]
},
"pendant": {
"stones_max": 7,
"stone": [
{
"sku": "jsp",
"title": "June",
"description": "Pearl",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
},
{
"sku": "fsa",
"title": "Feb",
"description": "Amethyst",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
}
],
"metal": [
{
"material_sku": "f",
"material_title": "14K GOLD",
"sort": 0,
"color": [
{
"sku": "R",
"title": "Rose"
},
{
"sku": "Y",
"title": "Yellow"
},
{
"sku": "W",
"title": "White"
}
]
}
]
},
"engraving": {
"enabled": 1,
"fonts": [
{
"sku": "handlee",
"title": "Handlee"
},
{
"sku": "satisfy",
"title": "Satisfy"
},
{
"sku": "charm",
"title": "Charm"
}
],
"options": {
"e0": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 25,
"radius": -600,
"angle": -0.02,
"posX": 335,
"posY": -147,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": true,
"minChar": 2,
"maxChar": 10,
"radius": -500,
"angle": -0.08,
"posX": 420,
"posY": -130,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
}
},
"e1": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 15,
"radius": 400,
"angle": 1.34,
"posX": 485,
"posY": 250,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": true,
"minChar": 2,
"maxChar": 8,
"radius": 300,
"angle": -0.28,
"posX": 257,
"posY": -136,
"skewX": 0,
"skewY": 0
}
}
}
}
}
},
{
"vendor_model": "RRG106",
"partner_id": "123123",
"title": "Diamond Ring",
"description": "1-3 Diamond Ring",
"jewelryType": "8",
"product_type": "1",
"plp_image": "https://j4z2x5e8.stackpathcdn.com/zbuilder/ring/RRG106/RRG106-PLP.png",
"min_price": 150.00,
"max_price": 2150.00,
"created_at": 1558717240,
"updated_at": 1558717240,
"status": 2,
"retail_start": 1899.99,
"gender": 1,
"options": {
"shank": {
"stone": [
{
"sku": "jsp",
"title": "June",
"description": "Pearl",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
},
{
"sku": "fsa",
"title": "Feb",
"description": "Amethyst",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
}
],
"metal": [
{
"material_sku": "f",
"material_title": "14K GOLD",
"sort": 0,
"color": [
{
"sku": "R",
"title": "Rose"
},
{
"sku": "Y",
"title": "Yellow"
},
{
"sku": "W",
"title": "White"
}
]
},
{
"material_sku": "s",
"material_title": "Sterling silver",
"sort": 0,
"color": [
{
"sku": "W",
"title": "White"
}
]
}
]
},
"engraving": {
"enabled": 1,
"fonts": [
{
"sku": "handlee",
"title": "Handlee"
},
{
"sku": "satisfy",
"title": "Satisfy"
},
{
"sku": "charm",
"title": "Charm"
}
],
"options": {
"e0": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 25,
"radius": -600,
"angle": -0.02,
"posX": 335,
"posY": -147,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": true,
"minChar": 2,
"maxChar": 10,
"radius": -500,
"angle": -0.08,
"posX": 420,
"posY": -130,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
}
},
"e1": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 15,
"radius": 400,
"angle": 1.34,
"posX": 485,
"posY": 250,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": true,
"minChar": 2,
"maxChar": 8,
"radius": 300,
"angle": -0.28,
"posX": 257,
"posY": -136,
"skewX": 0,
"skewY": 0
}
}
}
}
}
},
{
"vendor_model": "RBR007",
"partner_id": "123123",
"title": "Fashion Bracelet",
"description": "1-3 Stones Fashion Bracelet",
"jewelryType": "2",
"product_type": "1",
"plp_image": "https://j4z2x5e8.stackpathcdn.com/zbuilder/bracelet/RBR007/RBR007-PLP.png",
"min_price": 150.00,
"max_price": 2150.00,
"created_at": 1558717240,
"updated_at": 1558717240,
"status": 2,
"retail_start": 1899.99,
"gender": 1,
"options": {
"bracelet": {
"stones_max": 3,
"stone": [
{
"sku": "jsp",
"title": "June",
"description": "Pearl",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
},
{
"sku": "fsa",
"title": "Feb",
"description": "Amethyst",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
}
],
"metal": [
{
"material_sku": "f",
"material_title": "14K GOLD",
"sort": 0,
"color": [
{
"sku": "R",
"title": "Rose"
},
{
"sku": "Y",
"title": "Yellow"
},
{
"sku": "W",
"title": "White"
}
]
}
],
"length": [
16,
18,
20
]
},
"engraving": {
"enabled": 1,
"fonts": [
{
"sku": "handlee",
"title": "Handlee"
},
{
"sku": "satisfy",
"title": "Satisfy"
},
{
"sku": "charm",
"title": "Charm"
}
],
"options": {
"e0": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 25,
"radius": -600,
"angle": -0.02,
"posX": 335,
"posY": -147,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": true,
"minChar": 2,
"maxChar": 10,
"radius": -500,
"angle": -0.08,
"posX": 420,
"posY": -130,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
}
},
"e1": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 15,
"radius": 400,
"angle": 1.34,
"posX": 485,
"posY": 250,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": true,
"minChar": 2,
"maxChar": 8,
"radius": 300,
"angle": -0.28,
"posX": 257,
"posY": -136,
"skewX": 0,
"skewY": 0
}
}
}
}
}
},
{
"vendor_model": "REA011",
"partner_id": "123123",
"title": "Fashion Earrings",
"description": "1-3 Stones Fashion Earrings",
"jewelryType": "4",
"product_type": "1",
"plp_image": "https://j4z2x5e8.stackpathcdn.com/zbuilder/earrings/REA011/REA011-PLP.png",
"min_price": 150.00,
"max_price": 2150.00,
"created_at": 1558717240,
"updated_at": 1558717240,
"status": 2,
"retail_start": 1899.99,
"gender": 1,
"options": {
"earring": {
"stones_max": 3,
"stone": [
{
"sku": "jsp",
"title": "June",
"description": "Pearl",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
},
{
"sku": "fsa",
"title": "Feb",
"description": "Amethyst",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
}
],
"metal": [
{
"material_sku": "f",
"material_title": "14K GOLD",
"sort": 0,
"color": [
{
"sku": "R",
"title": "Rose"
},
{
"sku": "Y",
"title": "Yellow"
},
{
"sku": "W",
"title": "White"
}
]
}
]
},
"engraving": {
"enabled": 1,
"fonts": [
{
"sku": "handlee",
"title": "Handlee"
},
{
"sku": "satisfy",
"title": "Satisfy"
},
{
"sku": "charm",
"title": "Charm"
}
],
"options": {
"e0": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 25,
"radius": -600,
"angle": -0.02,
"posX": 335,
"posY": -147,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": true,
"minChar": 2,
"maxChar": 10,
"radius": -500,
"angle": -0.08,
"posX": 420,
"posY": -130,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
}
},
"e1": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 15,
"radius": 400,
"angle": 1.34,
"posX": 485,
"posY": 250,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": true,
"minChar": 2,
"maxChar": 8,
"radius": 300,
"angle": -0.28,
"posX": 257,
"posY": -136,
"skewX": 0,
"skewY": 0
}
}
}
}
}
}
],
"products_count": 29
}
}Example 1
Options
GET http://api.wonderjewel.co/1.0/product?offset=0&limit=50 HTTP/1.1
authkey: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
HTTP/1.1 200 OK
Content-Type: application/json Base64 Encoded
{
"status": "success",
"error_code": 0,
"error_message": "no errors",
"data": {
"products": [
{
"vendor_model": "RPD117",
"partner_id": "123123",
"title": "Diamond heart Pendant",
"description": "1-3 Stones heart style Pendant",
"jewelryType": "7",
"product_type": "1",
"plp_image": "https://j4z2x5e8.stackpathcdn.com/zbuilder/necklace/RPD117/RPD117-PLP.png",
"created_at": 1558717240,
"updated_at": 1558717240,
"status": 2,
"retail_start": 1899.99,
"gender": 1,
"options": {
"chain": {
"types": {
"C2": {
"sku": "C2",
"title": "Cable Chain",
"images": "https://f7s3m8n7.stackpathcdn.com/static/option/C2.png"
}
},
"metal": [
{
"material_sku": "f",
"material_title": "14K GOLD",
"sort": 0,
"color": [
{
"sku": "R",
"title": "Rose"
},
{
"sku": "Y",
"title": "Yellow"
},
{
"sku": "W",
"title": "White"
}
]
}
],
"length": [
16.18,
20
]
},
"pendant": {
"stones_max": 7,
"stone": [
{
"sku": "jsp",
"title": "June",
"description": "Pearl",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
},
{
"sku": "fsa",
"title": "Feb",
"description": "Amethyst",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
}
],
"metal": [
{
"material_sku": "f",
"material_title": "14K GOLD",
"sort": 0,
"color": [
{
"sku": "R",
"title": "Rose"
},
{
"sku": "Y",
"title": "Yellow"
},
{
"sku": "W",
"title": "White"
}
]
}
]
},
"engraving": {
"enabled": 1,
"fonts": [
{
"sku": "handlee",
"title": "Handlee"
},
{
"sku": "satisfy",
"title": "Satisfy"
},
{
"sku": "charm",
"title": "Charm"
}
],
"options": {
"e0": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 25,
"radius": -600,
"angle": -0.02,
"posX": 335,
"posY": -147,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": true,
"minChar": 2,
"maxChar": 10,
"radius": -500,
"angle": -0.08,
"posX": 420,
"posY": -130,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
}
},
"e1": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 15,
"radius": 400,
"angle": 1.34,
"posX": 485,
"posY": 250,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": true,
"minChar": 2,
"maxChar": 8,
"radius": 300,
"angle": -0.28,
"posX": 257,
"posY": -136,
"skewX": 0,
"skewY": 0
}
}
}
}
}
},
{
"vendor_model": "RRG106",
"partner_id": "123123",
"title": "Diamond Ring",
"description": "1-3 Diamond Ring",
"jewelryType": "8",
"product_type": "1",
"plp_image": "https://j4z2x5e8.stackpathcdn.com/zbuilder/ring/RRG106/RRG106-PLP.png",
"created_at": 1558717240,
"updated_at": 1558717240,
"status": 2,
"retail_start": 1899.99,
"gender": 1,
"options": {
"shank": {
"stone": [
{
"sku": "jsp",
"title": "June",
"description": "Pearl",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
},
{
"sku": "fsa",
"title": "Feb",
"description": "Amethyst",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
}
],
"metal": [
{
"material_sku": "f",
"material_title": "14K GOLD",
"sort": 0,
"color": [
{
"sku": "R",
"title": "Rose"
},
{
"sku": "Y",
"title": "Yellow"
},
{
"sku": "W",
"title": "White"
}
]
},
{
"material_sku": "s",
"material_title": "Sterling silver",
"sort": 0,
"color": [
{
"sku": "W",
"title": "White"
}
]
}
]
},
"engraving": {
"enabled": 1,
"fonts": [
{
"sku": "handlee",
"title": "Handlee"
},
{
"sku": "satisfy",
"title": "Satisfy"
},
{
"sku": "charm",
"title": "Charm"
}
],
"options": {
"e0": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 25,
"radius": -600,
"angle": -0.02,
"posX": 335,
"posY": -147,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": true,
"minChar": 2,
"maxChar": 10,
"radius": -500,
"angle": -0.08,
"posX": 420,
"posY": -130,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
}
},
"e1": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 15,
"radius": 400,
"angle": 1.34,
"posX": 485,
"posY": 250,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": true,
"minChar": 2,
"maxChar": 8,
"radius": 300,
"angle": -0.28,
"posX": 257,
"posY": -136,
"skewX": 0,
"skewY": 0
}
}
}
}
}
},
{
"vendor_model": "RBR007",
"partner_id": "123123",
"title": "Fashion Bracelet",
"description": "1-3 Stones Fashion Bracelet",
"jewelryType": "2",
"product_type": "1",
"plp_image": "https://j4z2x5e8.stackpathcdn.com/zbuilder/bracelet/RBR007/RBR007-PLP.png",
"created_at": 1558717240,
"updated_at": 1558717240,
"status": 2,
"retail_start": 1899.99,
"gender": 1,
"options": {
"bracelet": {
"stones_max": 3,
"stone": [
{
"sku": "jsp",
"title": "June",
"description": "Pearl",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
},
{
"sku": "fsa",
"title": "Feb",
"description": "Amethyst",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
}
],
"metal": [
{
"material_sku": "f",
"material_title": "14K GOLD",
"sort": 0,
"color": [
{
"sku": "R",
"title": "Rose"
},
{
"sku": "Y",
"title": "Yellow"
},
{
"sku": "W",
"title": "White"
}
]
}
],
"length": [
16,
18,
20
]
},
"engraving": {
"enabled": 1,
"fonts": [
{
"sku": "handlee",
"title": "Handlee"
},
{
"sku": "satisfy",
"title": "Satisfy"
},
{
"sku": "charm",
"title": "Charm"
}
],
"options": {
"e0": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 25,
"radius": -600,
"angle": -0.02,
"posX": 335,
"posY": -147,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": true,
"minChar": 2,
"maxChar": 10,
"radius": -500,
"angle": -0.08,
"posX": 420,
"posY": -130,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
}
},
"e1": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 15,
"radius": 400,
"angle": 1.34,
"posX": 485,
"posY": 250,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": true,
"minChar": 2,
"maxChar": 8,
"radius": 300,
"angle": -0.28,
"posX": 257,
"posY": -136,
"skewX": 0,
"skewY": 0
}
}
}
}
}
},
{
"vendor_model": "REA011",
"partner_id": "123123",
"title": "Fashion Earrings",
"description": "1-3 Stones Fashion Earrings",
"jewelryType": "4",
"product_type": "1",
"plp_image": "https://j4z2x5e8.stackpathcdn.com/zbuilder/earrings/REA011/REA011-PLP.png",
"created_at": 1558717240,
"updated_at": 1558717240,
"status": 2,
"retail_start": 1899.99,
"gender": 1,
"options": {
"earring": {
"stones_max": 3,
"stone": [
{
"sku": "jsp",
"title": "June",
"description": "Pearl",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
},
{
"sku": "fsa",
"title": "Feb",
"description": "Amethyst",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
}
],
"metal": [
{
"material_sku": "f",
"material_title": "14K GOLD",
"sort": 0,
"color": [
{
"sku": "R",
"title": "Rose"
},
{
"sku": "Y",
"title": "Yellow"
},
{
"sku": "W",
"title": "White"
}
]
}
]
},
"engraving": {
"enabled": 1,
"fonts": [
{
"sku": "handlee",
"title": "Handlee"
},
{
"sku": "satisfy",
"title": "Satisfy"
},
{
"sku": "charm",
"title": "Charm"
}
],
"options": {
"e0": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 25,
"radius": -600,
"angle": -0.02,
"posX": 335,
"posY": -147,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": true,
"minChar": 2,
"maxChar": 10,
"radius": -500,
"angle": -0.08,
"posX": 420,
"posY": -130,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
}
},
"e1": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 15,
"radius": 400,
"angle": 1.34,
"posX": 485,
"posY": 250,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": true,
"minChar": 2,
"maxChar": 8,
"radius": 300,
"angle": -0.28,
"posX": 257,
"posY": -136,
"skewX": 0,
"skewY": 0
}
}
}
}
}
}
]
}
}
GET
/1.0/product
Below product structure provided for BRIDAL RING product (product type = 2).
Bridal Rings has ONE base product. It is fully confiurable ring.
Vendor model is fixed to RCR21.
It consists of three main parts:
- Head,
- Shank,
- Band.
Use the link to view object: https://jsoneditoronline.org/?id=956e2e2b258d45459f9bcbc3c63f1ca6
To understand product images structure please view (All layers and images will be send by WJ via WSS methods):
Layers Shank - https://drive.google.com/open?id=1uSl48S0wd5aR6hYiz0K8T-k3dfLMZWKo
Head - Halo and Prong - https://drive.google.com/open?id=1ddtIAySuW4GZzDYD_ym4EsDPJXtbF347
Head - Bezel and 3Stone - https://drive.google.com/open?id=15b8Ade8ZF-CiLq1Ljy2lNWx97qEYAPUi
Head - 3Stone Step - https://drive.google.com/open?id=1YOmmNzpFK9Z7MTsohJ3gj-dAstNai-WO
Head - Bezel and 3Stone - https://drive.google.com/open?id=1_m0W89HUllF7FCkHlXCroG4-JEJNfnKR
Mounting - Side Setting - Length - https://drive.google.com/open?id=13HV3NVig34eaTzV6t1eDPXw6mtRXwUpu
Side Color - Carving - https://drive.google.com/open?id=1Vi6qzPn3gYGAa3mBBQTscv9FUx8ZbInD
Basic object description below.
Request parameters
limit
integer
optional
Default 50
offset
integer
optional
Default 0
jewelryType
integer
optional
Additional filter by Jewelty Type
productType
integer
optional
Additional filter by Product Type
Request headers
Responses
200
OK
Body
Object
status
string
Responce status [success/error]
Example:
success
error_code
integer
Error code (see error codes list)
error_message
string
Text error message
Example:
no errors
data
Object
products
Array
Product List
Object
vendor_model
string
Factory Vendor model
Example:
RCR21
description
string
Product Description
Example:
7/8CT. T.W. 1/2CT. Pear Center Stone, Simplicity Petite Trio Engagement Ring in 14K Rose GOLD
jewelry_type
integer
Jewelry Type (From Directories)
Example:
8
product_type
integer
Product type (From Directories)
Example:
2
gender
integer
Gender (From Directories)
Example:
1
status
integer
Product status (From Directories)
Example:
2
created_at
integer
Unix time
Example:
1560510324
updated_at
integer
Unix time
Example:
1560862821
plp_image
string
Example:
https://j4z2x5e8.stackpathcdn.com/zbuilder/reeds/ring/customizable/CR21/CR21-PLP.png
retail_start
integer
Retail price start from this value
Example:
4000
options
Object
head
Object
Head settings
halo
Object
Head type
title
string
Example:
HALO
sku
string
Example:
halo
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/halo.png
head_settings
Object
HS4
Object
Similar to SKU
title
string
Example:
Cusion Halo
sku
string
Example:
HS4
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/HS4.png
stones
Object
List of supported CENTER stones
dmnd
Object
sku
string
Example:
dmnd
title
string
Example:
Diamond
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/dmnd.png
stone_shape
Object
Supported stone shapes
rd
Object
sku
string
Example:
rd
title
string
Example:
Round
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/rd.png
stone_weight
Object
The list of supported stone carat weights.
e
Object
sku
string
Example:
e
title
string
Example:
1/4 CT.
f
Object
sku
string
Example:
f
title
string
Example:
1/3 CT.
stone_clarity
Object
SI2
Object
sku
string
Example:
SI2
title
string
Example:
SI2
available_shanks
Array
of
string
The list of shank SKUs, compatible to current head type.
metal
Object
f
Object
material_sku
string
Example:
f
material_title
string
Example:
14K GOLD
color
Array
Object
sku
string
Example:
Y
title
string
Example:
Yellow
shank
Object
hr1
Object
title
string
Example:
HR1
sku
string
Example:
hr1
side_settings
Object
SBS
Object
title
string
Example:
SBS
sku
string
Example:
SBS
side_length
Object
SL3
Object
title
string
Example:
HR1-Bead-Eternity
sku
string
Example:
HR1BSSL3
stone
Object
dmnd
Object
sku
string
Example:
dmnd
title
string
Example:
Diamond
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/dmnd.png
stone_shape
Object
rd
Object
sku
string
Example:
rd
title
string
Example:
Round
https://j4z2x5e8.stackpathcdn.com/image
string
Example:
/static/option/rd.png
stone_weight
Array
Object
sku
number
Example:
0.00838
title
string
stone_clarity
Object
SI2
Object
sku
string
Example:
SI2
title
string
Example:
SI2
stone_color
Object
s_wht
Object
sku
string
Example:
s_wht
title
string
Example:
White
s_blck
Object
sku
string
Example:
s_blck
title
string
Example:
Black
sphr
Object
sku
string
Example:
sphr
title
string
Example:
Sapphire
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/sphr.png
stone_shape
Object
rd
Object
sku
string
Example:
rd
title
string
Example:
Round
https://j4z2x5e8.stackpathcdn.com/image
string
Example:
/static/option/rd.png
stone_weight
Array
Object
sku
number
Example:
0.00838
title
string
stone_clarity
Object
SI2
Object
sku
string
Example:
SI2
title
string
Example:
SI2
stone_color
Object
s_bl
Object
sku
string
Example:
s_bl
title
string
Example:
Blue
carving
Object
CA0
Object
title
string
Example:
CA0
sku
string
Example:
CA0
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/CA0.png
length
Object
SL3
Object
title
string
Example:
SL3
sku
string
Example:
SL3
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/SL3.png
SL2
Object
title
string
Example:
HR1-Bead-Three Quarters
sku
string
Example:
HR1BSSL2
stone
Object
dmnd
Object
sku
string
Example:
dmnd
title
string
Example:
Diamond
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/dmnd.png
stone_shape
Object
rd
Object
sku
string
Example:
rd
title
string
Example:
Round
https://j4z2x5e8.stackpathcdn.com/image
string
Example:
/static/option/rd.png
stone_weight
Array
Object
sku
number
Example:
0.00838
title
string
stone_clarity
Object
SI2
Object
sku
string
Example:
SI2
title
string
Example:
SI2
stone_color
Object
s_wht
Object
sku
string
Example:
s_wht
title
string
Example:
White
s_blck
Object
sku
string
Example:
s_blck
title
string
Example:
Black
sphr
Object
sku
string
Example:
sphr
title
string
Example:
Sapphire
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/sphr.png
stone_shape
Object
rd
Object
sku
string
Example:
rd
title
string
Example:
Round
https://j4z2x5e8.stackpathcdn.com/image
string
Example:
/static/option/rd.png
stone_weight
Array
Object
sku
number
Example:
0.00838
title
string
stone_clarity
Object
SI2
Object
sku
string
Example:
SI2
title
string
Example:
SI2
stone_color
Object
s_bl
Object
sku
string
Example:
s_bl
title
string
Example:
Blue
carving
Object
CA0
Object
title
string
Example:
CA0
sku
string
Example:
CA0
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/CA0.png
length
Object
SL3
Object
title
string
Example:
SL3
sku
string
Example:
SL3
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/SL3.png
CA1
Object
title
string
Example:
CA1
sku
string
Example:
CA1
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/CA1.png
length
Object
SL1
Object
title
string
Example:
SL1
sku
string
Example:
SL1
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/SL1.png
SL2
Object
title
string
Example:
SL2
sku
string
Example:
SL2
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/SL2.png
SL3
Object
title
string
Example:
SL3
sku
string
Example:
SL3
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/SL3.png
CA2
Object
title
string
Example:
CA2
sku
string
Example:
CA2
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/CA2.png
length
Object
SL1
Object
title
string
Example:
SL1
sku
string
Example:
SL1
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/SL1.png
SL1
Object
title
string
Example:
HR1-Bead-Half
sku
string
Example:
HR1BSSL1
stone
Object
dmnd
Object
sku
string
Example:
dmnd
title
string
Example:
Diamond
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/dmnd.png
stone_shape
Object
rd
Object
sku
string
Example:
rd
title
string
Example:
Round
https://j4z2x5e8.stackpathcdn.com/image
string
Example:
/static/option/rd.png
stone_weight
Array
Object
sku
number
Example:
0.00838
title
string
stone_clarity
Object
SI2
Object
sku
string
Example:
SI2
title
string
Example:
SI2
stone_color
Object
s_wht
Object
sku
string
Example:
s_wht
title
string
Example:
White
s_blck
Object
sku
string
Example:
s_blck
title
string
Example:
Black
sphr
Object
sku
string
Example:
sphr
title
string
Example:
Sapphire
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/sphr.png
stone_shape
Object
rd
Object
sku
string
Example:
rd
title
string
Example:
Round
https://j4z2x5e8.stackpathcdn.com/image
string
Example:
/static/option/rd.png
stone_weight
Array
Object
sku
number
Example:
0.00838
title
string
stone_clarity
Object
SI2
Object
sku
string
Example:
SI2
title
string
Example:
SI2
stone_color
Object
s_bl
Object
sku
string
Example:
s_bl
title
string
Example:
Blue
carving
Object
CA0
Object
title
string
Example:
CA0
sku
string
Example:
CA0
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/CA0.png
length
Object
SL3
Object
title
string
Example:
SL3
sku
string
Example:
SL3
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/SL3.png
CA1
Object
title
string
Example:
CA1
sku
string
Example:
CA1
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/CA1.png
length
Object
SL1
Object
title
string
Example:
SL1
sku
string
Example:
SL1
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/SL1.png
SL2
Object
title
string
Example:
SL2
sku
string
Example:
SL2
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/SL2.png
SL3
Object
title
string
Example:
SL3
sku
string
Example:
SL3
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/SL3.png
CA2
Object
title
string
Example:
CA2
sku
string
Example:
CA2
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/CA2.png
length
Object
SL1
Object
title
string
Example:
SL1
sku
string
Example:
SL1
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/SL1.png
SL2
Object
title
string
Example:
SL2
sku
string
Example:
SL2
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/SL2.png
SL3
Object
title
string
Example:
SL3
sku
string
Example:
SL3
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/SL3.png
CA3
Object
title
string
Example:
CA3
sku
string
Example:
CA3
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/CA3.png
length
Object
SL1
Object
title
string
Example:
SL1
sku
string
Example:
SL1
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/SL1.png
SL2
Object
title
string
Example:
SL2
sku
string
Example:
SL2
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/SL2.png
SL3
Object
title
string
Example:
SL3
sku
string
Example:
SL3
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/SL3.png
SNS
Object
title
string
Example:
SNS
sku
string
Example:
SNS
side_length
Object
SL3
Object
title
string
Example:
HR1-None-Eternity
sku
string
Example:
HR1NSSL3
stone
Array
of
unknown
carving
Object
CA0
Object
title
string
Example:
CA0
sku
string
Example:
CA0
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/CA0.png
length
Object
SL3
Object
title
string
Example:
SL3
sku
string
Example:
SL3
image
string
Example:
https://j4z2x5e8.stackpathcdn.com//static/option/SL3.png
metal
Object
f
Object
material_sku
string
Example:
f
material_title
string
Example:
14K GOLD
color
Array
Object
sku
string
Example:
Y
title
string
Example:
Yellow
q
Object
material_sku
string
Example:
q
material_title
string
Example:
18K GOLD
color
Array
Object
sku
string
Example:
Y
title
string
Example:
Yellow
p
Object
material_sku
string
Example:
p
material_title
string
Example:
PLAT 95
color
Array
Object
sku
string
Example:
W
title
string
Example:
White
engraving
Object
enabled
integer
Example:
1
fonts
Array
Object
sku
string
Example:
handlee
title
string
Example:
Handlee
options
Object
e0
Object
s2
Object
stones count
show
boolean
Example:
true
minChar
integer
Example:
2
maxChar
integer
Example:
25
radius
integer
Example:
-600
angle
number
Example:
-0.02
posX
integer
Example:
335
posY
integer
Example:
-147
skewX
integer
skewY
integer
s3
Object
show
boolean
Example:
true
minChar
integer
Example:
2
maxChar
integer
Example:
10
radius
integer
Example:
-500
angle
number
Example:
-0.08
posX
integer
Example:
420
posY
integer
Example:
-130
skewX
integer
skewY
integer
s4
Object
show
boolean
minChar
integer
maxChar
integer
radius
integer
angle
integer
posX
integer
posY
integer
skewX
integer
skewY
integer
e1
Object
s2
Object
show
boolean
Example:
true
minChar
integer
Example:
2
maxChar
integer
Example:
15
radius
integer
Example:
400
angle
number
Example:
1.34
posX
integer
Example:
485
posY
integer
Example:
250
skewX
integer
skewY
integer
s3
Object
show
boolean
minChar
integer
maxChar
integer
radius
integer
angle
integer
posX
integer
posY
integer
skewX
integer
skewY
integer
s4
Object
show
boolean
Example:
true
minChar
integer
Example:
2
maxChar
integer
Example:
8
radius
integer
Example:
300
angle
number
Example:
-0.28
posX
integer
Example:
257
posY
integer
Example:
-136
skewX
integer
skewY
integer
products_count
integer
Number of products according to the applied filters.
Example:
29
Examples
{
"status": "success",
"error_code": 0,
"error_message": "no errors",
"data": {
"products": [
{
"vendor_model": "RCR21",
"description": "7/8CT. T.W. 1/2CT. Pear Center Stone, Simplicity Petite Trio Engagement Ring in 14K Rose GOLD",
"jewelry_type": 8,
"product_type": 2,
"gender": 1,
"status": 2,
"created_at": 1560510324,
"updated_at": 1560862821,
"plp_image": "https://j4z2x5e8.stackpathcdn.com/zbuilder/reeds/ring/customizable/CR21/CR21-PLP.png",
"retail_start": 4000,
"options": {
"engraving": {
"enabled": 1,
"fonts": [
{
"sku": "handlee",
"title": "Handlee"
},
{
"sku": "satisfy",
"title": "Satisfy"
},
{
"sku": "charm",
"title": "Charm"
}
],
"options": {
"e0": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 25,
"radius": -600,
"angle": -0.02,
"posX": 335,
"posY": -147,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": true,
"minChar": 2,
"maxChar": 10,
"radius": -500,
"angle": -0.08,
"posX": 420,
"posY": -130,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
}
},
"e1": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 15,
"radius": 400,
"angle": 1.34,
"posX": 485,
"posY": 250,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": true,
"minChar": 2,
"maxChar": 8,
"radius": 300,
"angle": -0.28,
"posX": 257,
"posY": -136,
"skewX": 0,
"skewY": 0
}
}
}
},
"head": {
"halo": {
"title": "HALO",
"sku": "halo",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/halo.png",
"head_settings": {
"HS4": {
"title": "Cusion Halo",
"sku": "HS4",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/HS4.png",
"stones": {
"dmnd": {
"sku": "dmnd",
"title": "Diamond",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/dmnd.png",
"stone_shape": {
"rd": {
"sku": "rd",
"title": "Round",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/rd.png",
"stone_weight": {
"e": {
"sku": "e",
"title": "1/4 CT."
},
"f": {
"sku": "f",
"title": "1/3 CT."
},
"h": {
"sku": "h",
"title": "1/2 CT."
},
"j": {
"sku": "j",
"title": "3/4 CT."
},
"k": {
"sku": "k",
"title": "1 CT."
},
"n": {
"sku": "n",
"title": "1 1/2 CT."
},
"p": {
"sku": "p",
"title": "2 CT."
}
}
}
},
"stone_clarity": {
"SI2": {
"sku": "SI2",
"title": "SI2"
}
}
}
}
}
}
},
"metal": {
"f": {
"material_sku": "f",
"material_title": "14K GOLD",
"color": [
{
"sku": "Y",
"title": "Yellow"
},
{
"sku": "W",
"title": "White"
},
{
"sku": "R",
"title": "Rose"
}
]
},
"q": {
"material_sku": "q",
"material_title": "18K GOLD",
"color": [
{
"sku": "Y",
"title": "Yellow"
},
{
"sku": "W",
"title": "White"
},
{
"sku": "R",
"title": "Rose"
}
]
},
"p": {
"material_sku": "p",
"material_title": "PLAT 95",
"color": [
{
"sku": "W",
"title": "White"
}
]
}
}
},
"shank": {
"hr1": {
"title": "HR1",
"sku": "hr1",
"side_settings": {
"SBS": {
"title": "SBS",
"sku": "SBS",
"side_length": {
"SL3": {
"title": "HR1-Bead-Eternity",
"sku": "HR1BSSL3",
"stone": {
"dmnd": {
"sku": "dmnd",
"title": "Diamond",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/dmnd.png",
"stone_shape": {
"rd": {
"sku": "rd",
"title": "Round",
"https://j4z2x5e8.stackpathcdn.com/image": "/static/option/rd.png",
"stone_weight": [
{
"sku": 0.00838,
"title": ""
}
]
}
},
"stone_clarity": {
"SI2": {
"sku": "SI2",
"title": "SI2"
}
},
"stone_color": {
"s_wht": {
"sku": "s_wht",
"title": "White"
},
"s_blck": {
"sku": "s_blck",
"title": "Black"
}
}
},
"sphr": {
"sku": "sphr",
"title": "Sapphire",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/sphr.png",
"stone_shape": {
"rd": {
"sku": "rd",
"title": "Round",
"https://j4z2x5e8.stackpathcdn.com/image": "/static/option/rd.png",
"stone_weight": [
{
"sku": 0.00838,
"title": ""
}
]
}
},
"stone_clarity": {
"SI2": {
"sku": "SI2",
"title": "SI2"
}
},
"stone_color": {
"s_bl": {
"sku": "s_bl",
"title": "Blue"
}
}
}
},
"carving": {
"CA0": {
"title": "CA0",
"sku": "CA0",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/CA0.png",
"length": {
"SL3": {
"title": "SL3",
"sku": "SL3",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL3.png"
}
}
},
"CA1": {
"title": "CA1",
"sku": "CA1",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/CA1.png",
"length": {
"SL1": {
"title": "SL1",
"sku": "SL1",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL1.png"
},
"SL2": {
"title": "SL2",
"sku": "SL2",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL2.png"
},
"SL3": {
"title": "SL3",
"sku": "SL3",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL3.png"
}
}
},
"CA2": {
"title": "CA2",
"sku": "CA2",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/CA2.png",
"length": {
"SL1": {
"title": "SL1",
"sku": "SL1",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL1.png"
},
"SL2": {
"title": "SL2",
"sku": "SL2",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL2.png"
},
"SL3": {
"title": "SL3",
"sku": "SL3",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL3.png"
}
}
},
"CA3": {
"title": "CA3",
"sku": "CA3",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/CA3.png",
"length": {
"SL1": {
"title": "SL1",
"sku": "SL1",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL1.png"
},
"SL2": {
"title": "SL2",
"sku": "SL2",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL2.png"
},
"SL3": {
"title": "SL3",
"sku": "SL3",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL3.png"
}
}
}
}
},
"SL2": {
"title": "HR1-Bead-Three Quarters",
"sku": "HR1BSSL2",
"stone": {
"dmnd": {
"sku": "dmnd",
"title": "Diamond",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/dmnd.png",
"stone_shape": {
"rd": {
"sku": "rd",
"title": "Round",
"https://j4z2x5e8.stackpathcdn.com/image": "/static/option/rd.png",
"stone_weight": [
{
"sku": 0.00838,
"title": ""
}
]
}
},
"stone_clarity": {
"SI2": {
"sku": "SI2",
"title": "SI2"
}
},
"stone_color": {
"s_wht": {
"sku": "s_wht",
"title": "White"
},
"s_blck": {
"sku": "s_blck",
"title": "Black"
}
}
},
"sphr": {
"sku": "sphr",
"title": "Sapphire",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/sphr.png",
"stone_shape": {
"rd": {
"sku": "rd",
"title": "Round",
"https://j4z2x5e8.stackpathcdn.com/image": "/static/option/rd.png",
"stone_weight": [
{
"sku": 0.00838,
"title": ""
}
]
}
},
"stone_clarity": {
"SI2": {
"sku": "SI2",
"title": "SI2"
}
},
"stone_color": {
"s_bl": {
"sku": "s_bl",
"title": "Blue"
}
}
}
},
"carving": {
"CA0": {
"title": "CA0",
"sku": "CA0",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/CA0.png",
"length": {
"SL3": {
"title": "SL3",
"sku": "SL3",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL3.png"
}
}
},
"CA1": {
"title": "CA1",
"sku": "CA1",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/CA1.png",
"length": {
"SL1": {
"title": "SL1",
"sku": "SL1",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL1.png"
},
"SL2": {
"title": "SL2",
"sku": "SL2",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL2.png"
},
"SL3": {
"title": "SL3",
"sku": "SL3",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL3.png"
}
}
},
"CA2": {
"title": "CA2",
"sku": "CA2",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/CA2.png",
"length": {
"SL1": {
"title": "SL1",
"sku": "SL1",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL1.png"
},
"SL2": {
"title": "SL2",
"sku": "SL2",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL2.png"
},
"SL3": {
"title": "SL3",
"sku": "SL3",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL3.png"
}
}
},
"CA3": {
"title": "CA3",
"sku": "CA3",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/CA3.png",
"length": {
"SL1": {
"title": "SL1",
"sku": "SL1",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL1.png"
},
"SL2": {
"title": "SL2",
"sku": "SL2",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL2.png"
},
"SL3": {
"title": "SL3",
"sku": "SL3",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL3.png"
}
}
}
}
},
"SL1": {
"title": "HR1-Bead-Half",
"sku": "HR1BSSL1",
"stone": {
"dmnd": {
"sku": "dmnd",
"title": "Diamond",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/dmnd.png",
"stone_shape": {
"rd": {
"sku": "rd",
"title": "Round",
"https://j4z2x5e8.stackpathcdn.com/image": "/static/option/rd.png",
"stone_weight": [
{
"sku": 0.00838,
"title": ""
}
]
}
},
"stone_clarity": {
"SI2": {
"sku": "SI2",
"title": "SI2"
}
},
"stone_color": {
"s_wht": {
"sku": "s_wht",
"title": "White"
},
"s_blck": {
"sku": "s_blck",
"title": "Black"
}
}
},
"sphr": {
"sku": "sphr",
"title": "Sapphire",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/sphr.png",
"stone_shape": {
"rd": {
"sku": "rd",
"title": "Round",
"https://j4z2x5e8.stackpathcdn.com/image": "/static/option/rd.png",
"stone_weight": [
{
"sku": 0.00838,
"title": ""
}
]
}
},
"stone_clarity": {
"SI2": {
"sku": "SI2",
"title": "SI2"
}
},
"stone_color": {
"s_bl": {
"sku": "s_bl",
"title": "Blue"
}
}
}
},
"carving": {
"CA0": {
"title": "CA0",
"sku": "CA0",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/CA0.png",
"length": {
"SL3": {
"title": "SL3",
"sku": "SL3",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL3.png"
}
}
},
"CA1": {
"title": "CA1",
"sku": "CA1",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/CA1.png",
"length": {
"SL1": {
"title": "SL1",
"sku": "SL1",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL1.png"
},
"SL2": {
"title": "SL2",
"sku": "SL2",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL2.png"
},
"SL3": {
"title": "SL3",
"sku": "SL3",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL3.png"
}
}
},
"CA2": {
"title": "CA2",
"sku": "CA2",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/CA2.png",
"length": {
"SL1": {
"title": "SL1",
"sku": "SL1",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL1.png"
},
"SL2": {
"title": "SL2",
"sku": "SL2",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL2.png"
},
"SL3": {
"title": "SL3",
"sku": "SL3",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL3.png"
}
}
},
"CA3": {
"title": "CA3",
"sku": "CA3",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/CA3.png",
"length": {
"SL1": {
"title": "SL1",
"sku": "SL1",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL1.png"
},
"SL2": {
"title": "SL2",
"sku": "SL2",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL2.png"
},
"SL3": {
"title": "SL3",
"sku": "SL3",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL3.png"
}
}
}
}
}
}
},
"SNS": {
"title": "SNS",
"sku": "SNS",
"side_length": {
"SL3": {
"title": "HR1-None-Eternity",
"sku": "HR1NSSL3",
"stone": [],
"carving": {
"CA0": {
"title": "CA0",
"sku": "CA0",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/CA0.png",
"length": {
"SL3": {
"title": "SL3",
"sku": "SL3",
"image": "https://j4z2x5e8.stackpathcdn.com//static/option/SL3.png"
}
}
}
}
}
}
}
}
},
"metal": {
"f": {
"material_sku": "f",
"material_title": "14K GOLD",
"color": [
{
"sku": "Y",
"title": "Yellow"
},
{
"sku": "W",
"title": "White"
},
{
"sku": "R",
"title": "Rose"
}
]
},
"q": {
"material_sku": "q",
"material_title": "18K GOLD",
"color": [
{
"sku": "Y",
"title": "Yellow"
},
{
"sku": "W",
"title": "White"
},
{
"sku": "R",
"title": "Rose"
}
]
},
"p": {
"material_sku": "p",
"material_title": "PLAT 95",
"color": [
{
"sku": "W",
"title": "White"
}
]
}
}
}
}
}
],
"products_count": 29
}
}Example 1
Options
See https://jsoneditoronline.org/?id=956e2e2b258d45459f9bcbc3c63f1ca6
GET
/1.0/product/
{VENDOR_MODEL}Get product list By Vendor Model.
IMPORTANT! Below product structure provided for simple products (product type = 1). Check “Get Bridal” method to see Bridal product structure.
Path variables
VENDOR_MODEL
string
required
Request headers
Responses
200
OK
Body
Object
status
string
Responce status [success/error]
Example:
success
error_code
string
Error code (see error codes list)
Example:
0
error_message
string
Text error message
Example:
no-errors
data
Object
products
Array
Product List
Object
vendor_model
string
Factory Vendor model
Example:
RPD117
partner_id
string
Partner product ID
Example:
123123
description
string
Product Description
Example:
1-3 Stones heart style Pendant
jewelry_type
string
Jewelry Type (From Directories)
Example:
7
product_type
string
Product type (From Directories)
Example:
1
plp_image
string
PLP Product image
Example:
https://j4z2x5e8.stackpathcdn.com/zbuilder/reeds/pendant/PD117/PD117-PLP.png
created_at
integer
Unix time
Example:
1558717240
updated_at
integer
Unix time
Example:
1558717240
min_price
number
max_price
number
status
integer
Product status (From Directories)
Example:
2
retail_start
number
Retail price start from this value
Example:
1899.99
gender
integer
Gender (From Directories)
Example:
1
options
Object
Available product options
chain
Object
Available for Pendants, Necklaces, Circle Links (jewelryType == 7)
metal
Array
Object
material_sku
string
Example:
f
material_title
string
Example:
14K GOLD
sort
integer
color
Array
Object
sku
string
Example:
R
title
string
Example:
Rose
length
Array
of
string
Example:
[16,18,20]pendant
Object
Available for Necklaces (jewelryType == 7)
stones
string
Example:
1,5-7
stone
Array
Object
sku
string
Example:
jsp
title
string
Example:
June
description
string
Example:
Pearl
image
string
weight_stone
string
Example:
e
stone_shape
string
Example:
rd
quality
string
Example:
VS2
type
integer
Example:
1
sort
integer
metal
Array
Object
material_sku
string
Example:
f
material_title
string
Example:
14K GOLD
sort
integer
color
Array
Object
sku
string
Example:
R
title
string
Example:
Rose
shank
Object
Available for Rings (jewelryType == 8)
stone
Array
Object
sku
string
Example:
jsp
title
string
Example:
June
description
string
Example:
Pearl
image
string
weight_stone
string
Example:
e
stone_shape
string
Example:
rd
quality
string
Example:
VS2
type
integer
Example:
1
sort
integer
metal
Array
Object
material_sku
string
Example:
f
material_title
string
Example:
14K GOLD
sort
integer
color
Array
Object
sku
string
Example:
R
title
string
Example:
Rose
engraving
Object
Product engraving options
enabled
integer
Example:
1
fonts
Array
Object
sku
string
Example:
handlee
title
string
Example:
Handlee
options
Object
e0
Object
s2
Object
stones count
show
boolean
Example:
true
minChar
integer
Example:
2
maxChar
integer
Example:
25
radius
integer
Example:
-600
angle
number
Example:
-0.02
posX
integer
Example:
335
posY
integer
Example:
-147
skewX
integer
skewY
integer
s3
Object
show
boolean
Example:
true
minChar
integer
Example:
2
maxChar
integer
Example:
10
radius
integer
Example:
-500
angle
number
Example:
-0.08
posX
integer
Example:
420
posY
integer
Example:
-130
skewX
integer
skewY
integer
s4
Object
show
boolean
minChar
integer
maxChar
integer
radius
integer
angle
integer
posX
integer
posY
integer
skewX
integer
skewY
integer
e1
Object
s2
Object
show
boolean
Example:
true
minChar
integer
Example:
2
maxChar
integer
Example:
15
radius
integer
Example:
400
angle
number
Example:
1.34
posX
integer
Example:
485
posY
integer
Example:
250
skewX
integer
skewY
integer
s3
Object
show
boolean
minChar
integer
maxChar
integer
radius
integer
angle
integer
posX
integer
posY
integer
skewX
integer
skewY
integer
s4
Object
show
boolean
Example:
true
minChar
integer
Example:
2
maxChar
integer
Example:
8
radius
integer
Example:
300
angle
number
Example:
-0.28
posX
integer
Example:
257
posY
integer
Example:
-136
skewX
integer
skewY
integer
bracelet
Object
Available for Bracelet (jewelryType == 2)
stones_max
integer
Example:
3
stone
Array
Object
sku
string
Example:
fsa
title
string
Example:
Feb
description
string
Example:
Amethyst
image
string
weight_stone
string
Example:
e
stone_shape
string
Example:
rd
quality
string
Example:
VS2
type
integer
Example:
1
sort
integer
metal
Array
Object
material_sku
string
Example:
f
material_title
string
Example:
14K GOLD
sort
integer
color
Array
Object
sku
string
Example:
R
title
string
Example:
Rose
length
Array
Bracelet length
Example:
[16,18,20]
integer
Example:
16
earring
Object
Available for Earring (jewelryType == 4)
stones_max
integer
Example:
3
stone
Array
Object
sku
string
Example:
jsp
title
string
Example:
June
description
string
Example:
Pearl
image
string
weight_stone
string
Example:
e
stone_shape
string
Example:
rd
quality
string
Example:
VS2
type
integer
Example:
1
sort
integer
metal
Array
Object
material_sku
string
Example:
f
material_title
string
Example:
14K GOLD
sort
integer
color
Array
Object
sku
string
Example:
R
title
string
Example:
Rose
Example 1
Options
GET http://api.wonderjewel.co/1.0/product/RPD117 HTTP/1.1
authkey: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
HTTP/1.1 200 OK
Content-Type: application/json Base64 Encoded
{
"status": "success",
"error_code": 0,
"error_message": "no errors",
"data": {
"products": [
{
"vendor_model": "RPD117",
"partner_id": "123123",
"title": "Diamond heart Pendant",
"description": "1-3 Stones heart style Pendant",
"jewelryType": "7",
"product_type": "1",
"plp_image": "https://j4z2x5e8.stackpathcdn.com/zbuilder/necklace/RPD117/RPD117-PLP.png",
"min_price": 150.00,
"max_price": 2150.00,
"created_at": 1558717240,
"updated_at": 1558717240,
"status": 2,
"retail_start": 1899.99,
"gender": 1,
"options": {
"chain": {
"types": {
"C2": {
"sku": "C2",
"title": "Cable Chain",
"images": "https://f7s3m8n7.stackpathcdn.com/static/option/C2.png"
}
},
"metal": [
{
"material_sku": "f",
"material_title": "14K GOLD",
"sort": 0,
"color": [
{
"sku": "R",
"title": "Rose"
},
{
"sku": "Y",
"title": "Yellow"
},
{
"sku": "W",
"title": "White"
}
]
}
],
"length": [
16.18,
20
]
},
"pendant": {
"stones_max": 7,
"stone": [
{
"sku": "jsp",
"title": "June",
"description": "Pearl",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
},
{
"sku": "fsa",
"title": "Feb",
"description": "Amethyst",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
}
],
"metal": [
{
"material_sku": "f",
"material_title": "14K GOLD",
"sort": 0,
"color": [
{
"sku": "R",
"title": "Rose"
},
{
"sku": "Y",
"title": "Yellow"
},
{
"sku": "W",
"title": "White"
}
]
}
]
},
"engraving": {
"enabled": 1,
"fonts": [
{
"sku": "handlee",
"title": "Handlee"
},
{
"sku": "satisfy",
"title": "Satisfy"
},
{
"sku": "charm",
"title": "Charm"
}
],
"options": {
"e0": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 25,
"radius": -600,
"angle": -0.02,
"posX": 335,
"posY": -147,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": true,
"minChar": 2,
"maxChar": 10,
"radius": -500,
"angle": -0.08,
"posX": 420,
"posY": -130,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
}
},
"e1": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 15,
"radius": 400,
"angle": 1.34,
"posX": 485,
"posY": 250,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": true,
"minChar": 2,
"maxChar": 8,
"radius": 300,
"angle": -0.28,
"posX": 257,
"posY": -136,
"skewX": 0,
"skewY": 0
}
}
}
}
}
},
{
"vendor_model": "RRG106",
"partner_id": "123123",
"title": "Diamond Ring",
"description": "1-3 Diamond Ring",
"jewelryType": "8",
"product_type": "1",
"plp_image": "https://j4z2x5e8.stackpathcdn.com/zbuilder/ring/RRG106/RRG106-PLP.png",
"created_at": 1558717240,
"updated_at": 1558717240,
"status": 2,
"retail_start": 1899.99,
"gender": 1,
"options": {
"shank": {
"stone": [
{
"sku": "jsp",
"title": "June",
"description": "Pearl",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
},
{
"sku": "fsa",
"title": "Feb",
"description": "Amethyst",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
}
],
"metal": [
{
"material_sku": "f",
"material_title": "14K GOLD",
"sort": 0,
"color": [
{
"sku": "R",
"title": "Rose"
},
{
"sku": "Y",
"title": "Yellow"
},
{
"sku": "W",
"title": "White"
}
]
},
{
"material_sku": "s",
"material_title": "Sterling silver",
"sort": 0,
"color": [
{
"sku": "W",
"title": "White"
}
]
}
]
},
"engraving": {
"enabled": 1,
"fonts": [
{
"sku": "handlee",
"title": "Handlee"
},
{
"sku": "satisfy",
"title": "Satisfy"
},
{
"sku": "charm",
"title": "Charm"
}
],
"options": {
"e0": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 25,
"radius": -600,
"angle": -0.02,
"posX": 335,
"posY": -147,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": true,
"minChar": 2,
"maxChar": 10,
"radius": -500,
"angle": -0.08,
"posX": 420,
"posY": -130,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
}
},
"e1": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 15,
"radius": 400,
"angle": 1.34,
"posX": 485,
"posY": 250,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": true,
"minChar": 2,
"maxChar": 8,
"radius": 300,
"angle": -0.28,
"posX": 257,
"posY": -136,
"skewX": 0,
"skewY": 0
}
}
}
}
}
},
{
"vendor_model": "RBR007",
"partner_id": "123123",
"title": "Fashion Bracelet",
"description": "1-3 Stones Fashion Bracelet",
"jewelryType": "2",
"product_type": "1",
"plp_image": "https://j4z2x5e8.stackpathcdn.com/zbuilder/bracelet/RBR007/RBR007-PLP.png",
"created_at": 1558717240,
"updated_at": 1558717240,
"status": 2,
"retail_start": 1899.99,
"gender": 1,
"options": {
"bracelet": {
"stones_max": 3,
"stone": [
{
"sku": "jsp",
"title": "June",
"description": "Pearl",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
},
{
"sku": "fsa",
"title": "Feb",
"description": "Amethyst",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
}
],
"metal": [
{
"material_sku": "f",
"material_title": "14K GOLD",
"sort": 0,
"color": [
{
"sku": "R",
"title": "Rose"
},
{
"sku": "Y",
"title": "Yellow"
},
{
"sku": "W",
"title": "White"
}
]
}
],
"length": [
16,
18,
20
]
},
"engraving": {
"enabled": 1,
"fonts": [
{
"sku": "handlee",
"title": "Handlee"
},
{
"sku": "satisfy",
"title": "Satisfy"
},
{
"sku": "charm",
"title": "Charm"
}
],
"options": {
"e0": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 25,
"radius": -600,
"angle": -0.02,
"posX": 335,
"posY": -147,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": true,
"minChar": 2,
"maxChar": 10,
"radius": -500,
"angle": -0.08,
"posX": 420,
"posY": -130,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
}
},
"e1": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 15,
"radius": 400,
"angle": 1.34,
"posX": 485,
"posY": 250,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": true,
"minChar": 2,
"maxChar": 8,
"radius": 300,
"angle": -0.28,
"posX": 257,
"posY": -136,
"skewX": 0,
"skewY": 0
}
}
}
}
}
},
{
"vendor_model": "REA011",
"partner_id": "123123",
"title": "Fashion Earrings",
"description": "1-3 Stones Fashion Earrings",
"jewelryType": "4",
"product_type": "1",
"plp_image": "https://j4z2x5e8.stackpathcdn.com/zbuilder/earrings/REA011/REA011-PLP.png",
"created_at": 1558717240,
"updated_at": 1558717240,
"status": 2,
"retail_start": 1899.99,
"gender": 1,
"options": {
"earring": {
"stones_max": 3,
"stone": [
{
"sku": "jsp",
"title": "June",
"description": "Pearl",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
},
{
"sku": "fsa",
"title": "Feb",
"description": "Amethyst",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
}
],
"metal": [
{
"material_sku": "f",
"material_title": "14K GOLD",
"sort": 0,
"color": [
{
"sku": "R",
"title": "Rose"
},
{
"sku": "Y",
"title": "Yellow"
},
{
"sku": "W",
"title": "White"
}
]
}
]
},
"engraving": {
"enabled": 1,
"fonts": [
{
"sku": "handlee",
"title": "Handlee"
},
{
"sku": "satisfy",
"title": "Satisfy"
},
{
"sku": "charm",
"title": "Charm"
}
],
"options": {
"e0": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 25,
"radius": -600,
"angle": -0.02,
"posX": 335,
"posY": -147,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": true,
"minChar": 2,
"maxChar": 10,
"radius": -500,
"angle": -0.08,
"posX": 420,
"posY": -130,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
}
},
"e1": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 15,
"radius": 400,
"angle": 1.34,
"posX": 485,
"posY": 250,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": true,
"minChar": 2,
"maxChar": 8,
"radius": 300,
"angle": -0.28,
"posX": 257,
"posY": -136,
"skewX": 0,
"skewY": 0
}
}
}
}
}
}
]
}
}
GET
/1.0/product/
{PARTNER_ID}Get product list By Product ID in partner system.
IMPORTANT! Below product structure provided for simple products (product type = 1). Check “Get Bridal” method to see Bridal product structure.
Path variables
PARTNER_ID
string
required
Request headers
Responses
200
OK
Body
Object
status
string
Responce status [success/error]
Example:
success
error_code
string
Error code (see error codes list)
Example:
0
error_message
string
Text error message
Example:
no-errors
data
Object
products
Array
Product List
Object
vendor_model
string
Factory Vendor model
Example:
RPD117
partner_id
string
Partner product ID
Example:
123123
title
string
Product title
Example:
Diamond heart Pendant
description
string
Product Description
Example:
1-3 Stones heart style Pendant
jewelryType
string
Jewelry Type (From Directories)
Example:
7
product_type
string
Product type (From Directories)
Example:
1
plp_image
string
PLP Product image
Example:
https://j4z2x5e8.stackpathcdn.com/zbuilder/reeds/pendant/PD117/PD117-PLP.png
created_at
integer
Unix time
Example:
1558717240
updated_at
integer
Unix time
Example:
1558717240
status
integer
Product status (From Directories)
Example:
2
retail_start
number
Retail price start from this value
Example:
1899.99
gender
integer
Gender (From Directories)
Example:
1
options
Object
Available product options
chain
Object
Available for Pendants, Necklaces, Circle Links (jewelryType == 7)
metal
Array
Object
material_sku
string
Example:
f
material_title
string
Example:
14K GOLD
sort
integer
color
Array
Object
sku
string
Example:
R
title
string
Example:
Rose
pendant
Object
Available for Necklaces (jewelryType == 7)
stones
string
Example:
1,6,8-9
stone
Array
Object
sku
string
Example:
jsp
title
string
Example:
June
description
string
Example:
Pearl
image
string
weight_stone
string
Example:
e
stone_shape
string
Example:
rd
quality
string
Example:
VS2
type
integer
Example:
1
sort
integer
metal
Array
Object
material_sku
string
Example:
f
material_title
string
Example:
14K GOLD
sort
integer
color
Array
Object
sku
string
Example:
R
title
string
Example:
Rose
shank
Object
Available for Rings (jewelryType == 8)
stone
Array
Object
sku
string
Example:
jsp
title
string
Example:
June
description
string
Example:
Pearl
image
string
weight_stone
string
Example:
e
stone_shape
string
Example:
rd
quality
string
Example:
VS2
type
integer
Example:
1
sort
integer
metal
Array
Object
material_sku
string
Example:
f
material_title
string
Example:
14K GOLD
sort
integer
color
Array
Object
sku
string
Example:
R
title
string
Example:
Rose
engraving
Object
Product engraving options
enabled
integer
Example:
1
fonts
Array
Object
sku
string
Example:
handlee
title
string
Example:
Handlee
options
Object
e0
Object
s2
Object
stones count
show
boolean
Example:
true
minChar
integer
Example:
2
maxChar
integer
Example:
25
radius
integer
Example:
-600
angle
number
Example:
-0.02
posX
integer
Example:
335
posY
integer
Example:
-147
skewX
integer
skewY
integer
s3
Object
show
boolean
Example:
true
minChar
integer
Example:
2
maxChar
integer
Example:
10
radius
integer
Example:
-500
angle
number
Example:
-0.08
posX
integer
Example:
420
posY
integer
Example:
-130
skewX
integer
skewY
integer
s4
Object
show
boolean
minChar
integer
maxChar
integer
radius
integer
angle
integer
posX
integer
posY
integer
skewX
integer
skewY
integer
e1
Object
s2
Object
show
boolean
Example:
true
minChar
integer
Example:
2
maxChar
integer
Example:
15
radius
integer
Example:
400
angle
number
Example:
1.34
posX
integer
Example:
485
posY
integer
Example:
250
skewX
integer
skewY
integer
s3
Object
show
boolean
minChar
integer
maxChar
integer
radius
integer
angle
integer
posX
integer
posY
integer
skewX
integer
skewY
integer
s4
Object
show
boolean
Example:
true
minChar
integer
Example:
2
maxChar
integer
Example:
8
radius
integer
Example:
300
angle
number
Example:
-0.28
posX
integer
Example:
257
posY
integer
Example:
-136
skewX
integer
skewY
integer
Example 1
Options
GET http://api.wonderjewel.co/1.0/product/123123 HTTP/1.1
authkey: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...
HTTP/1.1 200 OK
Content-Type: application/json Base64 Encoded
{
"status":"success",
"error_code":0,
"error_message":"no errors",
"data": {
"products": [
{
"vendor_model": "RPD117",
"partner_id": "123123",
"title": "Diamond heart Pendant",
"description": "1-3 Stones heart style Pendant",
"jewelryType": "7",
"product_type": "1",
"plp_image": "https://j4z2x5e8.stackpathcdn.com/zbuilder/reeds/pendant/PD117/PD117-PLP.png",
"created_at": 1558717240,
"updated_at": 1558717240,
"status": 2,
"retail_start": 1899.99,
"gender": 1,
"options": {
"engraving": {
"enabled": 1,
"fonts": [
{
"sku": "handlee",
"title": "Handlee"
},
{
"sku": "satisfy",
"title": "Satisfy"
},
{
"sku": "charm",
"title": "Charm"
}
],
"options": {
"e0": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 25,
"radius": -600,
"angle": -0.02,
"posX": 335,
"posY": -147,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": true,
"minChar": 2,
"maxChar": 10,
"radius": -500,
"angle": -0.08,
"posX": 420,
"posY": -130,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
}
},
"e1": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 15,
"radius": 400,
"angle": 1.34,
"posX": 485,
"posY": 250,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": true,
"minChar": 2,
"maxChar": 8,
"radius": 300,
"angle": -0.28,
"posX": 257,
"posY": -136,
"skewX": 0,
"skewY": 0
}
}
}
},
"chain": {
"metal": [
{
"material_sku": "f",
"material_title": "14K GOLD",
"sort": 0,
"color": [
{
"sku": "R",
"title": "Rose"
},
{
"sku": "Y",
"title": "Yellow"
},
{
"sku": "W",
"title": "White"
}
]
}
]
},
"pendant": {
"stones_max": 7,
"stone": [
{
"sku": "jsp",
"title": "June",
"description": "Pearl",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
},
{
"sku": "fsa",
"title": "Feb",
"description": "Amethyst",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
}
],
"metal": [
{
"material_sku": "f",
"material_title": "14K GOLD",
"sort": 0,
"color": [
{
"sku": "R",
"title": "Rose"
},
{
"sku": "Y",
"title": "Yellow"
},
{
"sku": "W",
"title": "White"
}
]
}
]
},
},
},
{
"vendor_model": "RRG106",
"partner_id": "123123",
"title": "Diamond Ring",
"description": "1-3 Diamond Ring",
"jewelryType": "8",
"product_type": "1",
"plp_image": "https://j4z2x5e8.stackpathcdn.com/zbuilder/reeds/pendant/RRG106/RRG106-PLP.png",
"created_at": 1558717240,
"updated_at": 1558717240,
"status": 2,
"retail_start": 1899.99,
"gender": 1,
"options": {
"shank": {
"stone": [
{
"sku": "jsp",
"title": "June",
"description": "Pearl",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
},
{
"sku": "fsa",
"title": "Feb",
"description": "Amethyst",
"image": "",
"weight_stone": "e",
"stone_shape": "rd",
"quality": "VS2",
"type": 1,
"sort": 0
}
],
"metal": [
{
"material_sku": "f",
"material_title": "14K GOLD",
"sort": 0,
"color": [
{
"sku": "R",
"title": "Rose"
},
{
"sku": "Y",
"title": "Yellow"
},
{
"sku": "W",
"title": "White"
}
]
},
{
"material_sku": "s",
"material_title": "Sterling silver",
"sort": 0,
"color": [
{
"sku": "W",
"title": "White"
},
]
},
]
},
"engraving": {
"enabled": 1,
"fonts": [
{
"sku": "handlee",
"title": "Handlee"
},
{
"sku": "satisfy",
"title": "Satisfy"
},
{
"sku": "charm",
"title": "Charm"
}
],
"options": {
"e0": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 25,
"radius": -600,
"angle": -0.02,
"posX": 335,
"posY": -147,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": true,
"minChar": 2,
"maxChar": 10,
"radius": -500,
"angle": -0.08,
"posX": 420,
"posY": -130,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
}
},
"e1": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 15,
"radius": 400,
"angle": 1.34,
"posX": 485,
"posY": 250,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": true,
"minChar": 2,
"maxChar": 8,
"radius": 300,
"angle": -0.28,
"posX": 257,
"posY": -136,
"skewX": 0,
"skewY": 0
}
}
}
}
}
},
]
}
}
POST
/1.0/product-configurations
Authentication
OAuth2
Get Product Configuration Price, Images, Title, Description by Configuration data or Configuration ID
Request headers
Request body
Object
items
Object
qty
integer
Example:
1
vendor_model
string
Example:
RPDN20328
size
integer
Example:
18
configuration
Object
The same as in the Order creation request.
Responses
200
OK
Body
Object
vendor_model
string
Product Vendor Model
Example:
RSD1292
ci
string
Configuration ID
Example:
RSD1282-1WFPR
retail
integer
Configuration Retail Cost
Example:
1111
Simple Pendant Configuration Example
Simple Ring Configuration Example
Bridal Ring Configuration Example
Simple Earring Configuration Example
Simple Bracelet Configuration Example
"configuration": {
"chain": {
"type": "C1",
"metal": {
"sku": "f",
"color": "R"
},
"length": 16
},
"pendant": {
"stones": 3,
"stone": [
{
"sku":"sss",
"shape":"rd",
"weight":"k",
"position":2
},
{
"sku":"dst",
"shape":"rd",
"weight":"k",
"position":3
},
{
"sku":"fsa",
"shape":"rd",
"weight":"k",
"position":1
}
],
"metal": {
"sku": "f",
"color": "Y"
}
},
"engraving": [
"e0": {
"font": "satisfy",
"text": "ABC"
},
"e1": {
"font": "satisfy",
"text": "ABC"
}
]
}, "configuration": {
"ring": {
"stones": 3,
"stone": [
{
"sku":"sss",
"shape":"rd",
"weight":"k",
"position":1
} ,
{
"sku":"dst",
"shape":"rd",
"weight":"k",
"position":2
} ,
{
"sku":"fsa",
"shape":"rd",
"weight":"k",
"position":3
}
],
"metal":
{
"sku": "f",
"color": "Y"
},
},
"engraving": [
"e0": {
"font": "satisfy",
"text": "ABC"
},
"e1": {
"font": "satisfy",
"text": "ABC"
}
]
}"configuration": {
"head": {
"type": "HS4",
"center_stone": {
"sku": "DI",
"stone_shape": "RD",
"stone_weight": "F",
"stone_color": "W",
"stone_clarity": "SI2"
},
"additional_stones": {
"sku": "DI",
"stone_color": "W"
},
"metal": {
"sku": "F",
"color": "Y"
}
},
"shank": {
"type": "HS4",
"side_settings": {
"sku": "PS",
"length": "SL1",
"stone": "NO",
"stone_color": "U"
},
"carving": {
"sku": "CA0",
"length": "CL1"
},
"metal": {
"sku": "F",
"color": "Y"
}
},
"engraving": [
"e0": {
"font": "satisfy",
"text": "ABC"
},
"e1": {
"font": "satisfy",
"text": "ABC"
}
]
}"configuration": {
"earring": {
"stones": 3,
"stone": [
{
"sku":"sss",
"shape":"rd",
"weight":"k",
"position":2
},
{
"sku":"dst",
"shape":"rd",
"weight":"k",
"position":3
},
{
"sku":"fsa",
"shape":"rd",
"weight":"k",
"position":1
}
],
"metal": {
"sku": "f",
"color": "Y"
},
"length": 16
},
"engraving": [
"e0": {
"font": "satisfy",
"text": "ABC"
},
"e1": {
"font": "satisfy",
"text": "ABC"
}
]
}, "configuration": {
"bracelet": {
"stones": 3,
"stone": [
{
"sku":"sss",
"shape":"rd",
"weight":"k",
"position":2
},
{
"sku":"dst",
"shape":"rd",
"weight":"k",
"position":3
},
{
"sku":"fsa",
"shape":"rd",
"weight":"k",
"position":1
}
],
"metal": {
"sku": "f",
"color": "Y"
},
"length": 16
},
"engraving": [
"e0": {
"font": "satisfy",
"text": "ABC"
},
"e1": {
"font": "satisfy",
"text": "ABC"
}
]
},
POST
/1.0/product
Authentication
OAuth2
Notes
Head gemstone object includes the next properties:
“map”: { // The map object
"rd": { // The center stone shape
"e": { // The center stone size
"csq": true, // if set true - the quality property should be gotten from the ring center stone
"quality": "", // String: quality data if the "csq" set false
"quantity": 23, // The quantity of the gemstones
"size": 1.5, // Physical gemstone size
"weight": 0.35 // Total gemstones weight in CT.
}
}
...Example 1
{
"stone": {
"dmnd": {
"sku": "dmnd",
"title": "Diamond",
"image": "https://f7s3m8n7.stackpathcdn.com/static/option/dmnd-RD.png",
"map": {
"rd": {
"e": {
"csq": true,
"quality": "",
"quantity": 22,
"size": "1.2MM",
"weight": 0.22
}
}
}
},
"sphr": {
"sku": "sphr",
"title": "Blue Sapphire",
"image": "https://f7s3m8n7.stackpathcdn.com/static/option/sphr-RD.png",
"map": {
"rd": {
"e": {
"csq": false,
"quality": "Natural Sapphire",
"quantity": 18,
"size": "1.2MM",
"weight": 0.18
}
}
}
}
}
}
POST
/1.0/product
Authentication
OAuth2
Notes
Shank gemstone object includes the next properties:
“map”: { // The map object
"SP1": { // The head SKU
"e": { // The center stone size
"csq": true, // if set true - the quality property should be gotten from the ring center stone
"quality": "", // String: quality data if the "csq" set false
"quantity": 23, // The quantity of the gemstones
"size": 1.5, // Physical gemstone size
"weight": 0.35 // Total gemstones weight in CT.
}
}
...Example 1
{
"stone": {
"dmnd": {
"sku": "dmnd",
"title": "Diamond",
"image": "https://f7s3m8n7.stackpathcdn.com/static/option/dmnd-RD.png",
"map": {
"SP1": {
"e": {
"csq": true,
"quality": "",
"quantity": 22,
"size": "1.2MM",
"weight": 0.22
}
}
}
},
"sphr": {
"sku": "sphr",
"title": "Blue Sapphire",
"image": "https://f7s3m8n7.stackpathcdn.com/static/option/sphr-RD.png",
"map": {
"3ST2": {
"e": {
"csq": false,
"quality": "Natural Sapphire",
"quantity": 18,
"size": "1.2MM",
"weight": 0.18
}
}
}
}
}
}
POST
/1.0/product
Authentication
OAuth2
Notes
Band gemstone object includes the next properties:
"csq": true, // if set true - the quality property should be gotten from the ring center stone
"quality": "", // String: quality data if the "csq" set false
"quantity": 23, // The quantity of the gemstones
"size": 1.5, // Physical gemstone size
"weight": 0.35 // Total gemstones weight in CT.Example 1
"stone": {
"dmnd": {
"sku": "dmnd",
"title": "Diamond",
"image": "https://f7s3m8n7.stackpathcdn.com/static/option/dmnd-RD.png",
"csq": true,
"quality": "",
"quantity": 23,
"size": 1.5,
"weight": 0.35
},
"sphr": {
"sku": "sphr",
"title": "Blue Sapphire",
"image": "https://f7s3m8n7.stackpathcdn.com/static/option/sphr-RD.png",
"csq": false,
"quality": "Natural Sapphire",
"quantity": 23,
"size": "1.2MM",
"weight": 0.23
}
}
GET
/1.0/order
GET
/1.0/order/
{id}
PUT
/1.0/order/
{id}
POST
/1.0/order
GET
/1.0/order
Authentication
OAuth2
Request parameters
limit
string
optional
Allow empty value:
true
Default:
50
Example:
?limit=100000
offset
string
optional
Allow empty value:
true
Default:
0
Example:
?offset=50
Request headers
Responses
200
OK
Body
Object
status
string
Status
Example:
success
error_code
integer
Error Code
error_message
string
Error Code Message
Example:
no errors
data
Array
Object
id
integer
Order ID
Example:
1
type
integer
Type
Example:
1
status
One of
Status
integer
Status
Example:
1
Object
0
string
Example:
Canceled
1
string
Example:
Created
2
string
Example:
Confirmed
3
string
Example:
Ready for production
4
string
Example:
Approved by vendor
5
string
Example:
Production
6
string
Example:
Ready to ship
7
string
Example:
Delivery
8
string
Example:
Delivered
9
string
Example:
Finished
purpose
integer
Example:
1
shipping_address
string
Shipping Customer Address
comment
string
Customer Comment
message
string
Customer Message
billing_address
string
Customer Billing Address
payment_status
integer
Payment Status
Example:
1
currency_id
integer
Currency
Example:
1
customer_id
integer
Customer ID
pos_id
integer
Point of Production
Example:
1
tracking_number
string
Delivery tracking number
Example:
794643487347
Examples
{
"status": "success",
"error_code": 1,
"error_message": "no errors",
"data": [
{
"id": 1,
"type": 1,
"status": 3,
"purpose": 1,
"shipping_address": "",
"comment": "",
"message": "",
"billing_address": "",
"payment_status": 1,
"currency_id": 1,
"customer_id": 1,
"pos_id": 1,
"tracking_number": 794643487347
},
{
"id": 2,
"type": 1,
"status": 3,
"purpose": 1,
"shipping_address": "",
"comment": "",
"message": "",
"billing_address": "",
"payment_status": 1,
"currency_id": 1,
"customer_id": 28,
"pos_id": 1,
"tracking_number": 794612387347
}
]
}
GET
/1.0/order/
{id}Path variables
id
string
required
Order ID
Request headers
Responses
200
OK
Body
Object
status
string
Example:
success
error_code
integer
error_message
string
Example:
no errors
data
Object
pos_name
string
Example:
Builder
order_type
integer
Example:
1
order_status
One of
integer
Example:
3
Object
0
string
Example:
Canceled
1
string
Example:
Created
2
string
Example:
Confirmed
3
string
Example:
Ready for production
4
string
Example:
Approved by vendor
5
string
Example:
Production
6
string
Example:
Ready to ship
7
string
Example:
Delivery
8
string
Example:
Delivered
9
string
Example:
Finished
order_purpose
integer
Example:
1
order_id
integer
Example:
1
shipping_address
string
comment
string
message
string
billing_address
string
payment_status
integer
Example:
1
transaction_id
string
currency
integer
Example:
1
pay_method
string
customer
Object
id
integer
Example:
19
email
string
Example:
abc@gmail.com
phone
integer
Example:
34124
name
string
Example:
Jon Doe
items
Object
id
integer
Example:
1
qty
integer
Example:
1
configuration_id
string
Example:
MODEL-9YQ-H3RDKWQSI2
vendor_model
string
Example:
MODEL
cost
number
Example:
12
amount
number
Example:
1
currency
integer
Example:
1
tracking_number
string
Delivery tracking number
Example:
794643487347
Examples
{
"status": "success",
"error_code": 1,
"error_message": "no errors",
"data": {
"pos_name": "Builder",
"order_type": 1,
"order_status": 3,
"order_purpose": 1,
"order_id": 1,
"shipping_address": "Country, City",
"comment": "",
"message": "",
"billing_address": "Country, City",
"payment_status": 1,
"transaction_id": "",
"currency": 1,
"pay_method": "",
"customer": {
"id": 19,
"email": "abc@gmail.com",
"phone": 34124,
"name": "Jon Doe"
},
"items": {
"id": 1,
"qty": 1,
"configuration_id": "MODEL-9YQ-H3RDKWQSI2",
"vendor_model": "MODEL",
"cost": 12,
"amount": 1,
"currency": 1
},
"tracking_number": 794643487347
}
}
PUT
/1.0/order/
{id}Path variables
id
string
required
Order ID
Request headers
Request body
Object
data
Object
delivery_status
integer
Example:
4
production_status
integer
Example:
5
Responses
200
OK
Body
Object
status
string
Example:
success
error_code
integer
error_message
string
Example:
no errors
data
Object
id
integer
Example:
1
type
integer
Example:
1
status
One of
integer
Example:
3
Object
0
string
Example:
Canceled
1
string
Example:
Created
2
string
Example:
Confirmed
3
string
Example:
Ready for production
4
string
Example:
Approved by vendor
5
string
Example:
Production
6
string
Example:
Ready to ship
7
string
Example:
Delivery
8
string
Example:
Delivered
9
string
Example:
Finished
purpose
integer
Example:
1
shipping_address
string
comment
string
message
string
billing_address
string
payment_status
integer
Example:
1
currency_id
integer
Example:
1
customer_id
integer
pos_id
integer
Example:
1
Examples
{
"status": "success",
"error_code": 1,
"error_message": "no errors",
"data": {
"id": 1,
"type": 1,
"status": 3,
"purpose": 1,
"shipping_address": "",
"comment": "",
"message": "",
"billing_address": "",
"payment_status": 1,
"currency_id": 1,
"customer_id": 1,
"pos_id": 1
}
}
POST
/1.0/order
Request headers
Request body
Object
data
Object
external_order_id
string
External Order ID (Magento Order ID)
Example:
24326768f3g867
order_date
integer
Unix Timestamp
Example:
1559229507
shipping_address
string
Customer Shipping Address
Example:
City, Country
customer_id
integer
Example:
19
customer_email
string
Customer email
Example:
abc@gmail.com
customer_phone
string
Customer phone
Example:
34124
customer_name
string
Customer Name
Example:
Jon Doe
billing_address
string
Customer Billing Address
Example:
Country, City
payment_status
integer
Enumeration:
0
Canceled
1
Waiting
2
Process
3
Payed
currency
integer
By Currency Directories
Example:
1
pay_method
integer
Enumeration:
0
N/A
1
PAYPAL
2
VISA
3
MASTERCARD
items
Object
qty
integer
required
Qty
Example:
1
vendor_model
string
required
Product Vendor Model
Example:
RSD1292
configuration
Object
The object that contains the selected options for a specific configuration.
configuration_id
string
nullable
optional field
size
integer
Product size (For a ring - the shank size, for a pendant - chain length)
order_type
string
Set 1 as Default Field
Enumeration:
1
Default Order
order_purpose
string
Set 1 as Default Field
Enumeration:
1
Original
order_status
string
Set 3 as Confirmed Order
Enumeration:
0
Canceled
1
Created
2
Confirmed
Examples
Responses
201
Created
Body
Object
status
string
Example:
success
error_code
integer
error_message
string
Example:
no errors
data
Object
success
Object
pos_name
string
Example:
Builder
order_type
integer
Example:
4
order_status
One of
integer
Enumeration:
0
Canceled
1
Created
2
Confirmed
3
Ready for production
4
Production
5
Ready for delivery
6
Delivery
7
Delivered
8
Finished
order_purpose
integer
Example:
2
order_id
integer
Example:
2
shipping_address
string
Example:
Country, City
comment
string
message
string
billing_address
string
Example:
Country, City
payment_status
integer
Example:
2
transaction_id
string
currency
integer
Example:
1
pay_method
string
customer
Object
id
integer
Example:
19
email
string
Example:
abc@gmail.com
phone
integer
Example:
34124
name
string
Example:
Jon Doe
items
Object
id
integer
Example:
2
qty
integer
Example:
30
configuration_id
string
Example:
ACR20-9YQ-H3RDKWQSI2
vendor_model
string
Example:
ACR20
cost
integer
Example:
4945
amount
number
Example:
12641.16
currency
integer
Example:
1
stones
string
Stones
Example:
{"sku":"sss", "shape":"rd", "weight":"k", "position":2}, {"sku":"dst", "shape":"rd", "weight":"k", "position":3}, {"sku":"fsa", "shape":"rd", "weight":"k", "position":1}
Examples
{
"status": "success",
"error_code": 1,
"error_message": "no errors",
"data": {
"success": {
"pos_name": "Current Shop name",
"order_type": 1,
"order_status": 2,
"order_purpose": 1,
"order_id": 23,
"shipping_address": "Country, City",
"comment": "",
"message": "",
"billing_address": "Country, City",
"payment_status": 2,
"transaction_id": "",
"currency": 1,
"pay_method": "",
"customer": {
"id": 19,
"email": "abc@gmail.com",
"phone": 34124,
"name": "Jon Doe"
},
"items": {
"id": 2,
"qty": 30,
"configuration_id": "ACR20-9YQ-H3RDKWQSI2",
"vendor_model": "ACR20",
"cost": 4945,
"amount": 12641.16,
"currency": 1,
"stones": [
{"sku":"sss", "shape":"rd", "weight":"k", "position":2},
{"sku":"dst", "shape":"rd", "weight":"k", "position":3},
{"sku":"fsa", "shape":"rd", "weight":"k", "position":1}
]
}
}
}
}Simple Pendant Configuration Example
Simple Ring Configuration Example
Simple Bracelet Configuration Example
Simple Earring Configuration Example
Bridal Ring Configuration Example
Full Order Data
"configuration": {
"chain": {
"type": "C1",
"metal": {
"sku": "f",
"color": "R"
},
"length": 16
},
"pendant": {
"stones": 3,
"stone": [
{
"sku":"sss",
"shape":"rd",
"weight":"k",
"position":2
},
{
"sku":"dst",
"shape":"rd",
"weight":"k",
"position":3
},
{
"sku":"fsa",
"shape":"rd",
"weight":"k",
"position":1
}
],
"metal": {
"sku": "f",
"color": "Y"
},
},
"engraving": [
"e0": {
"font": "satisfy",
"text": "ABC"
},
"e1": {
"font": "satisfy",
"text": "ABC"
}
]
}, "configuration": {
"ring": {
"stones": 3,
"stone": [
{
"sku":"sss",
"shape":"rd",
"weight":"k",
"position":1
} ,
{
"sku":"dst",
"shape":"rd",
"weight":"k",
"position":2
} ,
{
"sku":"fsa",
"shape":"rd",
"weight":"k",
"position":3
}
],
"metal":
{
"sku": "f",
"color": "Y"
},
},
"engraving": [
"e0": {
"font": "satisfy",
"text": "ABC"
},
"e1": {
"font": "satisfy",
"text": "ABC"
}
]
}"configuration": {
"bracelet": {
"stones": 3,
"stone": [
{
"sku":"sss",
"shape":"rd",
"weight":"k",
"position":2
},
{
"sku":"dst",
"shape":"rd",
"weight":"k",
"position":3
},
{
"sku":"fsa",
"shape":"rd",
"weight":"k",
"position":1
}
],
"metal": {
"sku": "f",
"color": "Y"
},
"length": 16
},
"engraving": [
"e0": {
"font": "satisfy",
"text": "ABC"
},
"e1": {
"font": "satisfy",
"text": "ABC"
}
]
}, "configuration": {
"earring": {
"stones": 3,
"stone": [
{
"sku":"sss",
"shape":"rd",
"weight":"k",
"position":2
},
{
"sku":"dst",
"shape":"rd",
"weight":"k",
"position":3
},
{
"sku":"fsa",
"shape":"rd",
"weight":"k",
"position":1
}
],
"metal": {
"sku": "f",
"color": "Y"
},
"length": 16
},
"engraving": [
"e0": {
"font": "satisfy",
"text": "ABC"
},
"e1": {
"font": "satisfy",
"text": "ABC"
}
]
}, "configuration": {
"head": {
"type": "HS4",
"center_stone": {
"sku": "DI",
"stone_shape": "RD",
"stone_weight": "F",
"stone_color": "W",
"stone_clarity": "SI2"
},
"additional_stones": {
"sku": "DI",
"stone_color": "W"
},
"metal": {
"sku": "F",
"color": "Y"
}
},
"shank": {
"type": "HS4",
"side_settings": {
"sku": "PS",
"length": "SL1",
"stone": "NO",
"stone_color": "U"
},
"carving": {
"sku": "CA0",
"length": "CL1"
},
"metal": {
"sku": "F",
"color": "Y"
}
},
"engraving": [
"e0": {
"font": "satisfy",
"text": "ABC"
},
"e1": {
"font": "satisfy",
"text": "ABC"
}
]
}{
"order_date": 1559229507,
"order_purpose": 1,
"order_type": 1,
"shipping_address": "City, Country",
"customer_id": 19,
"customer_email": "abc@gmail.com",
"customer_phone": "34124",
"customer_name": "Jon Doe",
"billing_address": "Country, City",
"payment_status": 2,
"order_status": 3,
"currency": 1,
"items": {
"qty": 1,
"vendor_model": "RPD104",
"configuration": {
"chain": {
"type": "C1",
"metal": {
"sku": "f",
"color": "R"
}
},
"pendant": {
"stones": 3,
"stone": [
{
"sku": "sss",
"shape": "rd",
"weight": "k",
"position": 2
},
{
"sku": "dst",
"shape": "rd",
"weight": "k",
"position": 3
},
{
"sku": "fsa",
"shape": "rd",
"weight": "k",
"position": 1
}
],
"metal": {
"sku": "f",
"color": "Y"
}
},
"engraving": [
"e0": {
"font": "satisfy",
"text": "ABC"
},
"e1": {
"font": "satisfy",
"text": "ABC"
}
]
}
}
}Get your Unique POS auth_key to Login to WSS
Get Socket URL and Company Socket PORT
GET params:
auth_type = 1 - for builders
auth_key = {POS_KEY}
Connection url:
wss://{socket_url}:{company_port}/?auth_type=1&auth_key={POS_KEY}
Success respons is:
{
"status":"success",
"method_id":0,
"error":0,
"message": {}
}
Error:
Closed Connection or Empty response
Connection
Response object
const ws = new WebSocket("wss://domain.example:2003/?auth_type=1&auth_key=POS_KEY");{
"status": "success",
"method_id": 0,
"error": 0,
"message": {}
}Request example for simple rings and pendant:
Send to wss:
method_id: 1001 - get configuration
vendor_model - Product vendor model. The list of all models of your store and the options available to them can be obtained through REST API. Get product list
{
"method_id":1001,
"vendor_model": "RSD1292",
"configuration": {
"chain": {
"type": "C1",
"metal": {
"sku": "f",
"color": "R"
}
},
"pendant": {
"stones": 3,
"stone": [
{"sku":"sss", "shape":"rd", "weight":"k", "position":2},
{"sku":"dst", "shape":"rd", "weight":"k", "position":3},
{"sku":"fsa", "shape":"rd", "weight":"k", "position":1}
],
"metal": {
"sku": "f",
"color": "Y"
}
},
"engraving": [
"e0": {
"font": "satisfy",
"text": "ABC"
},
"e1": {
"font": "satisfy",
"text": "ABC"
}
]
},
}
Response:
{
"status":"success",
"method_id":1001,
"error":0,
"message": {
"vendor_model": "RSD1292",
"ci": "RSD1282-1WFPR",
"layer": {
"l1": {
"v1": {
"x1": {
"https://domain.example/imagepath.png"
},
"x2":{
"https://domain.example/imagepath-X2.png"
}
},
"v2": {
"x1": {
"https://domain.example/imagepath.png"
},
"x2":{
"https://domain.example/imagepath-X2.png"
}
}
},
"l2": {
"v1": {
"x1": {
"https://domain.example/imagepath-V1.png"
},
"x2":{
"https://domain.example/imagepath-V1-X2.png"
}
},
"v2": {
"x1": {
"https://domain.example/imagepath-V2.png"
},
"x2":{
"https://domain.example/imagepath-V2-X2.png"
}
}
},
"l3": {
"v1": {
"x1": {
"https://domain.example/imagepath-V1.png"
},
"x2":{
"https://domain.example/imagepath-V1-X2.png"
}
},
"v2": {
"x1": {
"https://domain.example/imagepath-V2.png"
},
"x2":{
"https://domain.example/imagepath-V2-X2.png"
}
}
}
},
"price": 1111,
"description": "Configuration Description",
"title": "Configuration Title"
}
Message Description:
vendor_model - Product Vendor Model. Common product identifier that is in the system
ci - Configuration ID. This is a unique parameter that determines the selected type of current product based on the possible options for this.
layer - An object that contains links to product images. All images must be set to the corresponding layers and must be set to the same div in order from the beginning of l1 to lNin order from bottom to top, accordance with the desired view (v1). Example: https://static.wonderjewel.co/reeds2-front/catalog.php
"l1", "l2", "l3", etc. - Image layers for full Product Image
"v1", "v2", etc. - Image Views by view (Front view, Left, back)
"x1", "x2", etc. - Image Size (700x700px or 1400x1400px)
title - Configuration Title
description - Configuration Description
price - Configuration Price
Request for simple pendant
Request for simple ring
Request for simple Earring
Request for simple bracelet
{
"method_id":1001,
"vendor_model": "RSD1292",
"configuration_id": "RDS1292-C1WQ-4WS"
"configuration": {
"chain": {
"type": "C1",
"metal": {
"sku": "f",
"color": "R"
},
"length": 16
},
"pendant": {
"stones": 3,
"stone": [
{"sku":"sss", "shape":"rd", "weight":"k", "position":2},
{"sku":"dst", "shape":"rd", "weight":"k", "position":3},
{"sku":"fsa", "shape":"rd", "weight":"k", "position":1}
],
"metal": {
"sku": "f",
"color": "Y"
}
},
"engraving": [
"e0": {
"font": "satisfy",
"text": "ABC"
},
"e1": {
"font": "satisfy",
"text": "ABC"
}
]
},
}{
"method_id":1001,
"vendor_model": "RRD1150",
"configuration": {
"shank": {
"stones": 3,
"stone": [
{"sku":"sss", "shape":"rd", "weight":"k", "position":2},
{"sku":"dst", "shape":"rd", "weight":"k", "position":3},
{"sku":"fsa", "shape":"rd", "weight":"k", "position":1}
],
"metal": {
"sku": "f",
"color": "Y"
}
},
"engraving": [
"e0": {
"font": "satisfy",
"text": "ABC"
},
"e1": {
"font": "satisfy",
"text": "ABC"
}
]
},
}{
"method_id":1001,
"vendor_model": "REA150",
"configuration": {
"earring": {
"stones": 3,
"stone": [
{
"sku": "sss",
"shape": "rd",
"weight": "k",
"position": 2
},
{
"sku": "dst",
"shape": "rd",
"weight": "k",
"position": 3
},
{
"sku": "fsa",
"shape": "rd",
"weight": "k",
"position": 1
}
],
"metal": {
"sku": "f",
"color": "Y"
}
},
"engraving": [
"e0": {
"font": "satisfy",
"text": "ABC"
},
"e1": {
"font": "satisfy",
"text": "ABC"
}
]
}
}{
"method_id":1001,
"vendor_model": "RBR120",
"configuration": {
"bracelet": {
"stones": 3,
"stone": [
{
"sku": "sss",
"shape": "rd",
"weight": "k",
"position": 2
},
{
"sku": "dst",
"shape": "rd",
"weight": "k",
"position": 3
},
{
"sku": "fsa",
"shape": "rd",
"weight": "k",
"position": 1
}
],
"metal": {
"sku": "f",
"color": "Y"
},
"length": 16
},
"engraving": [
"e0": {
"font": "satisfy",
"text": "ABC"
},
"e1": {
"font": "satisfy",
"text": "ABC"
}
]
}
}Request example for simple rings and pendant:
Send to wss:
method_id: 1001 - get configuration
vendor_model - Product vendor model
To obtain configuration data it is necessary to transmit information about head and shank. All necessary information about available options can be obtained from REST request for data of a particular product.
For the head, the required parameters are type, central stone, additional stones, metal type, metal color
For a shank you need to choose the type, side settings, carving, metal and metal color.
{
"method_id": 1001,
"vendor_model": "RCR21",,
"configuration_id": "RDS1292-C1WQ-4WS"
"configuration": {
"head": {
"type": "HS4",
"center_stone": {
"sku": "DI",
"stone_shape": "RD",
"stone_weight": "F",
"stone_color": "W",
"stone_clarity": "SI2"
},
"additional_stones": {
"sku": "DI",
"stone_color": "W"
},
"metal": {
"sku": "F",
"color": "Y"
}
},
"shank": {
"type": "HS4",
"side_settings": {
"sku": "PS",
"length": "SL1",
"stone": "NO",
"stone_color": "U"
},
"carving": {
"sku": "CA0",
"length": "CL1"
},
"metal": {
"sku": "F",
"color": "Y"
}
},
"engraving": [
"e0": {
"font": "satisfy",
"text": "ABC"
},
"e1": {
"font": "satisfy",
"text": "ABC"
}
]
}
}
Response:
{
"status":"success",
"method_id":1001,
"error":0,
"message": {
"vendor_model": "RSD1292",
"ci": "RSD1282-1WFPR",
"layer": {
"l1": {
"v1": {
"x1": {
"https://domain.example/imagepath.png"
},
"x2":{
"https://domain.example/imagepath-X2.png"
}
},
"v2": {
"x1": {
"https://domain.example/imagepath.png"
},
"x2":{
"https://domain.example/imagepath-X2.png"
}
}
},
"l2": {
"v1": {
"x1": {
"https://domain.example/imagepath-V1.png"
},
"x2":{
"https://domain.example/imagepath-V1-X2.png"
}
},
"v2": {
"x1": {
"https://domain.example/imagepath-V2.png"
},
"x2":{
"https://domain.example/imagepath-V2-X2.png"
}
}
},
"l3": {
"v1": {
"x1": {
"https://domain.example/imagepath-V1.png"
},
"x2":{
"https://domain.example/imagepath-V1-X2.png"
}
},
"v2": {
"x1": {
"https://domain.example/imagepath-V2.png"
},
"x2":{
"https://domain.example/imagepath-V2-X2.png"
}
}
}
},
"price": 1111,
"description": "Configuration Description",
"title": "Configuration Title"
}
Message Description:
vendor_model - Product Vendor Model. Common product identifier that is in the system
ci - Configuration ID. This is a unique parameter that determines the selected type of current product based on the possible options for this.
layer - An object that contains links to configuration images. To get the full image of the selected configuration, you need to combine all the layers according to the order that was returned from the request. All images must be set to the same div in order from the beginning of l1 to lNin order from bottom to top, accordance with the desired view (v1). Example: https://static.wonderjewel.co/reeds2-front/catalog.php
"l1", "l2", "l3", etc. - Image layers for full Product Image
"v1", "v2", etc. - Image Views by view (Front view, Left, back)
"x1", "x2", etc. - Image Size (700x700px or 1400x1400px)
title - Configuration Title
description - Configuration Description
price - Configuration Price
Request for Bridal Product
{
"method_id": 1001,
"vendor_model": "RCR21",
"configuration": {
"head": {
"type": "HS4",
"center_stone": {
"sku": "DI",
"stone_shape": "RD",
"stone_weight": "F",
"stone_color": "W",
"stone_clarity": "SI2"
},
"additional_stones": {
"sku": "DI",
"stone_color": "W"
},
"metal": {
"sku": "F",
"color": "Y"
}
},
"shank": {
"type": "HS4",
"side_settings": {
"sku": "PS",
"length": "SL1",
"stone": "NO",
"stone_color": "U"
},
"carving": {
"sku": "CA0",
"length": "CL1"
},
"metal": {
"sku": "F",
"color": "Y"
}
}
}
}How it works
https://static.wonderjewel.co/reeds-simple/builder/RPDN20329
Add script below before </body> tag.
<script src="https://f7s3m8n7.stackpathcdn.com/libs/js/engraving/1.0/engraving.js"></script>
Un-minified script version:
<script src="https://f7s3m8n7.stackpathcdn.com/libs/js/unpacked/engraving.js"></script>
Init script, using next steps:
var options = {};
options.engraving = {OBJECT_FROM_PRODUCT_DATA};
options.imageDivId = "ID_OF_IMAGES_BLOCK";
options.textDivId = "ID_OF_TEXT_INPUT";
options.fontsSelector = "FONTS_RADIOBUTTON_CLASS"; - IMPORTANT: radiobutton should have the value="sku_of_font";
var engraving = new Engraving(options);
engraving.init();
Examples:
Engraving object from product data OBJECT_FROM_PRODUCT_DATA
"engraving": {
"enabled": 1,
"fonts": [
{
"sku": "handlee",
"title": "Handlee"
},
{
"sku": "satisfy",
"title": "Satisfy"
},
{
"sku": "charm",
"title": "Charm"
}
],
"options": {
"e0": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 25,
"radius": -600,
"angle": -0.02,
"posX": 335,
"posY": -147,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": true,
"minChar": 2,
"maxChar": 10,
"radius": -500,
"angle": -0.08,
"posX": 420,
"posY": -130,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
}
},
"e1": {
"s2": {
"show": true,
"minChar": 2,
"maxChar": 15,
"radius": 400,
"angle": 1.34,
"posX": 485,
"posY": 250,
"skewX": 0,
"skewY": 0
},
"s3": {
"show": false,
"minChar": 0,
"maxChar": 0,
"radius": 0,
"angle": 0,
"posX": 0,
"posY": 0,
"skewX": 0,
"skewY": 0
},
"s4": {
"show": true,
"minChar": 2,
"maxChar": 8,
"radius": 300,
"angle": -0.28,
"posX": 257,
"posY": -136,
"skewX": 0,
"skewY": 0
}
}
}
}
Images block ID_OF_IMAGES_BLOCK
<div class="imagesOuter" id="ID_OF_IMAGES_BLOCK">
<img id='layer0' src='' alt=''/>
<img id='layer1' src='' alt=''/>
<img id='layer2' src='' alt=''/>
</div>
Text input ID_OF_TEXT_INPUT
<input type='text' name="engraving-text" id='ID_OF_TEXT_INPUT'>
Radio buttons FONTS_RADIOBUTTON_CLASS sku_of_font
<input class="FONTS_RADIOBUTTON_CLASS" type="radio" id="font-1" name="fonts" value="sku_of_font">
<label for="font-1">Font 1</label>
<input class="FONTS_RADIOBUTTON_CLASS" type="radio" id="font-2" name="fonts" value="sku_of_font">
<label for="font-2">Font 2</label>
<input class="FONTS_RADIOBUTTON_CLASS" type="radio" id="font-3" name="fonts" value="sku_of_font">
<label for="font-3">Font 3</label>
Merge script
How it works
https://static.wonderjewel.co/merge-canvas/
Add script below before </body> tag.
<script src="https://f7s3m8n7.stackpathcdn.com/libs/js/mpi/1.0/mpi.js"></script>
Un-minified script version:
<script src="https://f7s3m8n7.stackpathcdn.com/libs/js/unpacked/mpi.js"></script>
To get a merged image, call method below:
mpi.getMergedImage(ID_OF_IMAGES_BLOCK)
ID_OF_IMAGES_BLOCK - ID of HTML Node that includes the product images and canvas engraving (optional)
Current method will return a merged image with the engraving canvas in base64 string
Examples
Images block ID_OF_IMAGES_BLOCK
<div class="imagesOuter" id="ID_OF_IMAGES_BLOCK">
<canvas id="engraving-canvas"></canvas>
<img id='layer1' src='' alt=''/>
<img id='layer2' src='' alt=''/>
</div>Engraving script
Initialize engraving script
Engraving object from product data
Images block
Text input
Radio buttons
Engraving script un-minified
Merge script
Merge script un-minified
Merge method call
Images block for merge
<script src="https://j4z2x5e8.stackpathcdn.com/libs/js/engraving/1.0/engraving.js"></script>var options = {};
options.engraving = {OBJECT_FROM_PRODUCT_DATA};
options.imageDivId = "ID_OF_IMAGES_BLOCK";
options.textDivId = "ID_OF_TEXT_INPUT";
options.fontsSelector = "FONTS_RADIOBUTTON_CLASS"; - IMPORTANT: radiobutton should have the value="sku_of_font"
var engraving = new Engraving(options);
engraving.init();"engraving": {
"enabled": 1,
"min_chars": 1,
"max_chars": 12,
"x": 75,
"y": 90,
"angle": 180,
"fonts": [
{
"sku": "Satisfy",
"title": "Satisfy"
}
]
}<div class="imagesOuter" id="ID_OF_IMAGES_BLOCK">
<img id='layer0' src='' alt=''/>
<img id='layer1' src='' alt=''/>
<img id='layer2' src='' alt=''/>
</div><input type='text' name="engraving-text" id='ID_OF_TEXT_INPUT'><input class="FONTS_RADIOBUTTON_CLASS" type="radio" id="font-1" name="fonts" value="sku_of_font">
<label for="font-1">Font 1</label>
<input class="FONTS_RADIOBUTTON_CLASS" type="radio" id="font-2" name="fonts" value="sku_of_font">
<label for="font-2">Font 2</label>
<input class="FONTS_RADIOBUTTON_CLASS" type="radio" id="font-3" name="fonts" value="sku_of_font">
<label for="font-3">Font 3</label><script src="https://f7s3m8n7.stackpathcdn.com/libs/js/unpacked/engraving.js"></script><script src="https://f7s3m8n7.stackpathcdn.com/libs/js/mpi/1.0/mpi.js"></script><script src="https://f7s3m8n7.stackpathcdn.com/libs/js/unpacked/mpi.js"></script>mpi.getMergedImage(ID_OF_IMAGES_BLOCK)<div class="imagesOuter" id="ID_OF_IMAGES_BLOCK">
<canvas id="engraving-canvas"></canvas>
<img id='layer1' src='' alt=''/>
<img id='layer2' src='' alt=''/>
</div>