+813-444-3589+44 118 328 3220+49-231-976765-0 | Kontakt

REST API

Currency Rates

The currency_rates resource can be used to retrieve current currency conversion rates.

What can you do with currency_rates?

The FlickRocket API lets you do the following with the currency_rates resource. More detailed versions of these general actions may be available:

GET /api/currency_rates.json

Receive a list of currencies with their conversion rate to EUR. This in turn can be used to also calculate the USD conversion rate.

currency_rates Properties

currency_rates

Array of currencies with values:

{
"date": "2017-09-19T00:00:00"

Date when the currency conversion rate was most recently updated.

"rate_to_eur": 4.3949

The conversion rate of thsi currency to EUR.

"currency": "AED"

The currency identifier.

}

 

 

Logging

The logging resource enables logging of data which can be reviewed in the admin interface.

What can you do with Logging?

The FlickRocket API lets you do the following with the logging resource. More detailed versions of these general actions may be available:

POST /api/logging.json

Takes a JSON which is stored server side and can be retried via the admin interface.

Fulfillment

The fulfillment resource represents fulfillment of orders. Every physical order is associated with a fulfillment.

The fulfillment resource can be used directly by shop owners and also by shipping partners on behalf of shop owners.

What can you do with Fulfillment?

The FlickRocket API lets you do the following with the fulfillment resource. More detailed versions of these general actions may be available:

GET /api/fulfillments.json

Receive a list of all order fulfillments of the current shop.

GET /api/fulfillments.json?created_at_min=2015-07-01T00:00:00&created_at_max=2015-07-02T00:00:00

Receive a list of order fulfillments of the current shop for orders made between 2017-07-01 to 2015-07-02.

GET /api/fulfillments/count.json

Receive the current shop's physical order count. 

GET /api/fulfillments/open.json

Receive a list of all order fulfillments of the current shop which are still open.

GET /api/fulfillments/complete.json

Receive a list of all completed order fulfillments.

GET /api/fulfillments/#{token}.json

Receive specific fulfillment identified by Order ID.

PUT /api/fulfillments/#{token}.json

Modify a specific fulfillment identified by Order ID.

 

Fulfillment Properties

created_at
"2014-07-02T13:25:26"

The date/time the order for this fulfilment was made.

customer

Customer data for shipment. 

{
"country_name":"United States of America"
"country_code":"US"
"default":true
"province_code":"California"
"province":"CA"
"name":"John Doe"
"id":15475
"first_name":"John"
"last_name":"Doe",
"company":""
"address1":"18914, Coast Street"
"address2":""
"zip":"77073"
"city":"Houston"
"token":"NNYAHQNTOAPYBNAK"
}
id
"105489"

The unique id of this fulfillment/order.

line_items

Array of line items for fulfillment

[{

"id":75501

The internal ID of this product.

"product_id":"0001-26ED-EA4F-AA32"

The long ID of the products as displayed in the admin interface

"title":"TheGoodFather"

The title of this product.

"version":"1.0"

The version of this product (if specified)

"Quantity":2

The ordered quantity of this product.

"gtin":""

The GTIN number of this product (if specified).

"weight":160 

The weight of the product in gram 

}]

owner_company
1212345

The company id of the company for which the shipping must be done.

status

100

0 = Not shipped / 100 = Shipped 

tracking_company
 "DHL"

The name of the shipping model (read-only).

tracking_number
"122ur4538ef29, 122fr4539gh27" 

The tracking number(s) for this fulfillment. Max. 64 characters.

tracking_url
"http://www.dhl.com/en/express/tracking.html"

The URL used for tracking this shipment (if possible) as defined in the selected shipping model (read only)

 

Marketplace

The marketplace resource represents the Flickrocket Marketplace. Every shop owner ca  make his content available in the Marketplace and other shop owners can add content from the Marketplace into their shops.

What can you do with Marketplace?

The FlickRocket API lets you do the following with the marketplace resource. More detailed versions of these general actions may be available:

GET /api/marketplace.json

Receive a list of all shop owners who offer their cotnent in the Marketplace.

GET /api/marketplace/#{market_id}.json

Receive all products offered under the Marketplace entry.

POST /api/marketplace/#{market_id}/add.json

Adds (but not activates) all products offered under the specified Marketplace entry to the current company.

POST /api/marketplace/#{market_id}/activate.json

Adds and activates all products offered under the specified Marketplace entry to the current company.

Marketplace Properties

company_logo
"https://admin.flickrocket.com/LogoPic.ashx?id=117"

The URL of the company logo.

company_name
"Great Content Inc."

The name of the company sharing content for this Marketplace entry.

cost_to_licensees_percent
10

The percentage which has to be paid to the original content owner per sale (based on the original price)

market_id

1023

Unique identifier for each Markeplace entry.

product_count
864

The number of products available in this Marketplace entry.

shop_description
"Shop Description DE"

The description of the shop sharing content for this Marketplace entry.

shop_icon
"http://admin-static.flickrocket.ak/GetImage/ShopIcon/MTM1MzI%3d" 

The URL of the sharing's shop icon.

shop_name
"Great content web shop"

The name of the shop sharing content for this Marketplace entry.

shop_url
"http://livedirect.liquid.ak"

URL pointing to the original shop from which the content is made available.

 

Price

The price resource represents prices of products. Every product must associated with at least one price/price per license to appear in the shop. 

What can you do with Price?

The FlickRocket API lets you do the following with the price resource. More detailed versions of these general actions may be available:

GET /api/prices.json

Receive a list of all price models defined for the company.

GET /api/prices/#{token}.json

Receive a single price model identified via token (Price ID). 

Price Properties

countries

Array of countries and corresponding price for the country (in cent)

[{

"country_name": "United Kingdom"

The name of the country

"country_code": "GB"

The country code of thsi country

"price": 19800

Price in cent for this country.

}]

created_at
"2014-07-02T13:25:26"

The date/time the price model was initially created.

currencies

Array of currencies the correspondig price for the currency (in cent)

[{

"currency": "eur"

Curency identifier

"price": 19800

Price in cent for the currency

}]

 id
 672

The unique id used to reference this price model

modified_at
"2015-08-02T16:22:21"

The last date/time the price model was modified.

title
"Default pricing for new items"

The name of the price model as shown in the admin interface.

valid
1

Set to 1 for valid price models. Set to 0 for invalid price models.

Get all prices

GET /api/prices.json
View Response

Receive a single price identified by Price ID token

GET /api/prices/#{token}.json
View Response

Receive a count of all prices

GET /api/prices/count.json
View Response