In This Article
General Notes
- We prefer camelCase.
- However, we do convert all fields to camelCase in the backend. As such the following field name constructs are accepted:
- asking_price
- asking-price
- asking price
- Asking Price
- However, we do convert all fields to camelCase in the backend. As such the following field name constructs are accepted:
- We provide a bearer token in your inventory management settings. This token should be included in the Authorization header.
- We accept both application/json and application/xml
-
The JSON should have the root key content and will have the array of listing attributes as its value.
-
XML Payload example
-
Required Fields for Inventory Feed
The following Listing Creation fields are supported via our API.
| Field | Notes | Accepted Values |
|---|---|---|
|
sku |
Your internal product ID. This allows us to map the Audiogon listing to your external system. If not provided, we use Model as fallback. If neither provided, this item will fail. |
Text |
| title |
Product Title |
Text |
| category | Categories are mapped to a Category ID. Refer to Taxonomy Support Article. |
Number |
| askingPrice | Asking price of your item in dollars. |
Number (e.g. 1500) |
| description | Listing description with support for basic HTML. |
Text/HTML |
| condition | 1-10 Rating based on Audiogon Grading Scale. For New items use New or 11. |
Number (1-11, New) |
| imagesUrl | URL of externally-hosted images. Separate multiple values with a comma. Maximum of 10. |
Text/URL |
Optional Fields
| Field | Notes | Accepted Values |
|---|---|---|
| brand |
Brand name of item. Exact matches will create association in Bluebook database. |
Text |
| model | Model of the item. Exact matches will create association in Bluebook database. |
Text |
| quantity |
Default is 1 if not provided. By setting quantity greater than 1, we will continue to re-list and sell the item until the quantity reaches 0. Additional listing fees may be incurred depending on your subscription. Quantity of 0 marks item as "Out-of-Stock." Listing remains active. You may force a listing to end by using a quantity of -1 |
Number (e.g. 20) |
| videoUrl | YouTube URL of a review or product overview video. |
Text |
| retailPrice | The cost paid for your item at retail stores in dollars. |
Number (e.g. 1500) |
| offerReservePrice | Set a reserve price in dollars that offers must be above. Offers below this price are automatically rejected. Read More. |
Number (e.g. 1000) |
|
offerAutoAcceptPrice |
Automatically accept offer equal to or greater than this price in dollars. Offers below this amount can still be sent, provided they are above your Offer Reserve Price if set. Read More. |
Number (e.g. 1000) |
Additional Fields
| Field | Notes | Accepted Values |
|---|---|---|
| demoUnit |
Denotes this item was a demo unit. |
Boolean: TRUE/FALSE |
| hasOriginalBox | Denotes if this item comes with its original packaging. |
Boolean: TRUE/FALSE |
| hasRemoteControl | Denotes if this item comes with its Remote Control. |
Boolean: TRUE/FALSE |
| hasOwnersManual | Denotes if this item comes with its Owner's Manual. |
Boolean: TRUE/FALSE |
| contactForPrice | Enabling this option helps with MAP Compliance by not displaying the price on Audiogon. This will require buyers to contact you for the price of your item. Sales are conducted with an offer. Not compatible with True values for Buy It Now, Accept Offers, and Actual Cost Shipping. |
Boolean: TRUE/FALSE |
| allowBuyItNow | Allow users to add the item to their cart and purchase immediately. |
Boolean: TRUE/FALSE |
| acceptOffers | Allow Buyers to send you an offer that you can accept or counter. |
Boolean: TRUE/FALSE |
| shipTo | Sets shipping countries: USA, USA & Canada, International. |
US, CAN, ALL |
| bold | Add Bold title upgrade to listing. No need to include if custom upgrade options are part of your subscription. |
Boolean: TRUE/FALSE |
| thumbnailGallery | Add a Thumbnail in Classic View, and a Scrollable Image Carousel on Grid and Listing View. No need to include if custom upgrade options are part of your subscription. |
Boolean: TRUE/FALSE |
| featured | Add Featured upgrade (bolded, and displayed on our homepage, on category pages and in our Forums.) No need to include if custom upgrade options are part of your subscription. |
Boolean: TRUE/FALSE |
| shippingLocalPickupOnly | Local Pickup Only. If true, no need to pass the fields below. | Boolean: TRUE/FALSE |
| shippingCarrier | Supported Carriers. Separate multiple carriers by comma. Supported carriers are UPS, USPS, and FedEx. | e.g. "UPS,USPS,FedEx", "UPS", "UPS,FedEx", etc |
| shippingOfferLocalPickup | Allow Local Pickup | Boolean: TRUE/FALSE |
| shippingIsFree | Declare Free Shipping. If true, no need to pass the fields below. | Boolean: TRUE/FALSE |
| shippingFixedCost | Fixed Cost Shipping Amount. If true, below two fields are required. | Number (e.g. 35.00) |
| shippingIntlCost | Added cost for International shipping. Required if shippingFixedCost is true. | Number (e.g. 35.00) |
| shippingCost | The actual shipping amount buyer is to pay in dollars. Required if shippingFixedCost is true. | Number (e.g. 35.00) |
| shippingAfterSaleCost | Cost will be specified by seller after sale. |
Boolean: TRUE/FALSE |
| shippingDynamicCost | Actual Cost Shipping. Dimension fields below required. Cost is calculated via EasyPost API based on buyer's shipping zip code. | Boolean: TRUE/FALSE |
| length | Required for Actual Cost Shipping Estimates. Length of shipping box in inches. Supports decimals. |
Number (e.g. 10.0) |
| width | Required for Actual Cost Shipping Estimates. Width of shipping box in inches. Supports decimals. |
Number (e.g. 10.0) |
| height | Required for Actual Cost Shipping Estimates. Height of shipping boxin inches. Supports decimals. |
Number (e.g. 10.0) |
| weight |
Required for Actual Cost Shipping Estimates. Weight of shipping box. Must be in pounds (lbs). Supports decimals. We currently do not support a separate measurement field so if your system stores weight in oz or kg, it will need to be converted. |
Number (e.g. 10.00) |
|
priceQtyUpdateOnly |
When set to true only update price and quantity for a given SKU. Does not update any other fields. |
Boolean: TRUE/FALSE |
Comments
0 comments
Article is closed for comments.