Please wait...

loading...

loading results

Integrating the Richard Cannon Jewelry product feed to your website

There are several ways you can access the product feed to integrate the product feeds onto your own website or market place. We have outlined the various methods below.

Using the Richard Cannon Jewelry Web Service


You can use the web service to download and consume the product feed programmatically by following the steps below. The advantage of this is having a live feed in place with updated inventory data instead of manually maintaining any updates to a product feed. You also have the option to consume the feed with your own custom titles and descriptions that you can provide in bulk via an excel sheet.

  1. Once you have created your product feed, copy the unique access key associated with the feed.
  2. Write a program that downloads the feed to your server and database.
  3. Version 4.0

  4. 3. Add a web service reference to your program by adding the following URL: http://rcjewelry.com/WebAPI4/ProductFeedVersion4.asmx
  5. 4. Use following methods to consume the feed,know the status of stock,related products items and similar products:
    • You need to get access token key to consume these methods. You can get access token key by login into Richard Cannon Jewelery then go to Account Setting Tab and get the token key in Web API AccessToken tab
    • Use the GenarateXML method to consume the feed in your program which will return response as XML string of list of inventory items.
      • Request
      • Response

      GenarateXML(tokenKey,accessKey)

      Element Description Format
      tokenKey Required.
      unique token key to consume product feed.
      8-character maximum
      accessKey Required.
      Merchant’s unique API Login ID.
      unique access key for your product feed
      32-character maximum.

      GenarateXML(tokenKey,accessKey)

      Element Description Format
      RCJXMLResponseType
      resultCode Overall Status Of response
      Ok Or Error
      Message Error Message or Success Message
      ResponseXmlString XML string of list of inventory items
    • Use the GenerateXMLForAllProducts method to get list Of inventory items with status of product like out of stock,In stock .
      • Request
      • Response

      GenerateXMLForAllProducts(tokenKey,accessKey,isAllProducts)

      Element Description Format
      tokenKey Required.
      unique token key to consume product feed.
      8-character maximum
      accessKey Required.
      Merchant’s unique API Login ID.
      unique access key for your product feed
      32-character maximum.
      isAllProducts
      value should be true or false .

      GenerateXMLForAllProducts(tokenKey,accessKey,isAllProducts)

      Element Description Format
      RCJXMLResponseType
      resultCode Overall Status Of response
      Ok Or Error
      Message Error Message or Success Message
      ResponseXmlString XML string of list of inventory items with status of each product
    • Use the GenerateOutOfStock method to get recently affected product items .
      • Request
      • Response

      GenerateOutOfStock(tokenKey)

      Element Description Format
      tokenKey Required.
      unique token key to consume Method.
      8-character maximum

      GenerateOutOfStock(tokenKey)

      Element Description Format
      RCJOutOfStockResponseType
      resultCode Overall Status Of response
      Ok Or Error
      Message Error Message or Success Message
      RCJProductStockStatusEntityList list of product items with information like stockno,price,itemtitle,imageurl and status of each product
    • Use the GenerateOutOfStockWithFilter method to get recently affected product items based on given filter.
      • Request
      • Response

      GenerateOutOfStockWithFilter(tokenKey,FilterToken)

      Element Description Format
      tokenKey Required.
      unique token key to consume Methodd.
      8-character maximum
      FilterToken Required.
      Filter Token like OUTOFSTOCK OR DISCONTINUED OR BACKINSTOCK.

      GenerateOutOfStockWithFilter(tokenKey,FilterToken)

      Element Description Format
      RCJOutOfStockResponseType
      resultCode Overall Status Of response
      Ok Or Error
      Message Error Message or Success Message
      RCJProductStockStatusEntityList list of product items with information like stockno,price,itemtitle,imageurl and status of each product based on filter token
    • Use the GenerateOutOfStockWithDateFilter method to get recently affected product items based on given filter and date range.
      • Request
      • Response

      GenerateOutOfStockWithFilter(tokenKey,FilterToken,fromDate,toDate)

      Element Description Format
      tokenKey Required.
      unique token key to consume Method.
      8-character maximum
      FilterToken Filter Token like OUTOFSTOCK OR DISCONTINUED OR BACKINSTOCK.
      fromDate Required.
      start date .
      Should be in Date Format
      toDate Required.
      End date .
      Should be in Date Format

      GenerateOutOfStockWithFilter(tokenKey,FilterToken,fromDate,toDate)

      Element Description Format
      RCJOutOfStockResponseType
      resultCode Overall Status Of response
      Ok Or Error
      Message Error Message or Success Message
      RCJProductStockStatusEntityList list of product items with information like stockno,price,itemtitle,imageurl and status of each product based on filter token and date range
    • Use the GetStockStatus method to get status of perticular like out of stock,in stock and discontinued.
      • Request
      • Response

      GetStockStatus(tokenKey,StockNumber)

      Element Description Format
      tokenKey Required.
      unique token key to consume method.
      8-character maximum
      StockNumber RCJ Stock number like XXXXX or XXXXX-X.
      8-character maximum

      GetStockStatus(tokenKey,StockNumber)

      Element Description Format
      RCJStockStatusResponseType
      resultCode Overall Status Of response
      Ok Or Error
      Message Error Message or Success Message
      RCJStockStatus product item with information like stockno,itemtitle and status of product
    • Use the GenerateRelatedProducts method to get list of related products for given stock number.
      • Request
      • Response

      GenerateRelatedProducts(tokenKey,StockNumber)

      Element Description Format
      tokenKey Required.
      unique token key to consume method.
      8-character maximum
      StockNumber RCJ Stock number like XXXXX or XXXXX-X.
      8-character maximum

      GenerateRelatedProducts(tokenKey,StockNumber)

      Element Description Format
      RCJRelatedProdcutsResponseType
      resultCode Overall Status Of response
      Ok Or Error
      Message Error Message or Success Message
      RCJRelatedProductsList list of related product items with information like stockno,itemtitle,category,price and status of each product for given stock number
    • Use the GenerateSimilarProducts method to get list of similar products for given stock number.
      • Request
      • Response

      GenerateSimilarProducts(tokenKey,StockNumber)

      Element Description Format
      tokenKey Required.
      unique token key to consume method.
      8-character maximum
      StockNumber RCJ Stock number like XXXXX or XXXXX-X.
      8-character maximum

      GenerateSimilarProducts(tokenKey,StockNumber)

      Element Description Format
      RCJSimilarProductsResponseType
      resultCode Overall Status Of response
      Ok Or Error
      Message Error Message or Success Message
      RCJSimilarProductsList list of similar product items with information like stockno,itemtitle,category,price and status of each product for given stock number

Order Placement via API


You can use this API to programmatically place your orders.

  • Request
  • Response

Create order


POST https://www.rcjewelry.com/OrderAPI/Order.aspx HTTP/1.1
Host: https://www.rcjewelry.com/
Content-Type: application/json
Cache-Control: no-cache

{
"requestType":"CREATE",
"tokenKey":"XXXXXXX",
"PO_Number":"PO23655",
"OrderDate":"2017-05-01",
"OrderDetails":
[
{
"StockNo":"XXXXX-XX",
"Quantity":1,
"JBoxQty":0
},
{
"StockNo":"XXXXX-XX",
"Quantity":1,
"JBoxQty":1
}
],
"BillingAddress":
[
{
"FirstName":"Richard",
"LastName":"Canon",
"AddressLine1":"130 West Pleasant",
"AddressLine2":"Avenue",
"City":"Banglore",
"CompanyName":"RCJ",
"State":"NJ",
"ZipCode":"XXXXX",
"Country":"US",
"PhoneNo":"XXX-XXX-XXXX"
}
],
"ShippingAddress":
[
{
"FirstName":"Richard",
"LastName":"Canon",
"AddressLine1":"130 West Pleasant",
"AddressLine2":"Avenue",
"City":"Banglore",
"CompanyName":"RCJ",
"State":"NJ",
"ZipCode":"XXXXX",
"Country":"US",
"PhoneNo":"XXX-XXX-XXXX"
}
],
"PaymentMethodList":
[
{
"ProfileName":"XXXXXX",
"PaymentType":"CREDITCARD"
}
],
"OrderNotes":"any custom notes about order",
"ShippingMethod":"1",
"OrderUploadFiles":
[
{
"DocumentType":"Invoice",
"FileContent":"file",
"FileExtenesion":"pdf"
},
{
"DocumentType":"Shipping Carrier Label",
"FileContent":"file",
"FileExtenesion":"txt"
},
{
"DocumentType":"General Note",
"FileContent":"file",
"FileExtenesion":"jpg"
}
]
}


Element Description Format Valid Values
requestType Required.
Request Tyoe
8-character maximum
Valid values for type request are
1.CREATE: create a new order
2.BYORDERNO: Get order status by Order number
3.BYPONUMBER: Get order status by PO Number
tokenKey Required.
Your account token key for API requests, available under account settings
8-character maximum
PO_Number Required.
Retailer PO Number
20-character maximum.
OrderDate Optional.
Order date in the format "YYYY-MM-DD".
10-character maximum
OrderNotes Optional.
Any additional notes to the supplier
200-character length
ShippingMethod Required.
Preferred Shipping Carrier ID
1-character length
Valid Shipping Methods accepted by RCJ
Id Name Type
1 I will use my own carrier and upload a label Domestic and International
14 USPS 1st Class Mail (Only available for orders under $200. Tracking Number Provided-No Signature Required-3 to 5 Day Delivery) Domestic
25 USPS 1st Class Mail With Signature Domestic
19 USPS Priority Mail(Only available for orders under $400. Tracking Number Provided-No Signature Required-1 to 3 Day Delivery) Domestic
26 USPS Priority Mail With Signature Domestic
3 UPS 2nd Day Domestic
7 UPS Overnight Domestic
20 USPS International First Class Mail (7 to 21 day delivery depending on country-Tracking number provided-Only available for orders under $300) International
23 USPS Priority International (Only available for orders under $400-Tracking number provided) International
24 USPS Priority Mail Express International (Tracking number provided) International
2 UPS International (1-5 day delivery) International
OrderDetails
StockNo Required.
RCJ Stock number like XXXXX or XXXXX-X.
8-character maximum
Quantity Required.
Specify no of items you need to place an order.
Integer number
Valid values like 1,2 etc
JBoxQty Optional.
Specify no of gift box items you need to place with an order.
Integer number
Valid values like 1,2 etc
PaymentMethodList
ProfileName Required.
Saved card profile name for credit card payment
150-character maximum
PaymentType Required.
specify the type of payment.
Valid Values are CREDITCARD,BANKWIRE
BillingAddress
FirstName Required.
Billing first name.
50-character length
LastName Required.
Billing last name.
50-character length
AddressLine1 Required.
Billing address.
100-character length
AddressLine2 Optional.

100-character length
City Required.

100-character length
CompanyName Required.

100-character length
State Required.

2-character length
ZipCode Required.

10-character length
Country Required.
The customer's normalized country name.
50-character length
ZipCode Required.
The customer's zip or postal code.
10-character length
PhoneNo Required.

20-character length
ShippingAddress
FirstName Required.
Shippingfirst name
50-character length
Shipping LastName Required.

50-character length
AddressLine1 Required.
The customer's mailing address.
100-character length
AddressLine2 Optional.

100-character length
City Required.

100-character length
CompanyName Required.

100-character length
State Required.

2-character length
ZipCode Required.

10-character length
Country Required.

50-character length
ZipCode Required.
The customer's zip or postal code.
10-character length
Valid formats can be of different types, for example:XXXX-XXXX,XXXXXXX
PhoneNo Required.
The customer's phone number for this mailing address..
20-character length
Valid formats can be of different types, for example:XXX-XXX-XXXX
OrderUploadFiles
DocumentType Required.
Specify type of document.
30-character maximum
valid values for Document type are
Invoice
Shipping Carrier Label
General Note
FileContent Required.
base64 byte String data.
File Size should not exceed 2MB
Valid values like 1,2 etc
FileExtenesion Required.
Extension of file .
5-character maximum
Valid values like
pdf
jpg
doc
docx
txt

Response

HTTP/1.1 200 Accepted
Content-Type: application/json; charset=utf-8
{
"resultCode": "Success",
"Message": "Order << Order No>> Created Successfully "
}

Element Description Format
resultCode Overall Status Of response
Success Or Error
Message Error Message or Success Message

Get order status by Order number.

  • Request
  • Response

get order status by Order number


POST /OrderAPI/Order.aspx HTTP/1.1
Host: https://www.rcjewelry.com/
Content-Type: application/json
Cache-Control: no-cache

{
"requestType":"BYORDERNO",
"tokenKey":"XXXXXXXX",
"OrderNo":"XXXXX",
}


Element Description Format Valid Values
requestType Required.
type of request for order API.
8-character maximum
Valid values for type request are
1.CREATE: to create a new order
2.BYORDERNO:get order status by Order number
3.BYPONUMBER:get order status by PO Number
tokenKey Required.
unique token key to reuest order API.
8-character maximum
OrderNo Required.
RCJ Order Number.

Response

HTTP/1.1 200 Accepted
Content-Type: application/json; charset=utf-8
{
"orderNo": "XXXXX",
"trackingNo": "XXXXX"
"PONumber": "PO1234",
"orderStatus": "Complete"
"OrderDate": "7/13/2017"
}

Element Description Format
orderNo RCJ Order number
trackingNo Tracking number
orderStatus Order Status like Pending,Complete,Confirmed,Shipped
OrderDate order placed date.

Get order status by PO Number.

  • Request
  • Response

get order status by PO number


POST https://www.rcjewelry.com/OrderAPI/Order.aspx
Host:https://www.rcjewelry.com/
Content-Type: application/json
Cache-Control: no-cache

{
"requestType":"BYPONUMBER",
"tokenKey":"XXXXXXX",
"PO_Number":"PO1234",
}


Element Description Format Valid Values
requestType Required.
Request Type
8-character maximum
Valid values for type request are
1.CREATE: to create a new order
2.BYORDERNO:get order status by Order number
3.BYPONUMBER:get order status by PO Number
tokenKey Required.
unique token key to reuest order API.
8-character maximum
PO_Number Required.
Retailer Purchase OrderNo. (PO#).

Response

HTTP/1.1 200 Accepted
Content-Type: application/json; charset=utf-8
{
"orderNo": "XXXXX",
"trackingNo": "XXXX"
"PONumber": "PO1234",
"orderStatus": "Complete"
"OrderDate": "7/13/2017"
}

Element Description Format
orderNo RCJ Order number
trackingNo Tracking number
orderStatus Order Status like Pending,Complete,Confirmed,Shipped
OrderDate order placed date.