API > Status IDs

Status IDs

product: status_id

  • 0 = Normal (default if omitted)
  • 1 = Normal + Homepage large
  • 2 = Normal + Homepage small
  • 3 = Hidden
  • 4 = Out of stock
  • 5 = Out of stock (back order)

category: 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

information: enabled

  • 1 = Enabled
  • 2 = Enabled but hide menu link
  • 3 = Disabled
  • 4 = Enabled (Wholesale only)

order: status

  • p = Pending
  • h = On Hold
  • f = Fulfilled
  • a = Fulfilled (awaiting payment)
  • v = Void
  • x = Void (chargeback)
  • r = Refunded
Note: Custom Order Statuses, if enabled, are numeric (1,2,3 etc.) and can be identified under Setup > Extensions (/admin/extensions/?id=21)

Example: set product to hidden:

https://{USERNAME}.shoppo.co.nz/api/product?api_key=YOUR_API_KEY&sku=ABC123&status_id=3

Error codes »« Endpoints


×