Skip to content
This repository has been archived by the owner on Mar 28, 2023. It is now read-only.

OpenBazaar 2.0 URLs

Jump to bottom
Josh Jeffryes edited this page Aug 1, 2017 · 1 revision

Reference Client Address System

This is a guide to how addresses work in the reference client.

User Pages

ob://@handle|peerID - navigate to a user page based on a handle or a peer ID. Resolves to /store if the user has their vendor flag set to true in their profile, otherwise resolves to /home.

ob://@handle|peerID/home|about|followers|following - navigates to that tab on the user's page.

ob://@handle|peerID/store - if the user has their vendor flag set to true, this will navigate to their store tab. If the user's vendor flag is false, their store tab will only be visible to them, other users will not be able to navigate to it.

ob://@handle|peerID/store/slug - this will navigate to the store tab, and open the listing that has that slug (ex: ob://@amazostore/store/red-shoes).

Transactions

ob://transactions - navigate to the transactions page, and the sales tab.

ob://transactions/purchases|sales|cases - navigate to the transactions page, and the specified tab.

ob://transactions/purchases|sales|cases?search=[text]&sortBy=UNREAD|DATE_ASC|DATE_DESC&states=0-1-2-3-4-5-6-7-8-9-10-11-12&orderId=[orderID] - navigate to a particular state in the transactions page on a particular tab. The queries are:

  • search: a term to search for
  • sortBy: UNREAD (New transactions) DATE_ASC (by date, ascending), DATE_DESC (by date, descending)
  • states: A list of states to show. See the list below.
  • orderID: If this query is included, a modal will open with that order.

Transaction States

  • 0 PENDING
  • 1 AWAITING_PAYMENT
  • 2 AWAITING_PICKUP
  • 3 AWAITING_FULFILLMENT
  • 4 PARTIALLY_FULFILLED
  • 5 FULFILLED
  • 6 COMPLETED
  • 7 CANCELED
  • 8 DECLINED
  • 9 REFUNDED;
  • 10 DISPUTED
  • 11 DECIDED
  • 12 RESOLVED
  • 13 PAYMENT_FINALIZED

Search

ob://search?[query] - will load the search screen and execute the query. The query can have the following parameters:

  • providerQ: = encoded url for the provider query. This is used to specify a search provider url instead of using the default. ex: providerQ=https%3A%2F%2Fsearch.ob1.io%2Fsearch%2Flistings%3Fq%3Dbananas%26p%3D0%26ps%3D12
  • q: the term to search for
  • p: the page to start on. If p = 3, page 3 of X will be shown.
  • ps: the page size.
  • sortBy: the value to sort by.
  • Other parameters will be treated as filters.
Clone this wiki locally