upleb.uk

Public git repos — served from a NIP-34 GRASP relay at git.upleb.uk

summaryrefslogtreecommitdiff
path: root/15.md
diff options
context:
space:
mode:
Diffstat (limited to '15.md')
-rw-r--r--15.md20
1 files changed, 10 insertions, 10 deletions
diff --git a/15.md b/15.md
index e2ba639..55814fb 100644
--- a/15.md
+++ b/15.md
@@ -56,7 +56,7 @@ A merchant can publish these events:
56 "id": <string, id of the shipping zone, generated by the merchant>, 56 "id": <string, id of the shipping zone, generated by the merchant>,
57 "name": <string (optional), zone name>, 57 "name": <string (optional), zone name>,
58 "cost": <float, base cost for shipping. The currency is defined at the stall level>, 58 "cost": <float, base cost for shipping. The currency is defined at the stall level>,
59 "regions": [<string, regions included in this zone>], 59 "regions": [<string, regions included in this zone>]
60 } 60 }
61 ] 61 ]
62} 62}
@@ -101,7 +101,7 @@ Fields that are not self-explanatory:
101 "shipping": [ 101 "shipping": [
102 { 102 {
103 "id": <string, id of the shipping zone (must match one of the zones defined for the stall)>, 103 "id": <string, id of the shipping zone (must match one of the zones defined for the stall)>,
104 "cost": <float, extra cost for shipping. The currency is defined at the stall level>, 104 "cost": <float, extra cost for shipping. The currency is defined at the stall level>
105 } 105 }
106 ] 106 ]
107} 107}
@@ -139,7 +139,7 @@ Fields that are not self-explanatory:
139 139
140## Checkout events 140## Checkout events
141 141
142All checkout events are sent as JSON strings using ([NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md)). 142All checkout events are sent as JSON strings using ([NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md)).
143 143
144The `merchant` and the `customer` can exchange JSON messages that represent different actions. Each `JSON` message `MUST` have a `type` field indicating the what the JSON represents. Possible types: 144The `merchant` and the `customer` can exchange JSON messages that represent different actions. Each `JSON` message `MUST` have a `type` field indicating the what the JSON represents. Possible types:
145 145
@@ -150,19 +150,19 @@ The `merchant` and the `customer` can exchange JSON messages that represent diff
150| 2 | Merchant | Order Status Update | 150| 2 | Merchant | Order Status Update |
151 151
152### Step 1: `customer` order (event) 152### Step 1: `customer` order (event)
153The below json goes in content of [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md). 153The below JSON goes in content of [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md).
154 154
155```json 155```json
156{ 156{
157 "id": <string, id generated by the customer>, 157 "id": <string, id generated by the customer>,
158 "type": 0, 158 "type": 0,
159 "name": <string (optional), ???>, 159 "name": <string (optional), ???>,
160 "address": <string (optional), for physical goods an address should be provided> 160 "address": <string (optional), for physical goods an address should be provided>,
161 "message": "<string (optional), message for merchant>, 161 "message": "<string (optional), message for merchant>,
162 "contact": { 162 "contact": {
163 "nostr": <32-bytes hex of a pubkey>, 163 "nostr": <32-bytes hex of a pubkey>,
164 "phone": <string (optional), if the customer wants to be contacted by phone>, 164 "phone": <string (optional), if the customer wants to be contacted by phone>,
165 "email": <string (optional), if the customer wants to be contacted by email>, 165 "email": <string (optional), if the customer wants to be contacted by email>
166 }, 166 },
167 "items": [ 167 "items": [
168 { 168 {
@@ -182,7 +182,7 @@ _Open_: is `contact.nostr` required?
182 182
183Sent back from the merchant for payment. Any payment option is valid that the merchant can check. 183Sent back from the merchant for payment. Any payment option is valid that the merchant can check.
184 184
185The below json goes in `content` of [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md). 185The below JSON goes in `content` of [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md).
186 186
187`payment_options`/`type` include: 187`payment_options`/`type` include:
188 188
@@ -217,7 +217,7 @@ The below json goes in `content` of [NIP04](https://github.com/nostr-protocol/ni
217 217
218Once payment has been received and processed. 218Once payment has been received and processed.
219 219
220The below json goes in `content` of [NIP04](https://github.com/nostr-protocol/nips/blob/master/04.md). 220The below JSON goes in `content` of [NIP-04](https://github.com/nostr-protocol/nips/blob/master/04.md).
221 221
222```json 222```json
223{ 223{
@@ -275,7 +275,7 @@ This event leverages naddr to enable comprehensive customization and sharing of
275 "shipping": [ 275 "shipping": [
276 { 276 {
277 "id": <String, UUID of the shipping zone. Must match one of the zones defined for the stall>, 277 "id": <String, UUID of the shipping zone. Must match one of the zones defined for the stall>,
278 "cost": <float, extra cost for shipping. The currency is defined at the stall level>, 278 "cost": <float, extra cost for shipping. The currency is defined at the stall level>
279 } 279 }
280 ] 280 ]
281} 281}
@@ -310,7 +310,7 @@ Bids are simply events of kind `1021` with a `content` field specifying the amou
310{ 310{
311 "status": <String, "accepted" | "rejected" | "pending" | "winner">, 311 "status": <String, "accepted" | "rejected" | "pending" | "winner">,
312 "message": <String (optional)>, 312 "message": <String (optional)>,
313 "duration_extended": <int (optional), number of seconds>, 313 "duration_extended": <int (optional), number of seconds>
314} 314}
315``` 315```
316 316