ShopItUp Developers v1

Catalogue

Store details and policies

Live

GET https://shopitup.ca/api/v1/stores/{store_slug}
Access
catalog:read How to get a token
Returns
The store

Path parameters

  • store_slug string Required

Response

200 The store

  • slug string Required

    The store's address label; use it in the store filter and GET /stores/{store_slug}

  • name string Required
  • url string uri Required
  • agent_checkout string Required

    How an assistant completes a purchase here. link — create a checkout and give the person its link; they review and pay on the store. direct — the store also accepts purchases an assistant makes for a person who allowed it, within the limits they set. Every store is link unless its owner opted in.

    One of direct link
  • about string Can be null
  • location string
  • return_policy ReturnPolicy
    4 child attributes
    • returns_accepted boolean Can be null

      true or false when the store's policy says so plainly; null when it does not, and summary and url are the store's own words

    • window_days integer Can be null

      Days to return an item, when the store's policy names one

    • summary string

      The policy's first sentence, in the store's words

    • url string uri
  • shipping_policy_url string uri
  • free_shipping_over string

    The store ships free once its part of an order reaches this amount (before tax); null when it offers no such deal

Status codes

200

The store

401

Missing, invalid or expired access token

403

The token does not carry the scope this endpoint needs

404

Not found, or not listed on this marketplace

429

Too many requests; retry after the number of seconds in Retry-After

503

A service the API depends on is briefly unavailable; retry after the number of seconds in Retry-After

Errors share one shape — see Errors and rate limits.