/v1/retailers/$id/products/$marketplace

Download the latest product feed for the specified retailer and marketplace.

 

Request

Parameters

$id – unique retailer ID

$marketplace – unique marketplace ID

Example request

Not applicable

Example URL

http://api.omnivore.com.au/v1/retailers/fresh-beach-club/products/ebay

Response

Permitted response codes

GET: 200 OK, 404 Not found (e.g. bad retailer ID)

POST: 405 Method Not Allowed

PUT: 405 Method Not Allowed

DELETE: 405 Method Not Allowed

Example response

See Product Feed payload

 

v1/retailers/$id/jobs/all_products

Upload a full product feed for the specified retailer. NOTE: this will erase all products previously uploaded.

 Request

Parameters

$id – unique retailer ID

Example request

See Product Feed payload

Example URL

http://api.omnivore.com.au/v1/retailers/fresh-beach-club/jobs/all_products

Response

Permitted response codes

GET: 405 Method Not Allowed

POST: 202 OK, 404 Not found (e.g. bad retailer ID), 403 Forbidden (if more than 15 uploads are already queued for this retailer), 503 Service Unavailable (if system failed to store feed file, safe to retry)

PUT: 405 Method Not Allowed

DELETE: 405 Method Not Allowed

Example response

http://api.omnivore.com.au/v1/retailers/fresh-beach-club/jobs/12785/status

 

v1/retailers/$id/jobs/products

Upload a partial/delta product feed for the specified retailer. Previously uploaded products will NOT be purged by this call.

 Request

Parameters

$id – unique retailer ID

Example request

See Product Feed payload

Example URL

http://api.omnivore.com.au/v1/retailers/fresh-beach-club/jobs/products

Response

Permitted response codes

GET: 405 Method Not Allowed

POST: 202 OK, 404 Not found (e.g. bad retailer ID), 403 Forbidden (if more than 15 uploads are already queued for this retailer), 503 Service Unavailable (if system failed to store feed file, safe to retry)

PUT: 405 Method Not Allowed

DELETE: 405 Method Not Allowed

Example response

http://api.omnivore.com.au/v1/retailers/fresh-beach-club/jobs/12785/status

 

v1/retailers/$id/jobs/product_inventory

Upload an inventory feed for the specified retailer. Previously uploaded products will NOT be purged by this call.

 Request

Parameters

$id – unique retailer ID

Example request

See Product Feed payload

Example URL

http://api.omnivore.com.au/v1/retailers/fresh-beach-club/jobs/product_inventory

Response

Permitted response codes

GET: 405 Method Not Allowed

POST: 202 OK, 404 Not found (e.g. bad retailer ID), 403 Forbidden (if more than 15 uploads are already queued for this retailer), 503 Service Unavailable (if system failed to store feed file, safe to retry)

PUT: 405 Method Not Allowed

DELETE: 405 Method Not Allowed

Example response

http://api.omnivore.com.au/v1/retailers/fresh-beach-club/jobs/12785/status

 

/v1/retailers/$id/jobs/$job/status

Get the status of the upload job returned in the response body of one of the calls above.

Request

Parameters

$id – unique retailer ID

$job – unique job ID

Example request

Not applicable

Example URL

http://api.omnivore.com.au/v1/retailers/fresh-beach-club/jobs/12785/status

Response

Permitted response codes

GET: 200 OK, 404 Not found (e.g. bad retailer ID)

POST: 405 Method Not Allowed

PUT: 405 Method Not Allowed

DELETE: 405 Method Not Allowed

Example response

See Product Feed payload

 

Inventory Feed Payload

The following represents an inventory update.

<?xml version="1.0" encoding="utf-8"?>
<product_inventory_job xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="product-inventory-request-schema.xsd">
  <products>
    <product>
      <sku>xyz123</sku>
      <details>
        <detail>
          <retailer_ref>tx443</retailer_ref>
          <quantity>4</quantity>
        </detail>
      </details>
    </product>
  </products>
</product_inventory_job>

Product Feed Payload

The following represents a product in the Omnivore XML format.

<?xml version="1.0" encoding="utf-8"?>
<product_update_job xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="product-request-schema.xsd" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <products>
    <product featured="true" display_only="false" sale="false" new_product="false" new_feature="false" gift="false">
      <sku>agf1037724</sku>
      <brand>Clothing Co</brand>
      <product_name>Pass Me By Cardigan </product_name>
      <date_available_from>2012-06-25</date_available_from>
      <short_description>This gorgeous floral printed cardigan features a round neck and diamante buttons. Soft and comfortable to wear, the perfect piece for spring!</short_description>
      <detailed_description>75% Rayon 20% Nylon 5% Spandex Cold gentle hand wash</detailed_description>
      <categories>
        <category>w-knitwear-cardigans</category>
      </categories>
      <details>
        <detail default="true">
          <retailer_ref>agf1037724-Multi-6</retailer_ref>
          <prices>
            <price currency="AUD">
              <amount>11900</amount>
              <tax>1081</tax>
              <rrp>19900</rrp>
            </price>
          </prices>
          <quantity>0</quantity>
          <attributes>
            <colour>Floral</colour>
            <colour_description>Multi</colour_description>
            <size>XS</size>
            <size_description>6</size_description>
          </attributes>
          <shipping>
            <ship_options>
              <shipping_metric units="kg">10</shipping_metric>
              <ship_option>standard</ship_option>
              <ship_option>express</ship_option>
            </ship_options>
          </shipping>
          <media>
            <image_url default="true">http://shop.clothingco.com.au/media/catalog/product/a/g/agf1037724f_multi.jpg</image_url>
            <image_url>http://shop.clothingco.com.au/media/catalog/product/a/g/agf1037724b_multi.jpg</image_url>
          </media>
        </detail>
        <detail>
          <retailer_ref>agf1037724-Multi-8</retailer_ref>
          <prices>
            <price currency="AUD">
              <amount>11900</amount>
              <tax>1081</tax>
              <rrp>19900</rrp>
            </price>
          </prices>
          <quantity>0</quantity>
          <attributes>
            <colour>Floral</colour>
            <colour_description>Multi</colour_description>
            <size>S</size>
            <size_description>8</size_description>
          </attributes>
          <shipping>
            <shipping_metric units="kg">10</shipping_metric>
            <ship_options>
              <ship_option>standard</ship_option>
              <ship_option>express</ship_option>
            </ship_options>
          </shipping>
          <media>
            <image_url default="true">http://shop.clothingco.com.au/media/catalog/product/a/g/agf1037724f_multi.jpg</image_url>
            <image_url>http://shop.clothingco.com.au/media/catalog/product/a/g/agf1037724b_multi.jpg</image_url>
          </media>
        </detail>
        <detail>
          <retailer_ref>agf1037724-Multi-10</retailer_ref>
          <prices>
            <price currency="AUD">
              <amount>11900</amount>
              <tax>1081</tax>
              <rrp>19900</rrp>
            </price>
          </prices>
          <quantity>0</quantity>
          <attributes>
            <colour>Floral</colour>
            <colour_description>Multi</colour_description>
            <size>M</size>
            <size_description>10</size_description>
          </attributes>
          <shipping>
            <shipping_metric units="kg">10</shipping_metric>
            <ship_options>
              <ship_option>standard</ship_option>
              <ship_option>express</ship_option>
            </ship_options>
          </shipping>
          <media>
            <image_url default="true">http://shop.clothingco.com.au/media/catalog/product/a/g/agf1037724f_multi.jpg</image_url>
            <image_url>http://shop.clothingco.com.au/media/catalog/product/a/g/agf1037724b_multi.jpg</image_url>
          </media>
        </detail>
      </details>
    </product>
  </products>
  <deleted_products>
    <sku>xyz126</sku>
    <sku>xyz124</sku>
    <sku>xyz125</sku>
  </deleted_products>
</product_update_job>