API > Endpoints

Endpoints

  • /api/product

    DESCRIPTIONPARAMSREQUIRED PARAMSValid URLs
    Update or add a single product in the product table product_id (UNIQUE, primary key)
    price
    fid
    url
    name
    summary
    details
    category_id
    created
    updated
    ship_apply_to
    ordering
    meta_keywords
    variations
    image_url
    image_title

    show all 86 fields    		 api_key
    product_id or sku*

    * Omit product_id and sku to insert a new product. When sku is sent that doesn’t exist a new product is created.    		POST:
    https://{USERNAME}.shoppo.co.nz/api/product
    add a product
    https://{USERNAME}.shoppo.co.nz/api/product/1
    update product with product_id 1

    GET:
    https://{USERNAME}.shoppo.co.nz/api/product/?product_id=1...
    retrieve data for product with product_id 1
    https://{USERNAME}.shoppo.co.nz/api/product/?sku=ABC123...
    retrieve data for product with sku ABC123

    Remember to also include your API key!

  • /api/products

    The same as /api/product except more than one product may be returned in an array.

  • /api/category

    DESCRIPTIONPARAMSREQUIRED PARAMSValid URLs
    Update or add a single category in the category table category_id (UNIQUE, primary key)
    url
    name
    menu_title
    place
    fid
    layout
    state
    status_id (1=Enabled,2=Enabled but hide menu link,3=Disabled,4=Enabled (Wholesale only),5=Enabled but hide menu link and exclude from search results)
    created
    updated

    excluding 17 null fields    		 api_key
    category_id

    * Omit category_id to insert a new category.     		POST:
    https://{USERNAME}.shoppo.co.nz/api/category
    add a category
    https://{USERNAME}.shoppo.co.nz/api/category/1
    update category with category_id 1

    GET:
    https://{USERNAME}.shoppo.co.nz/api/category/?category_id=1...
    retrieve data for category with category_id 1

    Remember to also include your API key!

  • /api/categories

    The same as /api/category except more than one category may be returned in an array.

  • /api/contentor /api/information

    DESCRIPTIONPARAMSREQUIRED PARAMSValid URLs
    Update or add a single information page in the content table content_id (UNIQUE, primary key)
    place
    data
    time
    url
    title
    heading
    menu_title
    section
    enabled (1=Enabled,2=Enabled but hide menu link,3=Disabled,4=Enabled (Wholesale only)

    excluding 8 null fields    		 api_key
    content_id*

    * Omit content_id and include title to insert a new information page.     		POST:
    https://{USERNAME}.shoppo.co.nz/api/content
    add a content page
    https://{USERNAME}.shoppo.co.nz/api/content/1
    update content with content_id 1

    GET:
    https://{USERNAME}.shoppo.co.nz/api/content/?content_id=1...
    retrieve data for content with content_id 1
    https://{USERNAME}.shoppo.co.nz/api/content/?sku=ABC123...
    retrieve data for content with sku ABC123

    Remember to also include your API key!

  • /api/ordersor /api/transactions

    DESCRIPTIONPARAMSREQUIRED PARAMSValid URLs
    Get orders from transaction table or update a single order status
    p = Pending
    h = On Hold
    f = Fulfilled
    a = Fulfilled (awaiting payment)
    v = Void
    x = Void (chargeback)
    r = Refunded

    Note: Custom Order Statuses are numeric (1,2,3 etc.) and can be identified under Setup > Extensions (/admin/extensions/?id=21)

    order_by
    sort (a=asc, d='desc')
    aq (search term)
    courier_id
    gateway_id
    days (days=1 for last 1 day; days=7 for last 7 days etc.)
    fields (fields=all for all fields or leave blank for default)     		api_key
    transaction_id*

    * Omit transaction_id for all transactions     		POST:
    https://{USERNAME}.shoppo.co.nz/api/orders
    update a transaction; must include the transaction_id (either numeric or the alphanumeric order_id) and one or more other values, e.g. change status to 'f'

    GET:
    https://{USERNAME}.shoppo.co.nz/api/orders/?transaction_id=1...
    retrieve data for transaction with transaction_id 1

    Remember to also include your API key!

Status IDs »« Examples


×