Joom

API Reference

Introduction

The Joom merchant platform is an ecommerce platform. It allows merchants to upload and manage inventory for sale on Joom. The platform is intended to be full-featured so merchants can manage their inventory, fulfill orders and handle customer issues.

This API is intended to be a fully programmable alternative to the GUI version of this platform. However, it is a work in progress and is constantly being updated with new features.

The best way to get started using this API is to read through this section and then visit the User Guide section. If you're too excited and need to start now please visit the Quick Start Guide.

Versioning

This is the V2 and current version of the Joom For Merchants API.

Date/Time Format

All dates and times in our API are always in UTC unless otherwise mentioned.

Authentication

Joom uses the OAuth 2.0 specification to authenticate your requests. For a detailed guide on how to authenticate, read our documentation.

Every request will need to be authenticated with an access token. When making requests, provide the access token as a GET or POST request parameter:

ParameterTypeExample
access_tokenstring
"1qaz2wsx3edc4rfv5tgb"

Alternatively, the access token can be included in the header in this format:

"Authorization: Bearer {access_token}"

Requests must be made over HTTPS. Any call made over HTTP will be rejected.

Response Scheme

Every response returned from the Joom API will have the same schema. This schema is intended to give you a predictable manner to check the status of your request and know where to get the data.

Scheme Attributes
NameDescription
codeContains the status code for the request, 0 means success and any other number implies a failure.
dataThis attribute will store the response data that was requested.
messageSometimes will store a human readable status message to aid in debugging. It is generally used only for errors.
pagingIf the number of results exceeds the limit for the request, this parameter will aid the client in paging to collect all the results.

Response Formats

This API can return results in either JSON or XML. To specify the format you would like your response in, include the format parameter in your GET or POST request. This parameter is optional and defaults to JSON.

ParameterTypeRequiredDefaults
format"xml"|"json"No"json"

API Errors

The Joom API returns specific error data back to the client in the event of an error. Please see table below for attribute descriptions.

Error Attributes
NameTypeDescriptionExample
codenumberA unique number which represents the error that has occurred4001
typestringA unique human readable representation of the error"not_found"
messagestringA message describing the error that happened"We could not find a product \
for id: 'aaa'"
dataObjectFor most errors this will be empty.

Example Request

> curl https://api-merchant.joom.it/api/v2/order/fulfill-one -d "tracking_provider=USPSSSSSSSSSSSSSSSSSSSSSSSSS&tracking_number=12345679&id=098765432112345678901234&access_token=an_example_access_token"

Example Response

{
  "message": "Tracking provider is not one of the accepted providers on Joom",
  "code": 1000,
  "data": 2003
}

HTTP Status Codes

As well as using specific error codes in the event of an error, this API tries to conform to conventional HTTP response codes to indicate success or failure. Any response code of the form 2xx is generally considered successful. A status code of 4xx means that there was an error with the inputs. Any code in the 5xx range means that the server experienced an unexpected error and means we screwed up!

The HTTP status code should be used as a quick reference, but to get specific details please refer to the error code provided in the response.

Pagination

For performance reasons it is necessary for this API to limit the number of results returned in each request. This limit varies per request, but there is always an upper bound on the number of items returned in any response. In the case that the number of results is too large, you may page through all the results with multiple requests.

If the results must be paginated the paging attribute will exist in the response. This attribute will contain next and prev which are URLs for fetching the next (or previous) page of data.

Example

Note: access token and format have been removed from the URLs for brevity.

{
  "code": 0,
  "data": [/* results will be here */],
  "message": "",
  "paging": {
    "next": "https://api-merchant.joom.it/api/v2/product/multi-get?start=20&limit=10",
    "prev": "https://api-merchant.joom.it/api/v2/product/multi-get?start=10&limit=10"
  }
}

How to Debug

When API errors, it'll still return a JSON or XML response. The response contains information on exactly what caused the error.

For more information, check out API Errors

Example Request

> curl https://api-merchant.joom.it/api/v2/order/fulfill-one -d "tracking_provider=USPSSSSSSSSSSSSSSSSSSSSSSSSS&tracking_number=12345679&id=098765432112345678901234&access_token=an_example_access_token"

Example Response

{
  "message": "Tracking provider is not one of the accepted providers on Joom",
  "code": "1000",
  "data": "2003"
}

Debugging

USPSSSSSSSSSSSSSSSSSSSSSSSSS is not a shipping provider, to fix, change it to USPS.

Example Request 2

> curl https://api-merchant.joom.it/api/v2/order/fulfill-one -d "tracking_provider=USPS&tracking_number=12345679&id=098765432112345678901234&access_token=an_example_access_token"

Example Response 2

{
  "code": 0,
  "data": {
    "success": "True"
  },
  "message": "Your order is been processed right now!"
}

FAQ (Frequently Asked Questions)

Here are some quick code snippets that are commonly used to get you started.

How do I update price of a product?

Update price of a product:

> curl https://api-merchant.joom.it/api/v2/variant/update -d "sku=productsku&access_token=an_example_access_token&price=12.3"

How do I update inventory of a product?

Update inventory of a product:

> curl https://api-merchant.joom.it/api/v2/variant/update -d "sku=productsku&access_token=an_example_access_token&inventory=100"

How do I enable/disable a product?

Enable/disable product:

> curl https://api-merchant.joom.it/api/v2/product/enable -d "id=productid312&access_token=an_example_access_token"

How do I get all products?

Fetch all products:

> curl https://api-merchant.joom.it/api/v2/product/multi-get?access_token=an_example_access_token&start=0&count=500
> curl https://api-merchant.joom.it/api/v2/product/multi-get?access_token=an_example_access_token&start=500&count=500
> curl https://api-merchant.joom.it/api/v2/product/multi-get?access_token=an_example_access_token&start=1000&count=500

How do I get all orders?

Fetch all orders:

> curl https://api-merchant.joom.it/api/v2/order/multi-get?access_token=an_example_access_token&start=0&count=50
> curl https://api-merchant.joom.it/api/v2/order/multi-get?access_token=an_example_access_token&start=50&count=100
> curl https://api-merchant.joom.it/api/v2/order/multi-get?access_token=an_example_access_token&start=100&count=150

Quick Start Guide

We encourage you to skim through the section above to get an understanding about the fundamentals of this API. If you simply cannot wait, we hope this will get you started.

Get Your Access Token

Every request made must have an access token in the request. This token is used for authentication so please keep it a secret.

To obtain an access token, please visit this guide.

Test Authentication

Now that you have your access token you can test it by making a simple test request to the API and ensuring it works.

Assume your access token is an_example_access_token, you can now make a GET request to the following API to test your authentication:

> curl https://api-merchant.joom.it/api/v2/auth_test?access_token=an_example_access_token

Product

The product entity represents an item that is for sale on Joom. Each product can have multiple variations comprised of different sizes and colors. Each product has at least one product variation. Product variations, not products, are purchased by users. Each product contains multiple related SKUs.

With this API you can create, and update products. You can also retrieve one or many of your products.

Product Attributes
NameDescription
idThe Joom ID of the product
brandBrand or manufacturer of your product
date_uploadedDate when product was created
descriptionA detailed description of your product
enabledIf true, this product is eligible for sale
extra_imagesURL of all extra images of the product, separated by the character |
is_promotedIf true, this product is promoted
landing_page_urlURL on your website containing the product details
main_imageURL of the main image of the product
nameThe name which you have given the product
number_savesNumber of times this product has been added to favourite list
number_soldNumber of sales this product has received
original_image_urlURL of the original image when product was created
parent_skuYour unique identifier for the product
review_noteThe note when the product marked as rejected
review_statusOur review status of the product. This value can be: "approved", "pending", "rejected"
tagsNon-hierarchical keyword or term assigned to each product in your feed
upc12-digit Universal Product Codes (UPC)
variantsA list of Product Variation entities

List of Accepted Colors

Abyss #002c5c
Acid Blue
Acid Green #b0bf1a
Aero #7cb9e8
Aero Blue #c9ffe5
African Purple
Air Force Blue #5d8aa8
Alabama Crimson #af002a
Alaska Blue
Alice Blue #f0f8ff
Alizarin Crimson #e32636
Alloy Orange #c46210
Almond #efdecd
Amaranth #e52b50
Amaranth Pink #f19cbb
Amarillo
Amazon #3b7a57
Amber #ffbf00
Amber Gold
Ambrosial Crush
American Rose
Amethyst #9966cc
Android Green #a4c639
Anti-Flash White #f2f3f4
Antique Black
Antique Brass #cd9575
Antique Bronze #665d1e
Antique Fuchsia #915c83
Antique Gold
Antique Ruby #841b2d
Antique Silver
Antique White #faebd7
Apple Green #8db600
Apricot #fbceb1
Aqua #00ffff
Aqua Blue
Aquamarine #7fffd4
Arctic Blue
Army Green #4b5320
Arsenic #3b444b
Arylide Yellow #e9d66b
Ash Black
Ash Grey #b2beb5
Asparagus #87a96b
Asphalt
Atomic Tangerine #ff9966
Auburn #a52a2a
Aureolin #fdee00
AuroMetalSaurus #6e7f80
Avocado #568203
Azure #f0ffff
Azure Mist #f0ffff
B'dazzled Blue #2e5894
Baby Doll
Baby Blue #89cff0
Baby Blue Eyes #a1caf1
Baby Pink #f4c2c2
Baby Powder #fefefa
Baker-Miller Pink #ff91af
Ball Blue #21abcd
Banana Mania #fae7b5
Banana Yellow #ffe135
Barbie Pink #e0218a
Barn Red #7c0a02
Battleship Grey #848482
Bazaar #98777b
Beau Blue #bcd4e6
Beaver #9f8170
Beige #f5f5dc
Berry
Big Dip o'Ruby #9c2542
Birch
Bisque #ffe4c4
Bistre #3d2b1f
Bistre Brown #967117
Bitter Lemon #cae00d
Bitter Lime #bfff00
Bittersweet #fe6f5e
Bittersweet Shimmer #bf4f51
Black #323232
Black Bean #3d0c02
Black Brown
Black Fuchsia
Black Gray
Black Leather Jacket #253529
Black Olive #3b3c36
Black White
Black-Purple
Blanched Almond #ffebcd
Blast-Off Bronze #a57164
Bleu de France #318ce7
Blizzard Blue #ace5ee
Blond #faf0be
Blue #0086ff
Blue Bell #a2a2d0
Blue Chocolate
Blue Light Wash
Blue Sapphire
Blue Wash
Blue Yonder
Blue-Cream
Blue-Gray #6699cc
Blue-Green #0d98ba
Blue-Violet #8a2be2
Blueberry #4f86f7
Bluebonnet #1c1cf0
Blush #de5d83
Bole #79443b
Bondi Blue #0095b6
Bone #e3dac9
Bottle Green #006a4e
Boysenberry #873260
Brandeis Blue #0070ff
Brass #b5a642
Brick Red #cb4154
Bright Blue
Bright Cerulean #1dacd6
Bright Green #66ff00
Bright Lavender #bf94e4
Bright Maroon #c32148
Bright Navy Blue #1974d2
Bright Orange
Bright Pink #ff007f
Bright Red
Bright Turquoise #08e8de
Bright Ube #d19fe8
Brilliant Lavender #f4bbff
Brilliant Rose #ff55a3
Brink Pink #fb607f
British Racing Green #004225
Bronze #cd7f32
Bronze Yellow #737000
Brown #a52a2a
Brown Sugar #af6e4d
Brown-Cream
Brown-Nose #6b4423
Brunswick Green #1b4d3e
Bubble Gum #ffc1cc
Bubblegum Pink
Bubbles #e7feff
Bud Green #7bb661
Buff #f0dc82
Bulgarian Rose #480607
Burgundy #800020
Burgundy Metallic
Burgundy Pearl
Burlywood #deb887
Burnt Orange #cc5500
Burnt Sienna #e97451
Burnt Umber #8a3324
Byzantine #bd33a4
Byzantium #702963
CG Blue #007aa5
CG Red #e03c31
Cadet #536872
Cadet Blue #5f9ea0
Cadet Grey #91a3b0
Cadmium Green #006b3c
Cadmium Orange #ed872d
Cadmium Red #e30022
Cadmium Yellow #fff600
Cafe
Cal Poly Green #1e4d2b
Calm
Cambridge Blue #a3c1ad
Camel #c19a6b
Camel Brown
Cameo Pink #efbbcc
Camouflage
Camouflage Green #78866b
Canary Yellow #ffef00
Candy Apple Red #ff0800
Candy Pink #e4717a
Capri #00bfff
Caput Mortuum #592720
Carbon Fiber Black
Cardinal #c41e3a
Caribbean Green #00cc99
Carmine #960018
Carmine Pink #eb4c42
Carmine Red #ff0038
Carnation Pink #ffa6c9
Carnelian #b31b1b
Carolina Blue #56a0d3
Carrot Orange #ed9121
Castleton Green #00563f
Catalina Blue #062a78
Catawba #703642
Cedar Chest #c95a49
Ceil #92a1cf
Celadon #ace1af
Celadon Blue #007ba7
Celadon Green #2f847c
Celery Green
Celeste #b2ffff
Celestial Blue #4997d0
Cerise #de3163
Cerise Pink #ec3b83
Cerulean #007ba7
Cerulean Blue #2a52be
Cerulean Frost #6d9bc3
Chamoisee #a0785a
Champagne #f7e7ce
Champagne-Orange
Charcoal #36454f
Charleston Green #232b2b
Charm Pink #e68fac
Chartreuse #7fff00
Checkered Red
Checkered White
Cheddar Yellow
Cheers
Cheetah
Cheetah Print
Cherry #de3163
Cherry Pink
Cherry Blossom Pink #ffb7c5
Chestnut #954535
China Pink #de6fa1
China Rose #a8516e
Chinese Red #aa381e
Chinese Violet #856088
Chocolate #d2691e
Chocolate Brown #7b3f00
Chrome Yellow #ffa700
Cinereous #98817b
Cinnabar #e34234
Cinnamon #d2691e
Citrine #e4d00a
Citron #9fa91f
Claret #7f1734
Classic Rose #fbcce7
Clear
Clear Beige
Clear Blue
Clear Gray
Clear Green
Clear Green Pearl
Clear Pink
Clear Pink Pearl
Cobalt
Cocoa
Cocoa Bean
Cocoa Brown #d2691e
Coconut #965a3e
Coffee #ae8264
Coffee Bean Silver Pink
Columbia Blue #c4d8e2
Congo Pink #f88379
Cool Black #002e63
Cool Grey #8c92ac
Cool White
Copper #b87333
Copper Penny #ad6f69
Copper Red #cb6d51
Copper Rose #996666
Coquelicot #ff3800
Coral #ff7f50
Coral Green
Coral Pink #f88379
Coral Red #ff4040
Cordovan #893f45
Corn #fbec5d
Cornell Red #b31b1b
Cornflower Blue #6495ed
Cornsilk #fff8dc
Cosmic Latte #fff8e7
Cotton Candy #ffbcd9
Cream #fffdd0
Crimson #dc143c
Crimson Glory #be0032
Crystal Ball
Crystal Clear
Cyan #00ffff
Cyber Grape #58427c
Cyber Yellow #ffd300
Daffodil #ffff31
Dahlia
Dandelion #f0e130
Dark Army Green
Dark Blond
Dark Blue #00008b
Dark Blue Pearl
Dark Blue-Gray #666699
Dark Blue-Silver Grey
Dark Blue-Sky Blue
Dark Brown #654321
Dark Brown-Army Green
Dark Brown-Black
Dark Byzantium #5d3954
Dark Candy Apple Red #a40000
Dark Cerulean #08457e
Dark Chestnut #986960
Dark Coffee
Dark Coral #cd5b45
Dark Cyan #008b8b
Dark Electric Blue #536878
Dark Goldenrod #b8860b
Dark Gray #a9a9a9
Dark Green #006400
Dark Grey #a9a9a9
Dark Imperial Blue #00416a
Dark Jungle Green #1a2421
Dark Khaki #bdb76b
Dark Lava #483c32
Dark Lavender #734f96
Dark Liver #534b4f
Dark Magenta #8b008b
Dark Midnight Blue #003366
Dark Moss Green #4a5d23
Dark Olive Green #556b2f
Dark Orange #ff8c00
Dark Orchid #9932cc
Dark Pastel Blue #779ecb
Dark Pastel Green #03c03c
Dark Pastel Purple #966fd6
Dark Pastel Red #c23b22
Dark Pink #e75480
Dark Plum
Dark Powder Blue #003399
Dark Purple #301934
Dark Raspberry #872657
Dark Red #8b0000
Dark Red-Army Green
Dark Red-Black
Dark Salmon #e9967a
Dark Scarlet #560319
Dark Sea Green #8fbc8f
Dark Sienna #3c1414
Dark Sky Blue #8cbed6
Dark Slate Blue #483d8b
Dark Slate Gray #2f4f4f
Dark Spring Green #177245
Dark Tan #918151
Dark Tangerine #ffa812
Dark Taupe #483c32
Dark Terra Cotta #cc4e5c
Dark Turquoise #00ced1
Dark Vanilla #d1bea8
Dark Violet #9400d3
Dark Yellow #9b870c
Dartmouth Green #00703c
Davy's Grey #555555
Debian Red #d70a53
Deep
Deep Space Sparkle #4a646c
Deep Taupe #7e5e60
Deep Tuscan Red #66424d
Deep Carmine #a9203e
Deep Carmine Pink #ef3038
Deep Carrot Orange #e9692c
Deep Cerise #da3287
Deep Champagne #fad6a5
Deep Chestnut #b94e48
Deep Coffee #704241
Deep Fuchsia #c154c1
Deep Jungle Green #004b49
Deep Lemon #f5c71a
Deep Lilac #9955bb
Deep Magenta #cc00cc
Deep Mauve #d473d4
Deep Moss Green #355e3b
Deep Peach #ffcba4
Deep Pink #ff1493
Deep Ruby #843f5b
Deep Saffron #ff9933
Deep Sky Blue #00bfff
Deer #ba8759
Denim #1560bd
Denim Blue #2243b6
Desert #c19a6b
Desert Sand #edc9af
Desire #ea3c53
Diamond #b9f2ff
Dim Gray #696969
Dinar
Dirt #9b7653
Dodger Blue #1e90ff
Dogwood Rose #d71868
Dollar Bill #85bb65
Donkey Brown #664c28
Drab #967117
Dreamscape
Duke Blue #00009c
Dust Storm #e5ccc9
Dutch White #efdfbb
Earth
Earth Yellow #e1a95f
Ebony #555d50
Ecru #c2b280
Eggplant #614051
Eggshell #f0ead6
Egyptian Blue #1034a6
Electric Blue #7df9ff
Electric Crimson #ff003f
Electric Cyan #00ffff
Electric Green #00ff00
Electric Indigo #6f00ff
Electric Lavender #f4bbff
Electric Lime #ccff00
Electric Purple #bf00ff
Electric Ultramarine #3f00ff
Electric Violet #8f00ff
Electric Yellow #ffff33
Emerald #50c878
Eminence #6c3082
Emotion
English Green #1b4d3e
English Lavender #b48395
English Red #ab4b52
English Violet #563c5c
Eton Blue #96c8a2
Eucalyptus #44d7a8
Fabulous
Fallow #c19a6b
Falu Red #801818
Fandango #b53389
Fandango Pink #de5285
Fashion Fuchsia #f400a1
Fawn #e5aa70
Feldgrau #4d5d53
Feldspar #fdd5b1
Fern green #4f7942
Ferrari Red #ff2800
Field Drab #6c541e
Fire Engine Red #ce2029
Firebrick #b22222
Flame #e25822
Flame Red-Light Khaki
Flamingo Pink #fc8eac
Flat Dark Earth
Flattery #6b4423
Flavescent #f7e98e
Flax #eedc82
Flirt #a2006d
Floral
Floral Print
Floral White #fffaf0
Fluorescence Green
Fluorescent Blue
Fluorescent Green
Fluorescent Orange #ffbf00
Fluorescent Pink #ff1493
Fluorescent Rose
Fluorescent Yellow #ccff00
Flush
Folly #ff004f
Forest Camouflage #228b22
Forest Green #228b22
French Beige #a67b5b
French Bistre #856d4d
French Blue #0072bb
French Lilac #86608e
French Lime #9efd38
French Mauve #d473d4
French Puce #4e1609
French Raspberry #c72c48
French Rose #f64a8a
French Sky Blue #77b5fe
French Wine #ac1e44
Fresh Air #a6e7ff
Frost White
Fuchsia #ff00ff
Fuchsia Pink #ff77ff
Fuchsia Rose #c74375
Fuchsia-Black
Fulvous #e48400
Fushcia #ff00ff
Fuzzy Wuzzy #cc6666
Gainsboro #dcdcdc
Gamboge #e49b0f
Garnet
Generic Viridian #007f66
Ghost White #f8f8ff
Giants Orange #fe5a1d
Ginger #b06500
Giraffe
Glaucous #6082b6
Glistening Sun
Glitter #e6e8fa
Gold #ffd700
Gold Fusion
Golden
Golden Brown #996515
Golden Poppy #fcc200
Golden Yellow #ffdf00
Goldenrod #daa520
Goldfish
Goldmine
Gradient Black
Granny Smith Apple #a8e4a0
Grape #6f2da8
Grass Green
Gray #e7e7e7
Gray-Asparagus #465945
Gray-Blue #8c92ac
Green #35b630
Green Apple
Green Light
Green Pearl
Green Plaid
Green-Yellow #adff2f
Grey #e7e7e7
Grey White
Greyish White
Grullo #a99a86
Guppie Green #00ff7f
Han Blue #446ccf
Han Purple #5218fa
Hansa Yellow #e9d66b
Harlequin #3fff00
Harvard Crimson #c90016
Harvest Gold #da9100
Heart Gold #808000
Heather Gray
Heather Grey
Heliotrope #df73ff
Highlight
Hollywood Cerise #f400a1
Honey
Honeydew #f0fff0
Honolulu Blue #006db0
Hot Magenta #ff1dce
Hot Pink #ff69b4
Hunter Green #355e3b
Iceberg #71a6d2
Icterine #fcf75e
Illuminating Emerald #319177
Imperial #602f6b
Imperial Blue #002395
Imperial Purple #66023c
Imperial Red #ed2939
Inchworm #b2ec5d
Independence #4c516d
India Green #138808
Indian Red #cd5c5c
Indian Yellow #e3a857
Indigo #4b0082
Indigo Dye #091f92
Ink blue
Iridescent
Iris #5a4fcf
Irish Green
Irresistible #b3446c
Isabelline #f4f0ec
Islamic Green #009000
Italian Sky Blue #b2ffff
Ivory #fffff0
Jade #00a86b
Japanese Indigo #264348
Japanese Violet #5b3256
Jasmine #f8de7e
Jasper #d73b3e
Jazzberry Jam #a50b5e
Jelly Bean #da614e
Jet #343434
Jonquil #f4ca16
June Bud #bdda57
Jungle Green #29ab87
KU Crimson #e8000d
Kelly Green #4cbb17
Kenyan Copper #7c1c05
Keppel #3ab09e
Khaki #f0e68c
Khaki Beige
Khaki Green
Kobe #882d17
Kobi #e79fc4
Kombu Green #354230
La Salle Green #087830
Lake Blue
Lake Green
Languid Lavender #d6cadd
Lapis Lazuli #26619c
Laser Lemon #ffff66
Latte
Laurel Green #a9ba9d
Lava #cf1020
Lavender #e6e6fa
Lavender Blue #ccccff
Lavender Blush #fff0f5
Lavender Gray #c4c3d0
Lavender Indigo #9457eb
Lavender Magenta #ee82ee
Lavender Mist #e6e6fa
Lavender Pink #fbaed2
Lavender Purple #967bb6
Lavender Rose #fba0e3
Lawn Green #7cfc00
Leaf
Lemon #fff700
Lemon Chiffon #fffacd
Lemon Curry #cca01d
Lemon Glacier #fdff00
Lemon Lime #e3ff00
Lemon Meringue #f6eabe
Lemon yellow #fff44f
Leopard
Leopard Print
Liberty #545aa7
Licorice #1a1110
Light Apricot #fdd5b1
Light Beige
Light Blond
Light Blue #add8e6
Light Blue Pearl
Light Brown #b5651d
Light Carmine Pink #e66771
Light Coffee
Light Coral #f08080
Light Cornflower Blue #93ccea
Light Crimson #f56991
Light Cyan #e0ffff
Light Fuchsia Pink #f984ef
Light Goldenrod Yellow #fafad2
Light Gray #d3d3d3
Light Green #90ee90
Light Grey #d3d3d3
Light Khaki #f0e68c
Light Leopard
Light Medium Orchid #d39bcb
Light Moss Green #addfad
Light Orchid #e6a8d7
Light Pastel Purple #b19cd9
Light Pink #ffb6c1
Light Purple
Light Red Ochre #e97451
Light Rose
Light Salmon #ffa07a
Light Salmon Pink #ff9999
Light Sea Green #20b2aa
Light Sky Blue #87cefa
Light Slate Gray #778899
Light Steel Blue #b0c4de
Light Tan
Light Taupe #b38b6d
Light Thulian Pink #e68fac
Light Wine Red
Light Yellow #ffffe0
Lilac #c8a2c8
Lime #00ff00
Lime Green #32cd32
Limerick #9dc209
Lincoln Green #195905
Linen #faf0e6
Lion #c19a6b
Little Boy Blue #6Ca0dc
Liver #674c47
Liver Chestnut #987456
Livid #6699cc
Lollipop
Lumber #ffe4cd
Lust #e62020
MSU Green #18453b
Magenta #ff00ff
Magenta Haze #9f4576
Magic Mint #aaf0d1
Magnolia #f8f4ff
Mahogany #c04000
Maize #fbec5d
Majorelle Blue #6050dc
Malachite #0bda51
Manatee #979aaa
Mango Tango #ff8243
Mantis #74c365
Maple
Marble
Mardi Gras #880085
Maroon #b03060
Matte Black
Matte White
Mauve #e0b0ff
Mauve Taupe #915f6d
Mauvelous #ef98aa
May Green #4c9141
Maya Blue #73c2fb
Meat Brown #e5b73b
Medium Persian Blue #0067a5
Medium Tuscan Red #79443b
Medium Aquamarine #66cdaa
Medium Blond
Medium Blue #0000cd
Medium Brown
Medium Candy Apple Red #e2062c
Medium Carmine #af4035
Medium Champagne #f3e5ab
Medium Electric Blue #035096
Medium Jungle Green #1c352d
Medium Lavender Magenta #dda0dd
Medium Orchid #ba55d3
Medium Purple #9370db
Medium Red-Violet #bb3385
Medium Ruby #aa4069
Medium Sea Green #3cb371
Medium Sky Blue #80daeb
Medium Slate Blue #7b68ee
Medium Spring Bud #c9dc87
Medium Spring Green #00fa9a
Medium Taupe #674c47
Medium Turquoise #48d1cc
Medium Vermilion #d9603b
Medium Violet-Red #c71585
Mellow Apricot #f8b878
Mellow Yellow #f8de7e
Melon #fdbcb4
Metallic Bronze
Metallic Gold
Metallic Onyx
Metallic Pink
Metallic Purple
Metallic Red
Metallic Seaweed #0a7e8c
Metallic Silver
Metallic Sunburst #9c7c38
Mexican Pink #e4007c
Mica
Midnight #702670
Midnight Blue #191970
Midnight Green #004953
Midori
Mikado Yellow #ffc40c
Milk Chocolate
Milk White
Mini Black/White Zebra
Mint #3eb489
Mint Cream #f5fffa
Mint Green #98ff98
Misty Rose #ffe4e1
Moccasin #ffe4b5
Mode Beige #967117
Moonstone Blue #73a9c2
Mordant Red 19 #ae0c00
Moss Green #8a9a5b
Mother of Pearl
Mountain Meadow #30ba8f
Mountbatten Pink #997a8d
Mughal Green #306030
Mulberry #c54b8c
Multicolor
Multicolored
Mustard #ffdb58
Myrtle Green #317873
Nacarat
Nadeshiko Pink #f6adc6
Napier Green #2a8000
Naples Yellow #fada5e
Native Earth
Natural
Navajo White #ffdead
Navy #000080
Navy Blue #0d77b6
Navy Blue-Lake Blue
Navy Purple #9457eb
Neon Blue
Neon Carrot #ffa343
Neon Fuchsia #fe4164
Neon Green #39ff14
Neon Orange
Neon Pink
Neon Red
Neon Yellow
New Car #214fc6
New York Pink #d7837f
Newspaper
Noche
Non-Photo Blue #a4dded
North Texas Green #059033
Nude
Nutmeg
Nyanza #e9ffdb
OU Crimson Red #990000
Ocean Blue #4f42b5
Ocean Boat Blue
Ochre #cc7722
Off White
Off-White
Office Green #008000
Old Burgundy #44302e
Old Gold #cfb53b
Old Lace #fdf5e6
Old Lavender #796878
Old Mauve #673147
Old Moss Green #867e36
Old Rose #c08081
Old Silver #848482
Olive #808000
Olive Drab #6b8e23
Olive Green
Olive Green black
Olivine #9ab973
Onyx #353839
Opera Mauve #b784a7
Orange #ffa500
Orange Light
Orange Peel #ff9f00
Orange Plaid
Orange-Red #ff4500
Orchid #da70d6
Orchid Pink #f2bdcd
Orioles Orange #fb4f14
Orion
Otter Brown #654321
Outer Space #414a4c
Outrageous Orange #ff6e4a
Oxford Blue #002147
Pakistan Green #006600
Palatinate Blue #273be2
Palatinate Purple #682860
Pale Aqua #bcd4e6
Pale Blue #afeeee
Pale Brown #987654
Pale Carmine #af4035
Pale Cerulean #9bc4e2
Pale Chestnut #ddadaf
Pale Copper #da8a67
Pale Cornflower Blue #abcdef
Pale Gold #e6be8a
Pale Goldenrod #eee8aa
Pale Green #98fb98
Pale Lavender #dcd0ff
Pale Magenta #f984e5
Pale Pink #fadadd
Pale Plum #dda0dd
Pale Red-Violet #db7093
Pale Robin Egg Blue #96ded1
Pale Silver #c9c0bb
Pale Spring Bud #ecebdd
Pale Taupe #bc987e
Pale Turquoise #afeeee
Pale Violet-Red #db7093
Pansy Purple #78184a
Paolo Veronese Green #009b7d
Papaya Whip #ffefd5
Paris Green #50c878
Pastel Blue #aec6cf
Pastel Brown #836953
Pastel Gray #cfcfc4
Pastel Green #77dd77
Pastel Magenta #f49ac2
Pastel Orange #ffb347
Pastel Pink #dea5a4
Pastel Purple #b39eb5
Pastel Red #ff6961
Pastel Violet #cb99c9
Pastel Yellow #fdfd96
Patriarch #800080
Payne's Grey #536878
Peach #ffe5b4
Peach Puff #ffdab9
Peach-Orange #ffcc99
Peach-Yellow #fadfad
Peacock Blue
Peak Green
Pear #d1e231
Pearl #eae0c8
Pearl Aqua #88d8c0
Pearl White
Pearly Purple #b768a2
Peridot #e6e200
Periwinkle #ccccff
Persian Blue #1c39bb
Persian Green #00a693
Persian Indigo #32127a
Persian Orange #d99058
Persian Pink #f77fbe
Persian Plum #701c1c
Persian Red #cc3333
Persian Rose #fe28a2
Persimmon #ec5800
Peru #cd853f
Phlox #df00ff
Phthalo Blue #000f89
Phthalo Green #123524
Pictorial Carmine #c30b4e
Piggy Pink #fddde6
Pine Green #01796f
Pink #ffc0cb
Pink Beige
Pink Cheetah
Pink Green
Pink Indigo
Pink Lace #ffddf4
Pink Lavender #d8b2d1
Pink Light
Pink Pearl #e7accf
Pink Purple Green
Pink Sherbet #f78fa7
Pink-Orange #ff9966
Pinky
Pistachio #93c572
Platinum #e5e4e2
Plum #dda0dd
Popstar #be4f62
Portland Orange #ff5a36
Powder Blue #b0e0e6
Princeton Orange #f58025
Prune #701c1c
Prussian Blue #003153
Psychedelic Purple #df00ff
Puce #cc8899
Puce Red #722f37
Pumpkin #ff7518
Pure
Pure White
Purple #bb6aee
Purple Fuchsia
Purple Heart #69359c
Purple Light
Purple Mountain Majesty #9678b6
Purple Navy #4e5180
Purple Pizzazz #fe4eda
Purple Taupe #50404d
Purple-Cream
Purple-Pink
Purplish Red
Purpureus #9a4eae
Quartz #51484f
Queen Blue #436b95
Queen Pink #e8ccd7
Rackley #5d8aa8
Radical Red #ff355e
Rajah #fbab60
Raspberry #e30b5d
Raspberry Glace #915f6d
Raspberry Pink #e25098
Raspberry Rose #b3446c
Raw Umber #826644
Razzle Dazzle Rose #ff33cc
Razzmatazz #e3256b
Razzmic Berry #8d4e85
Red #f45656
Red Black
Red Devil
Red Hot
Red Pearl
Red-Brown #a52a2a
Red-Orange #ff5349
Red-Violet #c71585
Redwood #a45a52
Regalia #522d80
Resolution Blue #002387
Rhythm #777696
Rich Black #004040
Rich Brilliant Lavender #f1a7fe
Rich Carmine #d70040
Rich Electric Blue #0892d0
Rich Lavender #a76bcf
Rich Lilac #b666d2
Rich Maroon #b03060
Rifle Green #444c38
Robin Egg Blue #00cccc
Rocket Metallic #8a7f80
Roman Silver #838996
Rose #f15fa8
Rose Bonbon #f9429e
Rose Ebony #674846
Rose Gold #ef597b
Rose Madder #e32636
Rose Petal
Rose Pink #ff66cc
Rose Quartz #aa98a9
Rose Red #c21e56
Rose Red-Light Khaki
Rose Taupe #905d5d
Rose Vale #ab4e52
Rosewood #65000b
Rosso Corsa #d40000
Rosy Brown #bc8f8f
Royal Azure #0038a8
Royal Blue #4169e1
Royal Fuchsia #ca2c92
Royal Purple #7851a9
Royal Yellow #fada5e
Ruber #ce4676
Rubine Red #d10056
Ruby #e0115f
Ruby Red #9b111e
Ruddy #ff0028
Ruddy Brown #bb6528
Ruddy Pink #e18e96
Rufous #a81c07
Russet #80461b
Russian Green #679267
Russian Violet #32174d
Rust #b7410e
Rust Brown
Rusty
Rusty Red #da2c43
Sacramento State Green #00563f
Saddle Brown #8b4513
Safety Orange #ff7800
Safety Yellow #eed202
Saffron #f4c430
Salmon #fa8072
Salmon Pink #ff91a4
Sand #c2b280
Sand Dune #967117
Sandstorm #ecd540
Sandy
Sandy Brown #f4a460
Sandy Taupe #967117
Sangria #507d2a
Sap Green #507d2a
Sapphire #0f52ba
Sapphire Blue #0067a5
Satin Sheen Gold #cba135
Scarlet #ff2400
Schauss Pink #ff91af
School Bus Yellow #ffd800
Screamin' Green #66ff66
Sea
Sea Blue #006994
Sea Green #2e8b57
Seal Brown #59260b
Seashell #fff5ee
Selective Yellow #ffba00
Sensual
Sepia #704214
Serenity
Shadow #8a795d
Shampoo #ffcff1
Shamrock Green #009e60
Sheen Green #8fd400
Shimmering Blush #d98695
Shocking Pink #fc0fc0
Sienna #882d17
Sigal
Silver #d4d4d4
Silver Lake Blue #5d89ba
Silver Chalice #acacac
Silver Gray
Silver Green
Silver Grey
Silver Pink #c4aead
Silver Sand #bfc1c2
Silver White
Sinopia #cb410b
Skobeloff #007474
Sky
Sky Blue #87ceeb
Sky Magenta #cf71af
Skyblue Orange
Slate
Slate Blue #6a5acd
Slate Gray #708090
Smalt #003399
Smitten #c84186
Smoke #738276
Smokey Topaz #832a0d
Smoky Black #100c08
Snow #fffafa
Snow White
Soap #cec8ef
Sonic Silver #757575
Space Cadet
Spanish Bistre #807532
Spanish Blue #0070b8
Spanish Carmine #d10047
Spanish Crimson #e51a4c
Spanish Gray #989898
Spanish Orange #e86100
Spanish Sky Blue #00ffff
Spanish Viridian #007f5c
Sparkling White
Spartan Crimson #9e1316
Spiro Disco Ball #0fc0fc
Spring Bud #a7fc00
Spring Green #00ff7f
St. Patrick's Blue #23297a
Star
Star Command Blue #007bb8
Steel Blue #4682b4
Steel Blue-Purple
Steel Pink #cc33cc
Stem
Stik-It
Stil de Grain Yellow #fada5e
Stizza #990000
Stormcloud #4f666a
Straw #e4d96f
Strawberry #fc5a8d
Sunglow #ffcc33
Sunray #e3ab57
Sunset #fad6a5
Sunset Kiss
Sunset Orange #fd5e53
Sunset Plum
Super Pink #cf6ba9
Sweet Gold
Tan #d2b48c
Tangelo #f94d00
Tangerine #f28500
Tangerine Yellow #ffcc00
Tango Pink #e4717a
Taupe #483c32
Taupe Gray #8b8589
Tea Green #d0f0c0
Tea Rose #f88379
Teal #008080
Teal Blue #367588
Teal Deer #99e6b3
Teal Green #00827f
Telemagenta #cf3476
Terra Cotta #e2725b
Thistle #d8bfd8
Thulian Pink #de6fa1
Tickle Me Pink #fc89ac
Tiffany Blue #0abab5
Tiger
Tiger Print
Tiger's Eye #e08d3c
Timberwolf #dbd7d2
Titanium Yellow #eee600
Tomato #ff6347
Toolbox #746cc0
Topaz #ffc87c
Tortoise
Tractor Red #fd0e35
Transparent
Transparent Black #000000
Transparent Dark Green #006400
Transparent Pink #ffc0cb
Transparent Red #ff0000
Transparent White #ffffff
Trolley Grey #808080
Tropical Rain Forest #00755e
True Blue #0073cf
Tufts Blue #417dc1
Tulip #ff878d
Tumbleweed #deaa88
Turkish Rose #b57281
Turquoise #40e0d0
Turquoise Black
Turquoise Blue #00ffef
Turquoise Green #a0d6b4
Turquoise-Purple
Tuscan #fad6a5
Tuscan Brown #6f4e37
Tuscan Red #7c4848
Tuscan Tan #a67b5b
Tuscany #c09999
Twilight Lavender #8a496b
Tyrian Purple #66023c
UA Blue #0033aa
UA Red #d9004c
UCLA Blue #536895
UCLA Gold #ffb300
UFO Green #3cd070
UP Forest green #014421
UP Maroon #ae2029
USAFA Blue #004f98
USC Cardinal #990000
USC Gold #ffcc00
UV Purple
Ube #8878c3
Ultra
Ultra Pink #ff6fff
Ultramarine #3f00ff
Ultramarine Blue #4166f5
Umber #635147
Unbleached Silk #ffddca
United Nations Blue #5b92e5
Unmellow Yellow #ffff66
Upsdell Red
Urobilin #e1ad21
Utah Crimson #d3003f
Vanilla #f3e5ab
Vanilla Ice #f38fa9
Vegas Gold #c5b358
Velvet Touch Pink
Velvet Touch Purple
Velvet Touch Zebra
Venetian Red #c80815
Vercafe
Verde
Verdigris #43b3ae
Vermilion #e34234
Veronica #a020f0
Viola
Violet #ee82ee
Violet-Blue #324ab2
Violet-Red #d02090
Viridian #40826d
Viridian Green #009698
Vivid Auburn #922724
Vivid Burgundy #9f1d35
Vivid Cerise #da1d81
Vivid Orchid #cc00ff
Vivid Sky Blue #00ccff
Vivid Tangerine #ffa089
Vivid Violet #9f00ff
Warm Yellow
Warm Black #004242
Warm White
Washed Black
Water Blue
Water Wave Camouflage
Watermelon Red
Waterspout #a4f4f9
Wenge #645452
Wheat #f5deb3
White #ffffff
White Dye Dip
White Glitter
White Gold
White Smoke #f5f5f5
Wild Strawberry #ff43a4
Wild Watermelon #fc6c85
Wild Blue Yonder #a2add0
Wild Orchid #d470a2
Windsor Tan #a75502
Wine #722f37
Wine Dregs #673147
Wine Red
Wisteria #c9a0dc
Wood brown #c19a6b
Wow
Xanadu #738678
Yale Blue #0f4d92
Yankees Blue #1c2841
Yellow #fff200
Yellow Camouflage
Yellow Orange #ffae42
Yellow Pearl
Yellow Light
Yellow Rose #fff000
Yellow-Green #9acd32
Zaffre #0014a8
Zebra
Zebra Print
Zinnwaldite Brown #2c1608
Zomp #39a78e

Sizing Charts

Men's Apparel
NameChestWaistNeckSleeve
XS76–81 cm30–32"61–66 cm24–26"33–34 cm13–13.5"79–81 cm31–32"
S86–91 cm34–36"71–76 cm28–30"36–37 cm14–14.5"81–84 cm32–33"
M97–102 cm38–40"81–86 cm32–34"38–39 cm15–15.5"84–86 cm33–34"
L107–112 cm42–44"91–97 cm36–38"41–42 cm16–16.5"86–89 cm34–35"
XL117–122 cm46–48"102–107 cm40–42"43–44 cm17–17.5"89–91 cm35–36"
XXL127–132 cm50–52"112–117 cm44–46"46–47 cm18–18.5"91–94 cm36–37"
XXXL137–142 cm54–56"122–127 cm48–50"48–50 cm19–19.5"94–97 cm37–38"
XXXXL147–152 cm58–60"132–137 cm52–54"51–52 cm20–20.5"97–99 cm38–39"
XXXXXL157–163 cm62–64"142–147 cm56–58"53–55 cm21–21.5"99–102 cm39–40"
Women's Apparel
NameBust/ChestWaistHip
XXS80–83 cm31.5–32.5"60–62 cm23.5–24.5"86–89 cm34–35"
XS83–85 cm32.5–33.5"62–65 cm24.5–25.5"89–91 cm35–36"
S85–88 cm33.5–34.5"65–67 cm25.5–26.5"91–94 cm36–37"
M90–93 cm35.5–36.5"70–72 cm27.5–28.5"97–99 cm38–39"
L97–100 cm38–39.5"76–80 cm30–31.5"103–107 cm40.5–42"
XL104–109 cm41–43"84–88 cm33–34.5"110–116 cm43.5–45.5"
XXL110–116 cm43.5–45.5"91–95 cm36–37.5"116–123 cm45.5–48.5"
Men's Shoe Size
USEuroInchesCentimeters
6399.25"23.5 cm
6.5399.5"24.1 cm
7409.625"24.4 cm
7.540–419.75"24.8 cm
8419.9375"25.4 cm
8.541–4210.125"25.7 cm
94210.25"26 cm
9.542–4310.4375"26.7 cm
104310.5625"27 cm
10.543–4410.75"27.3 cm
114410.9375"27.9 cm
11.544–4511.125"28.3 cm
124511.25"28.6 cm
134611.5625"29.4 cm
144711.875"30.2 cm
154812.1875"31 cm
164912.5"31.8 cm
Women's Shoe Size
USEuroInchesCentimeters
4358.1875"20.8 cm
4.5358.375"21.3 cm
535–368.5"21.6 cm
5.5368.75"22.2 cm
636–378.875"22.5 cm
6.5379.0625"23 cm
737–389.25"23.5 cm
7.5389.375"23.8 cm
838–399.5"24.1 cm
8.5399.6875"24.6 cm
939–409.875"25.1 cm
9.54010"25.4 cm
1040–4110.1875"25.9 cm
10.54110.3125"26.2 cm
1141–4210.5"26.7 cm
11.54210.6875"27.1 cm
1242–4310.875"27.6 cm
Big Kids' Shoe Size (7–12 years old)
USEuroInchesCentimeters
3.5358.625"21.9 cm
4368.75"22.2 cm
4.5369"22.9 cm
5379.125"23.2 cm
5.5379.25"23.5 cm
6389.5"24.1 cm
6.5389.625"24.4 cm
7399.75"24.8 cm
Little Kids' Shoe Size (4–7 years old)
USEuroInchesCentimeters
10.5276.625"16.8 cm
11286.75"17.1 cm
11.5297"17.8 cm
12307.125"18.1 cm
12.5307.25"18.4 cm
13317.5"19.1 cm
13.5317.625"19.4 cm
1327.75"19.7 cm
1.5338"20.3 cm
2338.125"20.6 cm
2.5348.25"21 cm
3348.5"21.6 cm
Toddlers' Shoe Size (9 months – 4 years old)
USEuroInchesCentimeters
3.5194.25"10.8 cm
4194.5"11.4 cm
4.5204.625"11.7 cm
5204.75"12.1 cm
5.5215"12.7 cm
6225.125"13 cm
6.5225.25"13.3 cm
7235.5"14 cm
7.5235.625"14.3 cm
8245.75"14.6 cm
8.5256"15.2 cm
9256.125"15.6 cm
9.5266.25"15.9 cm
10276.5"16.5 cm
Infants' Shoe Size (0–9 months)
USEuroInchesCentimeters
0153.125"7.9 cm
1163.5"8.9 cm
1.5173.625"9.2 cm
2173.75"9.5 cm
2.5184"10.2 cm
3184.125"10.5 cm

List of Accepted Sizes

Numberical

  • 1, 2, 3, 4, ...
  • 10.5, 11.0, 11.5, 12.0, ...
  • 0.1, 0.2, 0.3, 0.4, ...
  • 1.3431, 2.54672, 3.4233, 4.412, ...
  • Any valid number

Area Size

  • 1.1" * 1.2"
  • 0.1234 cm x 123 cm x 10 cm
  • 8m by 1.0m
  • Any valid area in cm, mm, m, inches, feet (2D or 3D)

Volume Size

  • 1.3ml
  • 5L
  • 1.213pt
  • Any valid area in mL, L, ounces, gallons, quarts, cups, pints

Length Size

  • 1.3m
  • 5L
  • 6' 7"
  • Any valid length in m, cm, mm, feet, inches

Weight

  • 1.3oz
  • 5lb
  • 1.5 kg
  • Any valid weight in g, kg, lb, pounds, ounces

Voltage

  • 2.5V
  • 200 V
  • 5v
  • Any valid voltage in V

Wattage

  • 2.5W
  • 200W
  • 5W
  • Any valid wattage in W

Numbers

0
0.5
1
1.5
2
2.5
3
3.5
4
4.5
5
5.5
6
6.5
7
7.5
8
8.5
9
9.5
10
10.5
11
11.5
12
12.5
13
13.5
14
14.5
15
15.5
16
16.5
17
17.5
18
18.5
19
19.5
20
20.5

Clothing

  • One Size
  • XXXS, XXS, XS, S, M, L, XL, XXL, XXXL, XXXXL
  • 4XL, 5XL, 6XL, 7XL, 8XL
  • 1X, 2X, 3X
  • Youth XL (16-18), Youth L (14-16), Youth M (10-12), Youth S (6-8)
  • Adult
  • Kid

Bedding

Single
Twin
Double
Full
Queen
King
Super King
California King

Bras

30B
30C
30D
32A
32AA
32B
32C
32D
32DD
32DDD
32E
32/34D
32/34DD
32/34E
32/34F
34A
34AA
34B
34C
34D
34DD
34DDD
34E
36A
36AA
36B
36C
36D
36DD
36DDD
36E
36F
36/38C
36/38D
36/38DD
36/38E
36/38F
38A
38B
38C
38D
38DD
38DDD
38E
38F
40A
40B
40C
40D
40DD
40DDD
40E
40F
42A
42B
42C
42D
42DD
42DDD
42E
44DD
44DDD

Infant/Child

Newborn
2t
3t
4t
5t
6t
7t
8t
6 Months
12 Months
18 Months
0-3m
0-6m
3-6m
6-12m
6-9m
9-12m
12-18m
18-24m
1-2 Years
2-3 Years
3-4 Years
4-5 Years
5-6 Years
6-7 Years
7-8 Years
8-9 Years
9-10 Years
10-11 Years
11-12 Years
12-13 Years
13-14 Years
14-15 Years

MacBooks

11" MacBook
11" MacBook Air
12" MacBook
13" White MacBook
13" MacBook Air
13" MacBook Pro
13" MacBook Pro with Retina display
15" MacBook Pro
15" MacBook Pro with Retina display
17" MacBook Pro

Smartphones/Tablets

Apple Watch 38mm
Apple Watch 42mm
iPod Touch 4
iPod Touch 5
iPod Touch 6
iPad Mini
iPad Mini 2
iPad Mini 3
iPad Mini 4
iPad Air
iPad Air 2
iPad 1
iPad 2
iPad 3
iPad 4
iPad Pro
12.9" iPad Pro
9.7" iPad Pro
iPhone 4
iPhone 4s
iPhone 5
iPhone 5c
iPhone 5s
iPhone 6
iPhone 6 Plus
iPhone 6S
iPhone 6S Plus
iPhone SE
Samsung Galaxy S2
Samsung Galaxy S3
Samsung Galaxy S3 Mini
Samsung Galaxy S4 Mini
Samsung Galaxy S4
Samsung Galaxy S4 Active
Samsung Galaxy S5 Mini
Samsung Galaxy S5
Samsung Galaxy S5 Active
Samsung Galaxy S5 (E5000)
Samsung Galaxy S6
Samsung Galaxy S6 Active
Samsung Galaxy S6 Edge
Samsung Galaxy S6 Edge Plus
Samsung Galaxy S7
Samsung Galaxy S7 Plus
Samsung Galaxy S7 Edge
Samsung Galaxy Mega 6.3
Samsung Galaxy Note Edge N9150
Samsung Galaxy Note 1
Samsung Galaxy Note 2
Samsung Galaxy Note 3
Samsung Galaxy Note 3 Lite N7506
Samsung Galaxy Note 3 Neo
Samsung Galaxy Note 4
Samsung Galaxy Note 5
Samsung Galaxy Note 5 Edge
Samsung Galaxy Note 8.0
Samsung Galaxy Note 10
Samsung Galaxy Tab 4.7in
Samsung Galaxy Tab 4.8in
Samsung Galaxy A3
Samsung Galaxy A5
Samsung Galaxy A7
Samsung Galaxy A8
Samsung Galaxy J1
Samsung Galaxy J1 Ace
Samsung Galaxy J2
Samsung Galaxy J3
Samsung Galaxy J5
Samsung Galaxy J7
Samsung Galaxy On5
Samsung Galaxy On7
Samsung Galaxy Young 2 G130
Samsung Galaxy Ace 4
Samsung Galaxy E5
Samsung Galaxy E7
Samsung Galaxy Alpha G850
Samsung Galaxy Mega 5.8
Samsung Galaxy Mega 2
Samsung Galaxy Grand Neo
Samsung Galaxy Grand Prime
Samsung Galaxy Grand 2
Samsung Galaxy Core Max
Samsung Galaxy Core 2 G355
Samsung Galaxy Grand Prime LTE G530H G530F
Samsung Galaxy Core Prime G360P
Samsung Google Nexus 10
Samsung Note Pro 12.2
Samsung Tab Pro 8.4
Samsung Tab 3 7.0
Samsung Tab 3 Lite 7.0
Samsung Tab 3V
Samsung Tab A 8.0
Samsung Tab A 9.7
Samsung Tab S 8.4
Samsung Tab S 10.5
Samsung Tab S2 8.0
Samsung Tab S2 9.7
Samsung Tab E 9.6
Samsung Galaxy J3 (2016)
Samsung Galaxy J5 (2016)
Samsung Galaxy J7 (2016)
Samsung Galaxy A3 (2016)
Samsung Galaxy A5 (2016)
Samsung Galaxy A7 (2016)
Amazon Kindle
Amazon Kindle 2
Amazon Kindle DX
Amazon Kindle Keyboard
Amazon Kindle 4
Amazon Kindle Fire
Amazon Kindle Fire PaperWhite
Amazon Kindle Touch
Amazon Kindle Fire HD 7in
Amazon Kindle Fire HD 8.9in
Amazon Kindle PaperWhite
Amazon Kindle Voyage
HTC M7
HTC M8
HTC M9
HTC One Max
HTC One Mini 2
HTC One M8 Mini
HTC One M9
HTC One M9+
HTC One E8
HTC One E9
HTC One E9+
HTC One A9
HTC Desire 510
HTC Desire 526
HTC Desire 626
HTC Desire 816
HTC Desire 820
HTC Desire 826
Sony 339H
Sony L36H
Sony L39H
Sony L39U
Sony Xperia C3
Sony Xperia E3
Sony Xperia M3
Sony Xperia M5
Sony Xperia T2 Ultra
Sony Xperia T3
Sony Xperia Z2
Sony Xperia Z2 tablet
Sony Xperia Z3
Sony Xperia Z3 Mini
Sony Xperia Z4
Sony Xperia Z5 Compact 4.6 Inch
Sony Xperia Z5 5.2 Inch
Sony Xperia Z5 Premium 5.5 Inch
LG Nexus 5
LG Nexus 5X
LG G2
LG G2 Mini
LG G3
LG G3 S
LG G3 Mini
LG G3 Stylus
LG G4
LG G4c
LG G4 Mini
LG G5
LG V10
LG G Stylo
LG K7
LG K10
LG G Vista
LG L40
LG L70
LG L80
LG L90
LG Tribute 2 Leon C40
LG L15G
LG Lancet VW820
LG Magna H502G VOLT 2
LG Reverse 3 / VN170
Nokia Lumia 640
Nokia Lumia 930
Motorola Nexus 6
Motorola Moto G
Motorola Moto G2
Motorola Moto G3
Motorola Moto X
Motorola X Play
Motorola Moto X (2nd Generation)
Motorola Moto X Style Pure Edition
Microsoft Surface RT Pro
iOS
Huawei Ascend P6
Huawei Ascend P7
Huawei Ascend P8
Huawei Ascend Mate 7
Huawei Ascend Mate 8
Huawei Ascend G530
Huawei Honor 6
Huawei Honor 3c
Huawei Raven LTE H892L
Huawei Pronto LTE SnapTO H891L G620
Huawei Tribute Fusion 3 Y536
Huawei Nexus 6P
XiaoMi Mi 3
XiaoMi Mi 4
XiaoMi RedMi
XiaoMi RedMi Note
Android
Kyocera Hydro Wave C6740
Alcatel onetouch Pop Astro 5042T
Alcatel Pop Icon 2 A846L
Asus Zenfone 2e
ZTE LEVER Z936L
ZTE Speed/N9130
ZTE Warp Elite N9518
ZTE Zephyr Z752C SONATA 2

Gaming

Playstation 3 Slim
Playstation 3 Original
Playstation 3 Slim 1
Playstation 3 Slim 2
Playstation 3 Original 1
Playstation 3 Original 2

Headphones

Beats Pro
Beats Solo
Beats Solo 2
Beats Solo 2 Wireless
Beats Solo-HD
Beats Studio
Beats Studio 2013+ Models
Beats MIXR
Beats Wireless

Create a Product

The /product/add endpoint creates a new product. It also createы the first variant of that product, so if a product has a single variant, both the product and variant can be created with this endpoint. If you have further variant, you can create them using the /variant/add endpoint. For clarity, we describe parameters related to product and variant in separate tables. When you make a request, parameters from both tables should be provided in a single form body.

POST
https://api-merchant.joom.it/api/v2/product/add
Product Parameters
NameRequiredDescription
brandBrand or manufacturer of your product
descriptionDescription of the product, interpreted as plain text — HTML markup will not be processed. You can use "\n" to separate lines. Limit of 4,000 characters, and only the first 250 characters are displayed on the initial search page. Do not include details about store policies, other store-specific language or multiple lines. Information about size, fit, and measurements are helpful for apparel items
Acceptable: "This dress shirt is 100% cotton and fits true to size."
Unacceptable: "This <b>dress shirt</b> is 100% cotton and <i>fits true to size</i>."
extra_imagesURL of extra photos of your product. Link directly to the image, not the page where it is located. The format and size requirements as the same as for the main_image field. You can specify one or more additional images separated by the character "|"
landing_page_urlURL on your website containing the product details
main_imageRequiredURL of the main image of the product. Link directly to the image, not the page where it is located. We accept JPEG, PNG or GIF format. Do not include company logos or names or promotional or other identifying text. Images should be at least 550×550 pixels in size. Do not include any “image not found” images.
Acceptable: "http://www.yourwebsite.com/images/7324204/3", "http://www.yourwebsite.com/images/dress.jpg", "https://www.yourwebsite.com/images/7324204/3"
Unacceptable: "http://www.yourwebsite.com/images/dresses.html"
nameRequiredThe name which you have given the product. Use the following template to build your product names: Main brand + Sub-brand, family or product name + Up to 3 key attributes + Generic product type. Product names must be clear and concise and should also be descriptive of the product being sold. This template will help consumers identifying your product.
Acceptable: "Men's Dress Casual Shirt Navy", "Women's Solid Color Black Dress Pants"
Unacceptable: "Best Price!!! **CHEAP** Baby Stroller!!!"
parent_skuThe unique identifier that your system uses for this product. In particular, you can use this identifier to add additional variants to the product. If this field is not specified, we'll use the variant parameter sku, but you are advised to always specify this parameter
tagsRequiredNon-hierarchical keyword or term assigned to each product in your feed. This kind of metadata helps describe an item and allows it to be categorized and found again by browsing or searching on Joom.it. Select up to 5 per product. Tags should be comma separated, but do NOT use commas in individual tags. The more tags you add, and the more accurate your tags, the better the chances our users will find your products. There is a maximum of 10 tags allowed per product, if you add more than 10 we ignore the extra tags
Acceptable: "Shirt, Men's Fashion, Navy, Blue, Casual, Apparel", "Women's Fashion, Jewelry & Watches", "Men's Fashion, Suits, Mafia, Silk Tie, Ties"
Unacceptable: "Clearance Items", "Cheap Cheap Cheap"
upc12-digit Universal Product Codes (UPC), contains no letters or other characters. A barcode symbology used for tracking trade items in stores and scanning them at the point of sale
Acceptable: "716393133224"
Unacceptable: "asdf884445ds"
Variant Parameters
NameRequiredDescription
colorThe color of the variation, especially as it pertains to apparel or jewelry. If you would like to have it show two colors (eg. “black and red”), simply separate the colors by “&” (eg. “black & red”). Note: not to be confused with products having two different colored variations. The name of the color must be in the list of currently accepted colors
Acceptable: "red", "black & blue"
Unacceptable: "red, blue", "black & blue & green"
inventoryRequiredThe physical quantities you have for this variation, max 100,000
msrpThe Manufacturer Suggested Retail Price of the variation. This field is recommended as it will show as a strike-thru price on Joom and appears above the selling price for the product. It should contain no additional text
Acceptable: "$19.00", "19.99"
Unacceptable: "19.99 + S/H"
priceRequiredThe price of the variation when the user purchases one.
Acceptable: "$100.99", "10.99"
Unacceptable: "$49.99 + S/H"
shippingRequiredThe shipping price of the variation when the user purchases one

Acceptable: "$4.00", "4.99"
Unacceptable: "$4.99 + S/H"
shipping_timeThe amount of time it takes for the shipment to reach the buyer. Please also factor in the time it will take to fulfill and ship the item. Provide a time range in number of days. Lower bound cannot be less than 2 days
Acceptable: "20-30", "15-26"
Unacceptable: "1-2", "0", "7-7"
sizeThe size of the variation, especially as it pertains to apparel, footwear, or jewelry. It must be either a number or in the list of currently accepted sizes
Acceptable: "S", "XXL", "6", "6.5"
Unacceptable: "small", "S, M"
skuRequiredThe unique identifier that your system uses to recognize this variation.
Acceptable: "HSC0424PP", "112123343455432".
Unacceptable: "2", "a".

Returns

Upon success, a product is created and returned. The id field can be used to obtain the Joom product identifier that is assigned.

Example

Lets say you had product named “red shoe” with a SKU of “red-shoe-11”, with price $100.00 and shipping of $10.00. If you want the description to be “this is a cool shoe” and its tags to be “red,shoe,cool”. You want http://i.imgur.com/Q1a32kD.jpg to be the main image for your product and have additional image http://i.imgur.com/Cxagv.jpg and http://i.imgur.com/LuPSxBM.jpg. Assume your access token is “an_example_access_token”.

name = "red shoe"
parent_sku = "red-shoe"
sku = "red-shoe-11"
inventory = 100
price = 100
shipping = 10
description = "this is a cool shoe"
tags = "red,shoe,cool"
main_image = "http://i.imgur.com/Q1a32kD.jpg"
extra_images = "http://i.imgur.com/Cxagv.jpg|http://i.imgur.com/Cxagv.jpg"
access_token = "an_example_access_token"

Example Request

> curl https://api-merchant.joom.it/api/v2/product/add -d "main_image=http://i.imgur.com/Q1a32kD.jpg&name=shoe&description=this is a cool shoe&tags=red,shoe,cool&sku=red-shoe-11&inventory=100&price=100&shipping=10&extra_images=http://i.imgur.com/Q1a32kD.jpg|http://i.imgur.com/Cxagv.jpg&parent_sku=red-shoe&access_token=an_example_access_token"

Example Response

{
  "code": 0,
  "data": {
    "Product": {
      "description": "this is a cool shoe",
      "id": "52a11ebdf94adc0cfee0dbd9",
      "name": "red shoe",
      "number_saves": "0",
      "number_sold": "0",
      "parent_sku": "red-shoe",
      "review_status": "pending",
      "tags": [
        {
          "Tag": {
            "id": "red",
            "name": "red"
          }
        },
        {
          "Tag": {
            "id": "cool",
            "name": "cool"
          }
        },
        {
          "Tag": {
            "id": "shoe",
            "name": "shoe"
          }
        }
      ],
      "variants": [
        {
          "Variant": {
            "enabled": "True",
            "id": "52a11ebef94adc0cfee0dbdb",
            "product_id": "52a11ebdf94adc0cfee0dbd9",
            "inventory": "100",
            "price": "100.0",
            "shipping": "10.0",
            "shipping_time": "5-10",
            "sku": "red-shoe-11"
          }
        }
      ]
    }
  },
 "message": ""
}

Retrieve a Product

The /product endpoint retrives a product given either parent SKU you have specified, or the Joom product ID that was returned upon product creation.

GET
https://api-merchant.joom.it/api/v2/product
Parameters
NameRequiredDescription
idMust provide either id or parent_skuThe unique Joom identifier for this product
parent_skuMust provide either id or parent_skuThe parent SKU for this product

Returns

Returns a product entity if a valid identifier was provided.

Example

Assume your access token is “an_example_access_token”. If you want to retrieve a product with the id “4ef2858a9795c776ce000120”:

id = "4ef2858a9795c776ce000120"
access_token = "an_example_access_token"

Example Request

> curl "https://api-merchant.joom.it/api/v2/product?id=4ef2858a9795c776ce000120&access_token=an_example_access_token"

Update a Product

Updates the specified product with the parameters passed in the request. Any attribute not provided will be left unchanged. For example, if you pass the name parameter the name of the product is updated, while other fields are left unchanged. This request can only update product attributes; even for products with a single variant, variant attributes cannot be modified.

POST
https://api-merchant.joom.it/api/v2/product/update
Parameters
NameRequiredDescription
idMust provide either id or parent_skuJoom's unique identifier for the product you would like to update
brandBrand or manufacturer of your product
descriptionDescription of the product, interpreted as plain text — HTML markup will not be processed. You can use "\n" to separate lines. Limit of 4,000 characters, and only the first 250 characters are displayed on the initial search page. Do not include details about store policies, other store-specific language or multiple lines. Information about size, fit, and measurements are helpful for apparel items
Acceptable: "This dress shirt is 100% cotton and fits true to size."
Unacceptable: "This <b>dress shirt</b> is 100% cotton and <i>fits true to size</i>."
extra_imagesURL of a photo of your product. Link directly to the image, not the page where it is located. Same rules apply as main_image. You can specify one or more additional images separated by the character "|"
landing_page_urlURL on your website containing the product details
main_imageURL of the main image of the product. Link directly to the image, not the page where it is located. We accept JPEG, PNG or GIF format. Do not include company logos or names or promotional or other identifying text. Images should be at least 550×550 pixels in size. Do not include any “image not found” images.
Acceptable: "http://www.yourwebsite.com/images/7324204/3", "http://www.yourwebsite.com/images/dress.jpg", "https://www.your website.com/images/7324204/3"
Unacceptable: "http://www.yourwebsite.com/images/dresses.html"
nameThe name which you have given the product. Use the following template to build your product names: Main brand + Sub-brand, family or product name + Up to 3 key attributes + Generic product type. Product names must be clear and concise and should also be descriptive of the product being sold. This template will help consumers identifying your product.
Acceptable: "Men's Dress Casual Shirt Navy", "Women's Solid Color Black Dress Pants"
Unacceptable: "Best Price!!! **CHEAP** Baby Stroller!!!"
parent_skuMust provide either id or parent_skuThe parent SKU for the product you would like to update
tagsNon-hierarchical keyword or term assigned to each product in your feed. This kind of metadata helps describe an item and allows it to be categorized and found again by browsing or searching on Joom.it. Select up to 5 per product. Tags should be comma separated, but do NOT use commas in individual tags. The more tags you add, and the more accurate your tags, the better the chances our users will find your products. There is a maximum of 10 tags allowed per product, if you add more than 10 we ignore the extra tags
Acceptable: "Shirt, Men's Fashion, Navy, Blue, Casual, Apparel", "Women's Fashion, Jewelry & Watches", "Men's Fashion, Suits, Mafia, Silk Tie, Ties"
Unacceptable: "Clearance Items", "Cheap Cheap Cheap"
upc12-digit Universal Product Codes (UPC), contains no letters or other characters. A barcode symbology used for tracking trade items in stores and scanning them at the point of sale
Acceptable: "716393133224"
Unacceptable: "asdf884445ds"

Returns

If this request succeeds, HTTP status code 200 is returned and response has code 0 and no data.

Example

Assume your access token is “an_example_access_token”. If you had a product with ID “123456789009876543211234” and you wanted to change the name to “Awesome shoe”, update the description to “This shoe is the best on Joom” and change the tags to “shoe,awesome,size 11” your parameters would be:

id = "123456789009876543211234"
name = "Awesome shoe"
description = "This shoe is the best on Joom"
tags = "shoe,awesome,size 11"
access_token = "an_example_access_token"

If you did not want to update the tags, you would omit that parameter from your API call.

Example Request

> curl https://api-merchant.joom.it/api/v2/product/update -d "id=123456789009876543211234&name=Awesome shoe&description=This shoe is the best on Joom&tags=shoe, awesome, size 11&access_token=an_example_access_token"

Example Response

{
  "code": 0,
  "data": {},
  "message": ""
}

Enable a Product

The /product/enable endpoint enables a product and all its variants, making them available for sale. You only need to enable a product if you previously disabled it.

POST
https://api-merchant.joom.it/api/v2/product/enable
Parameters
NameRequiredDescription
idMust provide either id or parent_skuJoom's unique ID for the product you would like to update
parent_skuMust provide either id or parent_skuThe parent SKU for the product you would like to update

Returns

If this request succeeds, HTTP status code 200 is returned and response has code 0 and no data.

Example

Assume your access token is “an_example_access_token”. If you had a product with ID “123456789009876543211234” and you wanted to enable it, your parameters would be:

id = "123456789009876543211234"
access_token = "an_example_access_token"

Example Request

> curl https://api-merchant.joom.it/api/v2/product/enable -d "id=123456789009876543211234&access_token=an_example_access_token"

Example Response

{
  "code": 0,
  "data": {},
  "message": ""
}

Disable a Product

The /product/disable endpoint disables a product and all its variants, making them unavailable for sale.

POST
https://api-merchant.joom.it/api/v2/product/disable
Parameters
NameRequiredDescription
idMust provide either id or parent_skuJoom's unique ID for the product you would like to update
parent_skuMust provide either id or parent_skuThe parent SKU supplied when product was uploaded

Returns

If this request succeeds, HTTP status code 200 is returned and response has code 0 and no data.

Example

Assume your access token is “an_example_access_token”. If you had a product with ID “productid312” and you wanted to disable it, your parameters would be:

id = "productid312"
access_token = "an_example_access_token"

Example Request

> curl https://api-merchant.joom.it/api/v2/product/disable -d "id=productid312&access_token=an_example_access_token"

Example Response

{
  "code": 0,
  "data": {},
  "message": ""
}

List all Products

Returns a list of all your products currently on the Joom platform. If you have a high number of products the response will be paginated. The response contains the URL for fetching the next page of products.

GET
https://api-merchant.joom.it/api/v2/product/multi-get
Parameters
NameRequiredDescription
startAn offset into the list of returned items. Use 0 to start at the beginning. The API will return the requested number of items starting at this offset. Default to 0 if not supplied
limitA limit on the number of products that can be returned. Limit can range from 1 to 500 items and the default is 50
sinceA date string in the format YYYY-MM-DD. If a date is provided, only products updated since the given date will be fetched. Default is to fetch all

Returns

If request is successful, response contains a list of product objects as well as a paging field with paging options if needed.

Example

Assume your access token is “an_example_access_token”. If you would like to view your products updated after “2014-10-15” in groups of 2 and you would like to see the 10th group your parameters would be:

start = 20
limit = 2
since = "2014-10-15"
access_token = "an_example_access_token"

Example Request

> curl "https://api-merchant.joom.it/api/v2/product/multi-get?limit=2&start=20&since=2014-10-15&access_token=an_example_access_token"

Example Response

{
  "code": 0,
  "data": [
    {
      "Product": {
        "description": "Example description",
        "id": "5284e18fb5baba49d5xxxxxx",
        "name": "Cute Ring",
        "number_saves": "6",
        "number_sold": "0",
        "parent_sku": "Cute Bow Ring",
        "review_status": "approved",
        "tags": [
          {
            "Tag": {
              "id": "womensring",
              "name": "womens ring"
            }
          },
          {
            "Tag": {
              "id": "jewelry",
              "name": "Jewelry"
            }
          },
          {
            "Tag": {
              "id": "bow",
              "name": "Bow"
            }
          }
        ],
        "variants": [
          {
            "Variant": {
              "color": "green",
              "enabled": "True",
              "id": "5284e192b111ba49d5xxxxxx",
              "product_id": "5284e18fb5baba49d5xxxxxx",
              "inventory": "11",
              "msrp": "113.9",
              "price": "110.9",
              "shipping": "10.5",
              "sku": "AA1"
            }
          },
          {
            "Variant": {
              "color": "blue",
              "enabled": "True",
              "id": "5284e19qqqbaba49d5bbbbbb",
              "product_id": "5284e18fb5baba49d5xxxxxx",
              "inventory": "100",
              "msrp": "19.9",
              "price": "15.9",
              "shipping": "10.5",
              "sku": "ZZ1"
            }
          }
        ]
      }
    },
    {
      "Product": {
        "description": "Example Description",
        "id": "5284efafb5bab119d1zzzzzz",
        "name": "Fairisle Scarf",
        "number_saves": "0",
        "number_sold": "0",
        "parent_sku": "Fairisle Scarf",
        "review_status": "rejected",
        "tags": [
          {
            "Tag": {
              "id": "cottonscarf",
              "name": "cotton scarf"
            }
          },
          {
            "Tag": {
              "id": "fashionaccessorie",
              "name": "Fashion Accessories"
            }
          },
          {
            "Tag": {
              "id": "fashion",
              "name": "Fashion"
            }
          },
          {
            "Tag": {
              "id": "scarf",
              "name": "scarf"
            }
          }
        ],
        "variants": [
          {
            "Variant": {
              "color": "gray",
              "enabled": "True",
              "id": "5284efb1b111ba49d1qqqqqq",
              "product_id": "5284efafb5bab119d1zzzzzz",
              "inventory": "1010",
              "msrp": "25.9",
              "price": "21.91",
              "shipping": "10.0",
              "sku": "AA4"
            }
          },
          {
            "Variant": {
              "color": "red",
              "enabled": "True",
              "id": "5284efbaaababa49d1eiwqdf",
              "product_id": "5284efafb5bab119d1zzzzzz",
              "inventory": "1100",
              "msrp": "21.99",
              "price": "21.91",
              "shipping": "11.0",
              "sku": "AAB"
            }
          }
        ]
      }
    }
  ],
  "message": "",
  "paging": {
    "next": "https://api-merchant.joom.it/api/v2/product/multi-get?start=22&limit=2&since=2014-10-15&access_token=an_example_access_token",
    "previous": "https://api-merchant.joom.it/api/v2/product/multi-get?start=18&limit=2&since=2014-10-15&am;paccess_token=an_example_access_token"
  }
}

Remove Extra Images from a Product

This removes all the extra images from the product. The main product image and variation images will not be affected.

POST
https://api-merchant.joom.it/api/v2/product/remove-extra-images
Parameters
NameRequiredDescription
idMust provide either id or parent_skuThe unique Joom ID for this product
parent_skuMust provide either id or parent_skuThe parent SKU for this product

Returns

If this request succeeds, HTTP status code 200 is returned and response has code 0 and no data.

Example

Assume your access token is “an_example_access_token”. If you had a product with ID “123456789009876543211234” and you wanted to remove its extra images, your parameters would be:

id = "123456789009876543211234"
access_token = "an_example_access_token"

Example Request

> curl https://api-merchant.joom.it/api/v2/product/remove-extra-images -d "access_token=an_example_access_token" --data-urlencode "id=123456789009876543211234"

Example Response

{
  "message": "",
  "code": 0,
  "data": {}
}

Product Variation

The product variation entity represents a SKU that is for sale. It has a price, shipping price and possibly a size or color. Each product variation belongs to one product and each product has at least one product variation. A user always buys a product variation, and each SKU in your system will map to one product variation in Joom.

With this API you can create and update product variations. You can also retrieve details about specific product variations or page through all your product variations.

Product Variation Attributes
NameDescription
idThe Joom ID of the product variation
product_idThe Joom ID of the product this product variation belongs to
colorThe color of the variation
enabledWhether or not this product variation is enabled for purchase
inventoryThe physical quantities you have for this variation, max 100,000
main_imageURL of the main image of the product variation
msrpManufacturer's Suggested Retail Price. This field is recommended as it will show as a strikethrough price on Joom and appears above the selling price for the product
original_image_urlURL of the original image when product variation was created
priceThe price of the variation when the user purchases one
shippingThe shipping price of the variation when the user purchases one
shipping_timeThe amount of time it takes for the shipment to reach the buyer. Please also factor in the time it will take to fulfill and ship the item. Provide a time range in number of days. Lower bound cannot be less than 2 days
sizeThe size of the variation
skuThe unique identifier that your system uses to recognize this variation

Create a Product Variation

To add a new variation to a product you can create a product variation. For example, a product has sizes “Large” and “Extra-Large” and you wanted to add size “Medium”, you would create a new product variation with this API.

POST
https://api-merchant.joom.it/api/v2/variant/add
Parameters
NameRequiredDescription
colorThe color of the variation, especially as it pertains to apparel or jewelry. If you would like to have it show two colors (eg. “black and red”), simply separate the colors by “&” (eg. “black & red”). Note: not to be confused with products having two different colored variations. The name of the color must be in the list of currently accepted colors
Acceptable: "red", "black & blue"
Unacceptable: "red, blue", "black & blue & green"
inventoryRequiredThe physical quantities you have for this variation, max 100,000
main_imageURL of a photo for this product variation. Provide this when you have different pictures for different product variation of the product. If left out, it'll use the main_image of the product with the provided parent_sku. Link directly to the image, not the page where it is located. We accept JPEG, PNG or GIF format. Images should be at least 550×550 pixels in size
msrpThe Manufacturer Suggested Retail Price of the variation. This field is recommended as it will show as a strike-thru price on Joom and appears above the selling price for the product. It should contain no additional text
Acceptable: "$19.00", "19.99"
Unacceptable: "19.99 + S/H"
parent_skuRequiredThe parent_sku of the product this new product variation should be added to
priceRequiredThe price of the variation when the user purchases one.
Acceptable: "$100.99", "10.99"
Unacceptable: "$49.99 + S/H"
shippingRequiredThe shipping price of the variation when the user purchases one

Acceptable: "$4.00", "4.99"
Unacceptable: "$4.99 + S/H"
shipping_timeThe amount of time it takes for the shipment to reach the buyer. Please also factor in the time it will take to fulfill and ship the item. Provide a time range in number of days. Lower bound cannot be less than 2 days
Acceptable: "20-30", "15-26"
Unacceptable: "1-2", "0", "7-7"
sizeThe size of the variation, especially as it pertains to apparel, footwear, or jewelry. It must be either a number or in the list of currently accepted sizes
Acceptable: "S", "XXL", "6", "6.5"
Unacceptable: "small", "S, M"
skuRequiredThe unique identifier that your system uses to recognize this variation.
Acceptable: "HSC0424PP", "112123343455432".
Unacceptable: "2", "a".

Returns

If the request was successful and a Variant was added to the supplied Product, then the response will contain the variant created along with its Joom identifier.

Example

Assume your access token is “an_example_access_token”. If you have a product with a parent SKU “red-shoe” and you would like to add a variant for the size “12”, with SKU “red-shoe-12”, your parameters would be:

parent_sku = "red-shoe"
sku = "red-shoe-12"
inventory = "10"
price = "10"
shipping = "3"
access_token = "an_example_access_token"
size = "12"

Example Request

> curl https://api-merchant.joom.it/api/v2/variant/add -d "parent_sku=red-shoe&sku=red-shoe-12&inventory=10&price=10&size=12&shipping=3&access_token=an_example_access_token"

Example Response

{
  "code": 0,
  "data": {
    "Variant": {
      "enabled": "True",
      "id": "529e6c2cf94aaa0cfe02846f",
      "inventory": "10",
      "price": "10",
      "shipping": "3",
      "size": "12",
      "sku": "red-shoe-12"
    }
  },
 "msg" : ""
}

Retrieve a Product Variation

Retrieves the details of an existing product variation. Provide the SKU of the product variation and Joom will return details about the corresponding product variation.

GET
https://api-merchant.joom.it/api/v2/variant
Parameters
NameDescription
skuThe unique identifier of the item in your system

Returns

For successful requests the response will contain a Variant object in the requested format.

Example

Assume your access token is “an_example_access_token”. If your store has an item with SKU “red-shoe-8” and you would like to know its state on with your request's parameters would be:

sku = "red-shoe-8"
access_token = "an_example_access_token"

Example Request

> curl "https://api-merchant.joom.it/api/v2/variant?sku=red-shoe-8&access_token=an_example_access_token"

Example Response

{
  "code": 0,
  "data": {
    "Variant": {
      "enabled": "True",
      "id": "51e0a2c61111a236cfffe3a2",
      "product_id" : "51e0a2c61111axxxcfffeyyy",
      "inventory": "10100",
      "msrp": "21100.0",
      "price": "100.0",
      "shipping": "10.0",
      "sku": "red-shoe-8"
    }
  },
  "message": ""
}

Update a Product Variation

Updates the specified variation by updating the attributes of the parameters passed in the request. Any attribute not provided will be left unchanged.

This request can only update attributes specific to variations and cannot be used to update any attribute of a Product.

POST
https://api-merchant.joom.it/api/v2/variant/update
Parameters
NameRequiredDescription
colorThe color of the variation, especially as it pertains to apparel or jewelry. If you would like to have it show two colors (eg. “black and red”), simply separate the colors by “&” (eg. “black & red”). Note: not to be confused with products having two different colored variations. The name of the color must be in the list of currently accepted colors
Acceptable: "red", "black & blue"
Unacceptable: "red, blue", "black & blue & green"
enabled"True" if the variation is for sale, "False" if you need to halt sales
inventoryThe physical quantities you have for this variation, max 100,000
main_imageURL of a photo for this variant. Provide this when you have different pictures for different variant of the product. If left out, it'll use the main_image of the product with the provided parent_sku. Link directly to the image, not the page where it is located. We accept JPEG, PNG or GIF format. Images should be at least 550×550 pixels in size
msrpThe Manufacturer Suggested Retail Price of the variation. This field is recommended as it will show as a strike-thru price on Joom and appears above the selling price for the product. It should contain no additional text
Acceptable: "$19.00", "19.99"
Unacceptable: "19.99 + S/H"
priceThe price of the variation when the user purchases one.
Acceptable: "$100.99", "10.99"
Unacceptable: "$49.99 + S/H"
shippingThe shipping price of the variation when the user purchases one

Acceptable: "$4.00", "4.99"
Unacceptable: "$4.99 + S/H"
shipping_timeThe amount of time it takes for the shipment to reach the buyer. Please also factor in the time it will take to fulfill and ship the item. Provide a time range in number of days. Lower bound cannot be less than 2 days
Acceptable: "20-30", "15-26"
Unacceptable: "1-2", "0", "7-7"
sizeThe size of the variation, especially as it pertains to apparel, footwear, or jewelry. It must be either a number or in the list of currently accepted sizes
Acceptable: "S", "XXL", "6", "6.5"
Unacceptable: "small", "S, M"
skuRequiredThe unique identifier for the variation you would like to update

Returns

If the request was successful the API will return an HTTP status code of 200 and a status code of 0.

Example

Assume your access token is “an_example_access_token”. If you have an item with the SKU “blue-shoe-11” and it has the wrong size and you need to update its price, shipping and inventory your parameters would be:

sku = "blue-shoe-11"
price = "10.11"
shipping = "10.00"
inventory = "1000"
access_token = "an_example_access_token"

Lets say you didn't need to update price, then you would omit this parameter from your request.

Example Request

> curl https://api-merchant.joom.it/api/v2/variant/update -d "sku=blue-shoe-11&price=10.11&inventory=1000&shipping=10.00&access_token=an_example_access_token"

Example Response

{
  "code": 0,
  "data": {},
  "message": ""
}

Change a Product Variation's SKU

Change a variantion's unique identifier, the new identifier must also be unique within all SKUs of the merchant.

POST
https://api-merchant.joom.it/api/v2/variant/change-sku
Parameters
NameDescription
skuThe unique identifier for the variation you would like to change
new_skuThe new unique identifier for the variation you would like to change to

Returns

If the request was successful the API will return an HTTP status code of 200 and a status code of 0.

Example

Assume your access token is “an_example_access_token”. If you have an item with the SKU “blue-shoe-11” and you would like to change it to “blue-shoe-12” your parameters would be:

sku = "blue-shoe-11"
new_sku = "blue-shoe-12"
access_token = "an_example_access_token"

Example Request

> curl https://api-merchant.joom.it/api/v2/variant/change-sku -d "sku=blue-shoe-11&new_sku=blue-shoe-12&access_token=an_example_access_token"

Example Response

{
  "code": 0,
  "data": {},
  "message": ""
}

Enable a Product Variation

Enable a product variation. This marks the product variation available for sale.

POST
https://api-merchant.joom.it/api/v2/variant/enable
Parameters
NameDescription
skuThe unique identifier for the item you would like to update

Returns

If the request was successful the API will return an HTTP status code of 200 and a status code of 0.

Example

Assume your access token is “an_example_access_token”. If you have an item with the SKU “blue-shoe-11” and you want to enable it, your parameters would be:

sku = "blue-shoe-11"
access_token = "an_example_access_token"

Example Request

> curl https://api-merchant.joom.it/api/v2/variant/enable -d "sku=blue-shoe-11&access_token=an_example_access_token"

Example Response

{
  "code": 0,
  "data": {},
  "message": ""
}

Disable a Product Variation

Disable a product variation. This marks the product variation unavailable for sale.

POST
https://api-merchant.joom.it/api/v2/variant/disable
Parameters
NameDescription
skuThe unique identifier for the item you would like to update

Returns

If the request was successful the API will return an HTTP status code of 200 and a status code of 0.

Example

Assume your access token is “an_example_access_token”. If you have an item with the SKU “blue-shoe-11” and you want to disable it, your parameters would be:

sku = "blue-shoe-11"
access_token = "an_example_access_token"

Example Request

> curl https://api-merchant.joom.it/api/v2/variant/disable -d "sku=blue-shoe-11&access_token=an_example_access_token"

Example Response

{
  "code": 0,
  "data": {},
  "message": ""
}

Update Inventory

Update inventory for a product variation.

POST
https://api-merchant.joom.it/api/v2/variant/update-inventory
Parameters
NameDescription
skuThe unique identifier for the item you would like to update
inventoryThe physical number of items you have, max 100,000

Returns

If the request was successful the API will return an HTTP status code of 200 and a status code of 0.

Example

Assume your access token is “an_example_access_token”. If you have an item with the SKU “blue-shoe-11” and you want to update the inventory to 100, your parameters would be:

sku = "blue-shoe-11"
access_token = "an_example_access_token"
inventory = 100

Example Request

> curl https://api-merchant.joom.it/api/v2/variant/update-inventory -d "sku=blue-shoe-11&inventory=100&access_token=an_example_access_token"

Example Response

{
  "code": 0,
  "data": {},
  "message": ""
}

List all Product Variations

Returns a list of all your product variations currently on the Joom platform. This API is useful to paginate through all the SKUs that you have uploaded to Joom. If the number of results is too large the full result set may require pagination.

GET
https://api-merchant.joom.it/api/v2/variant/multi-get
Parameters
NameRequiredDescription
startAn offset into the list of returned items. Use 0 to start at the beginning. The API will return the requested number of items starting at this offset. Default to 0 if not supplied
limitRequiredA limit on the number of products that can be returned. Limit can range from 1 to 500 items and the default is 50

Returns

For successful requests the response data will contain a list of product variation objects. If the response requires pagination the paging field will contain the URL for the next page of results.

Example

Assume your access token is “an_example_access_token”. If you would like to fetch information about all your items in groups of 2 and you would like to see the 10th group:

start = 20
limit = 2
access_token = "an_example_access_token"

Example Request

> curl "https://api-merchant.joom.it/api/v2/variant/multi-get?limit=2&start=20&access_token=an_example_access_token"

Example Response

{
  "code": 0,
  "data": [
    {
      "Variant": {
        "enabled": "True",
        "id": "5215451b31111f73ff2xxxxxx",
        "product_id" : "51e0a2c61111axxxcfffeyyy",
        "inventory": "1314",
        "msrp": "150.0",
        "price": "100.0",
        "shipping": "21.0",
        "sku": "MMM"
      }
    },
    {
      "Variant": {
        "color": "blue",
        "enabled": "True",
        "id": "5214c1111c238837cdiiiiii",
        "product_id" : "51e0a2c61111axxxcfffeyyy",
        "inventory": "917",
        "msrp": "100.0",
        "price": "50.0",
        "shipping": "9.81",
        "sku": "DD1111"
      }
    }
  ],
  "message": "",
  "paging": {
    "next": "https://api-merchant.joom.it/api/v2/variant/multi-get?start=22&limit=2&access_token=an_example_access_token",
    "previous": "https://api-merchant.joom.it/api/v2/variant/multi-get?start=18&limit=2&access_token=an_example_access_token"
  }
}

Order

For every item that a user purchases from your store there is a corresponding Order. Each order corresponds with one SKU. The order object provides you with the destination, item and any other required information to fulfill a user's order.

With this API you can fetch order that require fulfillment and orders that have been updated since a given period. This API also allows you to fulfill one order at a time by providing tracking information for an order.

Order State

Orders can be in several different states depending on what has happened. State "APPROVED" means that the order is ready to ship. State "SHIPPED" means that the order has been marked as shipped by you. State "REFUNDED" means that the order has been refunded to the user and should not be fulfilled. State "REQUIRE_REVIEW" means that the order is under review for fraudulent activity and should not be fulfilled.

Other Order Attributes
NameDescription
order_idJoom's unique identifier for the order
buyer_idJoom's unique identifier for the buyer of the order
transaction_idOrders can be grouped under unique identifiers if the user makes several purchases at once
order_timeThe UTC date and time of when the order was placed
last_updatedThe UTC date and time of the last update to the order (for example, the last change in state)
stateThe state of the order. This value can be: "APPROVED", "SHIPPED", "REFUNDED", "REQUIRE_REVIEW"
costThe amount of money that Joom pays you for the product (per unit)
shipping_costThe amount of money that Joom pays you for shipping the product (per unit)
order_totalThe total value of the order
product_idJoom's unique identifier for the Product being ordered
product_nameThe name of the product
product_image_urlThe image of the product
variant_idJoom's unique identifier for the Product Variation that was ordered
skuThe unique identifier of the item in your system
priceThe price of the item when the user purchases one
shippingThe amount of money user pays for shipping for the product (per unit)
quantityThe number of units that the user has purchased
colorThe color of the item that was ordered (if applicable)
sizeThe size of the item that was ordered (if applicable)
days_to_fulfillNumber of days left to fulfill this order. Order not fulfilled will be automatically refunded.
hours_to_fulfillNumber of hours left to fulfill this order. Order not fulfilled will be automatically refunded.
shipped_dateThe date when the order was marked as shipped
shipping_providerThis is the courier that has been used to ship the package
tracking_numberThis is the number a user can use to track their package with your carrier
shipping_timeThe amount of time it takes for the shipment to reach the buyer. Provide a time range in number of days
shipping_detailContainer for all the details about how to ship the order to its destination
ship_noteThe note to the user when you marked the order as shipped (if applicable)
refunded_byA description of who refunded the order
refunded_timeThe UTC time when the order was refunded
refunded_reasonThe reason the order was refunded
refunded_note
Shipping Detail Attributes
NameDescription
nameThe name of the person who this order is being shipped to
street_address1The street address the order is to be shipped to
street_address2Extra street address information about the package's destination
cityThe city name of where the order should be delivered
stateThe state/region where the order should be delivered
countryThe country where the order should be delivered
zipcodeThe zipcode/postal code of the address where the order is to be delivered
phone_numberThe phone number for the carrier to call in the case of missed deliveries

Retrieve an Order

Retrieves the details of an existing order. Supply the unique identifier for the order and if one exists this API will return the corresponding order. Each order will have all the information you need to fulfill it.

GET
https://api-merchant.joom.it/api/v2/order
Parameters
NameDescription
idJoom's unique identifier for the order (order_id in the Order object)

Returns

If there exists an order with the ID provided for your account then the API returns a full order object in the response.

Example

Assume your access token is “an_example_access_token”. If you have an order with order_id “123456789009876543210164” and you would like to retrieve any updates to it:

id = "123456789009876543210164"
access_token = "an_example_access_token"

Example Request

> curl "https://api-merchant.joom.it/api/v2/order?id=123456789009876543210164&access_token=an_example_access_token"

Example Response

{
  "code": 0,
  "data": {
    "Order": {
      "ShippingDetail": {
        "city": "North Bay",
        "country": "US",
        "name": "Mick Berry",
        "phone_number": "+1 555-181-7247",
        "state": "NC",
        "street_address1": "2126 PO Box 5 Rt 49",
        "zipcode": "13123"
      },
      "last_updated": "2013-12-06T20:20:20",
      "order_time": "2013-12-06T20:20:20",
      "order_id": "123456789009876543210164",
      "order_total": "17.6",
      "product_id": "1113fad43deaf71536cb2c74",
      "buyer_id": "1234fad43deaf71536cb2c74",
      "quantity": "2",
      "price": "8",
      "cost": "6.8",
      "shipping": "2.35",
      "shipping_cost": "2",
      "product_name": "Dandelion Necklace",
      "product_image_url": "http://d1zog42tnv26ho.cloudfront.net/4fea11fac43bf532f4001419-normal.jpg",
      "days_to_fulfill": "2",
      "hours_to_fulfill": "49",
      "sku": "Dandelion Necklace",
      "state": "APPROVED",
      "transaction_id": "11114026a99e980d4e500269",
      "variant_id": "1111fad63deaf71536cb2c76"
    }
  },
 "message": ""
}

Retrieve Recently Changed Orders

Returns all orders that have changed state since the date and time requested. Use this API to keep your orders processing system in sync with Joom. This API takes a parameter since and returns all orders that were updated since this time.

GET
https://api-merchant.joom.it/api/v2/order/multi-get
Parameters
NameRequiredDescription
startOptionalAn offset into the list of returned items. Use 0 to start at the beginning. The API will return the requested number of items starting at this offset. Default to 0 if not supplied
limitOptionalA limit on the number of products that can be returned. Limit can range from 1 to 500 items and the default is 50
sinceOptionalCollect all the orders that have been updated since the time value passed into this parameter (UTC). Fetches from beginning of time if not specified. We accept 2 formats, one with precision down to day and one with precision down to seconds. Example: Jan 20th, 2014 is "2014-01-20", Jan 20th, 2014 20:10:20 is "2014-01-20T20:10:20"

Returns

This API returns all the orders that have been updated since the datetime from the since parameter (UTC) ordered by order time starting with the offset start up to the parameter limit. For example, if there are 1000 orders since May 1, 2013 and start is 100, while limit is 50, this API will return the 100th order to the 149th order.

Example

Assume your access token is “an_example_access_token”. If you use this API to sync Joom orders into your order tracking software and you need all the orders that have changed since Jan 20, 2014 and you would like them in pages of 100 and you need the second page:

start = 200
limit = 100
since = "2014-01-20"
access_token = "an_example_access_token"

Example Request

> curl "https://api-merchant.joom.it/api/v2/order/multi-get?start=200&limit=100&since=2014-01-20&access_token=an_example_access_token"

Example Response

{
  "code": 0,
  "data": [
    {
      "Order": {
        "ShippingDetail": {
          "city": "New York City",
          "country": "US",
          "name": "Guadalupe Smith",
          "phone_number": "5554191609",
          "state": "California",
          "street_address1": "3317 w 51st Street",
          "zipcode": "60632"
        },
        "last_updated": "2014-01-20T20:20:20",
        "order_time": "2014-01-20T20:20:20",
        "order_id": "123456789009876543210164",
        "order_total": "17.6",
        "product_id": "1113fad43deaf71536cb2c74",
        "buyer_id": "1234fad43deaf71536cb2c74",
        "quantity": "2",
        "price": "8",
        "cost": "6.8",
        "shipping": "2.35",
        "shipping_cost": "2",
        "product_name": "Dandelion Necklace",
        "product_image_url": "http://d1zog42tnv26ho.cloudfront.net/4fea11fac43bf532f4001419-normal.jpg",
        "days_to_fulfill": "2",
        "hours_to_fulfill": "49",
        "sku": "Dandelion Necklace",
        "state": "APPROVED",
        "transaction_id": "11114026a99e980d4e500269",
        "variant_id": "1111fad63deaf71536cb2c76"
      }
    },
    {
      "Order": {
        "ShippingDetail": {
          "city": "Lake City",
          "country": "US",
          "name": "Marko Schroeder",
          "phone_number": "+1 555-399-7785",
          "state": "NY",
          "street_address1": "20685 W Verona Ave",
          "zipcode": "60046"
        },
        "last_updated": "2014-01-20T20:20:20",
        "order_time": "2014-01-20T20:20:20",
        "order_id": "1114a7cfb2ec2d42d272b627",
        "order_total": "17.6",
        "product_id": "1113fad43deaf71536cb2c74",
        "buyer_id": "1234fad43deaf71536cb2c74",
        "quantity": "2",
        "price": "8",
        "cost": "6.8",
        "shipping": "2.35",
        "shipping_cost": "2",
        "product_name": "Dandelion Necklace",
        "product_image_url": "http://d1zog42tnv26ho.cloudfront.net/4fea11fac43bf532f4001419-normal.jpg",
        "days_to_fulfill": "2",
        "hours_to_fulfill": "2",
        "sku": "Dandelion Necklace",
        "state": "APPROVED",
        "transaction_id": "11114026a99e980d4e500269",
        "variant_id": "1111fad63deaf71536cb2c76"
      }
    }
  ],
 "message": "",
 "paging": {
    "next": "https://api-merchant.joom.it/api/v2/order/multi-get??start=300&limit=100&since=2014-01-20&access_token=an_example_access_token",
    "previous": "https://api-merchant.joom.it/api/v2/order/multi-get?start=100&limit=100&since=2014-01-20&access_token=an_example_access_token"
  }
}

Retrieve Unfulfilled Orders

Returns all orders that currently require fulfillment. This API takes no parameters but may require pagination if the number of orders is too large.

GET
https://api-merchant.joom.it/api/v2/order/get-fulfill
Parameters
NameRequiredDescription
startOptionalAn offset into the list of returned items. Use 0 to start at the beginning. The API will return the requested number of items starting at this offset. Default to 0 if not supplied
limitOptionalA limit on the number of products that can be returned. Limit can range from 1 to 500 items and the default is 50
sinceOptionalCollect all the orders that have been updated since the time value passed into this parameter (UTC). Fetches from beginning of time if not specified. We accept 2 formats, one with precision down to day and one with precision down to seconds. Example: Jan 20th, 2014 is "2014-01-20", Jan 20th, 2014 20:10:20 is "2014-01-20T20:10:20"

Returns

Returns a list of all order that currently require fulfillment that's updated since since (UTC). If the list of orders is longer than limit the results will require pagination.

Example

Assume your access token is “an_example_access_token”. If you want to get all the orders which still require fulfillment in pages of 100:

start = 0
limit = 100
access_token = "an_example_access_token"

Example Request

> curl "https://api-merchant.joom.it/api/v2/order/get-fulfill?start=0&limit=100&access_token=an_example_access_token"

Example Response

{
  "code": 0,
  "data": [
    {
      "Order": {
        "ShippingDetail": {
          "city": "New York City",
          "country": "US",
          "name": "Guadalupe Smith",
          "phone_number": "5554191609",
          "state": "California",
          "street_address1": "3317 w 51st Street",
          "zipcode": "60632"
        },
        "last_updated": "2014-01-20T20:20:20",
        "order_time": "2014-01-20T20:20:20",
        "order_id": "123456789009876543210164",
        "order_total": "17.6",
        "product_id": "1113fad43deaf71536cb2c74",
        "buyer_id": "1234fad43deaf71536cb2c74",
        "quantity": "2",
        "price": "8",
        "cost": "6.8",
        "shipping": "2.35",
        "shipping_cost": "2",
        "product_name": "Dandelion Necklace",
        "product_image_url": "http://d1zog42tnv26ho.cloudfront.net/4fea11fac43bf532f4001419-normal.jpg",
        "days_to_fulfill": "2",
        "hours_to_fulfill": "49",
        "sku": "Dandelion Necklace",
        "state": "APPROVED",
        "transaction_id": "11114026a99e980d4e500269",
        "variant_id": "1111fad63deaf71536cb2c76"
      }
    },
    {
      "Order": {
        "ShippingDetail": {
          "city": "Lake City",
          "country": "US",
          "name": "Marko Schroeder",
          "phone_number": "+1 555-399-7785",
          "state": "NY",
          "street_address1": "20685 W Verona Ave",
          "zipcode": "60046"
        },
        "last_updated": "2014-01-20T20:20:20",
        "order_time": "2014-01-20T20:20:20",
        "order_id": "1114a7cfb2ec2d42d272b627",
        "order_total": "17.6",
        "product_id": "1113fad43deaf71536cb2c74",
        "buyer_id": "1234fad43deaf71536cb2c74",
        "quantity": "2",
        "price": "8",
        "cost": "6.8",
        "shipping": "2.35",
        "shipping_cost": "2",
        "product_name": "Dandelion Necklace",
        "product_image_url": "http://d1zog42tnv26ho.cloudfront.net/4fea11fac43bf532f4001419-normal.jpg",
        "days_to_fulfill": "2",
        "hours_to_fulfill": "49",
        "sku": "Dandelion Necklace",
        "state": "APPROVED",
        "transaction_id": "11114026a99e980d4e500269",
        "variant_id": "1111fad63deaf71536cb2c76"
      }
    }
  ],
 "message": "",
 "paging": {
    "next": "https://api-merchant.joom.it/api/v2/order/get-fulfill?start=100&limit=100&access_token=an_example_access_token"
  }
}

Fulfill an Order

Fulfills an order in the Joom system. Call this API once you have shipped the item to the recipient. Joom will notify the user their order has been shipped upon completion of this request.

POST
https://api-merchant.joom.it/api/v2/order/fulfill-one
Parameters
NameRequiredDescription
idRequiredJoom's unique identifier for the order, or order_id in the Order object
ship_noteA note to the user when you marked the order as shipped
shipping_timeRequiredThe amount of time it takes for the shipment to reach the buyer. Provide a time range in number of days. Lower bound cannot be less than 2 days
tracking_numberThe unique identifier that your carrier provided so that the user can track their package as it is being delivered. Tracking number should only contain alphanumeric characters with no space between them
tracking_providerRequiredThe carrier that will be shipping your package to its destination. See list of accepted providers

Returns

If the order is in the "APPROVED" state, the order is not already fulfilled and all the parameters are correct, the API will mark the order as shipped and return a HTTP status code of 200.

Example

Assume your access token is “an_example_access_token”. Use this if you have shipped an order to a user and would like to mark it shipped on Joom. If the order's order_id is “098765432112345678901234”, the tracking number is “12345679” and the provider is USPS:

id = "098765432112345678901234"
tracking_provider = "USPS"
tracking_number = "12345678"
access_token = "an_example_access_token"

Example Request

> curl https://api-merchant.joom.it/api/v2/order/fulfill-one -d "tracking_provider=USPS&tracking_number=12345679&id=098765432112345678901234&access_token=an_example_access_token"

Example Response

{
  "code": 0,
  "data": {
    "success": "True"
  },
  "message": "Your order is been processed right now!"
}

Refund/Cancel an order

Refund/Cancel an order in the Joom system. Call this API if you cannot fulfill the order for any reason. Joom will notify the user their order has been cancelled shipped and refund them upon completion of this request.

POST
https://api-merchant.joom.it/api/v2/order/refund
Parameters
NameRequiredDescription
idRequiredJoom's unique identifier for the order, or order_id in the Order object
reason_codeRequiredAn integer representing the reason for the refund. Check the table between for accepted reason codes
reason_noteA note to the user explaining reason for the refund. This field is required if reason_code is -1 (other)
Refund Reason Codes
CodeDescription
1Store is unable to fulfill order
2Product is out of stock
3Customer provided the wrong address information

Returns

If the order is not already refunded and all the parameters are correct, the API will mark the order as refunded and return a HTTP status code of 200.

Example

Assume your access token is “an_example_access_token”. If you want to refund the order with order_id “098765432112345678901234” because you are out of inventory.

id = "098765432112345678901234"
reason_code = 18
access_token = "an_example_access_token"

Example Request

> curl https://api-merchant.joom.it/api/v2/order/refund -d "reason_code=18&id=098765432112345678901234&access_token=an_example_access_token"

Example Response

{
  "code": 0,
  "data": {
    "success": "True"
  },
  "message": ""
}

Modify Tracking of a Shipped Order

Update tracking information about an order. Call this to change the tracking number or provider for an order that has already been marked shipped.

POST
https://api-merchant.joom.it/api/v2/order/modify-tracking
Parameters
NameRequiredDescription
idRequiredJoom's unique identifier for the order, or order_id in the Order object
tracking_numberThe unique identifier that your carrier provided so that the user can track their package as it is being delivered. Tracking number should only contain alphanumeric characters with no space between them
tracking_providerRequiredThe carrier that will be shipping your package to its destination. See list of accepted providers

Returns

If the order is in the "SHIPPED" state, and all the parameters are correct, the API will update the tracking information of that order and return a HTTP status code of 200.

Example

Assume your access token is “an_example_access_token”. Suppose you want to update the order with order_id “098765432112345678901234” to have tracking_provider of “USPS” and tracking number of “12345678”:

id = "098765432112345678901234"
tracking_provider = "USPS"
tracking_number = "12345678"
access_token = "an_example_access_token"

Example Request

> curl https://api-merchant.joom.it/api/v2/order/modify-tracking -d "tracking_provider=USPS&tracking_number=12345678&id=098765432112345678901234&access_token=an_example_access_token"

Example Response

{
  "code": 0,
  "data": {
    "success": "True"
  },
  "message": ""
}

Accepted Shipping Providers

  • 4PX
  • BVP Logistics (无忧物流)
  • Buy Logic International (捷买送)
  • China Post (中国邮政)
  • DHL
  • EMS
  • Holland Post (荷兰邮政)
  • Hongkong DGM (香港DGM)
  • Hongkong Post (香港邮政)
  • Hungary Post (匈牙利邮政)
  • JET e-commerce logistics (捷特电商物流)
  • Malasia Post (马来西亚邮政)
  • Quanzhou Post (泉州邮局)
  • Ruston (俄速通物流)
  • SFC Service Ltd (三态物流)
  • SFExpress (顺丰物流)
  • SPSR (SPSR快递)
  • Singapore Post (新加坡邮政)
  • Sunyou Post (顺邮宝)
  • Suzhou Post (苏州邮局)
  • Swiss Post (瑞士邮政)
  • Turkey Post (土耳其邮政)
  • XFL Express (小飞龙平邮)
  • Yanwen Express (燕文物流)
  • Yishida Post (易时达物流)
  • Yun Express (云途物流)