FAQIntroduction
    Community
    Open-source integrationsClosed-source integrations

    Modify a low volume listing in marketplace

    This endpoint is used for managing marketplace low volume listings on Shopiro. It supports POST requests for creating, updating, or retrieving listings.

    POST https://shopiro.ca/api/v1/marketplace/listings/manage?lid={listing_encoded_id}

    Request Parameters

    • lid: The encoded listing ID. (Required)
    • san: Save the listing as a new entity. (Optional)
    • listing: The listing data in JSON format. (Optional)
    Response Structure

    Response Structure

    The response will be a JSON object indicating the outcome of the listing management request.

    • success: Indicates successful listing creation or update. Contains details like 'field_errors' and 'slid' (encoded listing ID).
    • failed: Describes the reason for failure, such as 'SLID bad format', 'Failed retrieving listing', 'Listing is not marketplace low volume market segment', or 'Unknown'.

    Listing Object

    Type
    String indicating the type of listing (e.g., "marketplace_low_volume").
    Subtype
    String indicating a more specific category within the main type, if any.
    Shipping Data

    Object containing shipping-related information:

    • x_dimension, y_dimension, z_dimension: Numeric values for product dimensions.
    • Weight: Numeric value for the product's weight.
    • Handling Time: Object with domestic and international handling times.
    • Warehouses: Array of warehouses with details like location, coordinates, and shipping methods.
    Inventory Data

    Object with inventory details:

    • Cumulative Quantity: Total quantity of the item across all warehouses.
    • Warehouses: Array of warehouses with quantity details for each.
    Information
    Additional information about the listing (if any).
    Listing Type
    String confirming the type of listing.
    eListingID
    Unique identifier for the listing.
    Restrictions, Custom Reference
    Fields for additional constraints or custom identifiers (if any).
    Categories
    Object mapping numeric keys to category strings.
    Price History
    Object detailing the history of price changes.
    Creation Date
    Timestamp or string indicating the listing creation date.
    Is Draft
    Boolean indicating if the listing is a draft.
    Seller ID
    Numeric ID of the seller.
    Titles, Descriptions
    Objects mapping language codes to titles and descriptions in different languages.
    Metadata

    Object with additional metadata about the listing:

    • Price: Price of the item in USD.
    • Available Quantity: Number of items available.
    • Physical Condition: Object with condition type and comments.
    • Pictures: Array of picture identifiers.
    • Minor Variations: Object for product variations such as color, with titles and picture indexes.

    Listing object example

    { "type": "marketplace_low_volume", "subtype": "", "shipping_data": {"x_dimension": 20,"y_dimension": 5,"z_dimension": 20,"weight": 0.5,"handling_time": { "domestic": 0, "international": 0},"warehouses": [ {"country": "CA","subdivision": "CA-QC","postal_code": "G1W 2V7","latitude": null,"longitude": null,"methods": { "CA": {"any": { "1": "auto"} }} }] }, "inventory_data": {"cumulative_quantity": 3,"warehouses": [ {"quantity": 3,"country": "CA","subdivision": "CA-QC","postal_code": "G1W 2V7","latitude": null,"longitude": null }] }, "information": null, "listing_type": "marketplace_low_volume", "elistingid": "SA03PRKYDQOA", "restrictions": null, "custom_reference": [], "categories": {"0": "clothing","2": "shorts" }, "price_history": "{\"time\":{\"1700594072\":null}}", "creation_date": "2023-11-01 14:34:01", "is_draft": 0, "sellerid": 90000000, "titles": {"en-CA": "Men Urban Military Tactical Shorts Outdoor Waterproof Wear-Resistant Cargo Shorts Quick Dry Multi-pocket Plus Size Hiking Pants","fr-FR": "Men Urban Military Tactical Shorts Outdoor Waterproof Wear-Resistant Cargo Shorts Quick Dry Multi-pocket Plus Size Hiking Pants" }, "descriptions": {"en-CA": "Men Urban Military Tactical Shorts Outdoor Waterproof Wear-Resistant Cargo Shorts Quick Dry Multi-pocket Plus Size Hiking Pants","fr-FR": "Men Urban Military Tactical Shorts Outdoor Waterproof Wear-Resistant Cargo Shorts Quick Dry Multi-pocket Plus Size Hiking Pants" }, "metadata": {"price": 16.03,"available_quantity": 3,"physical_condition": { "type": "new", "comments": {"en-CA": null }},"pictures": [ "17-90A-142D-1935", "17-90A-142D-1936", "17-90A-142D-1936"],"minor_variations": { "variations": [{ "titles": {"en-CA": "Grey" }, "picture": 0},{ "titles": {"en-CA": "Black" }, "picture": 0} ], "type": "color"} }}

    Example Usage

    On this page
    Response Structure