docs: adds first version of REST docs (#116)
This commit is contained in:
1 parent
1da1ebbb5e
commit
47e2ad2952
29 files changed
+14653
-17
No files matched your search
@@ -0,0 +1,41 @@
|
||||
title: Regions
|
||||
domain: store
|
||||
route: /regions
|
||||
description: >
|
||||
A Region represents a collection of countries that have common pricing
|
||||
schemes, shipping options, tax schemes, etc. Carts must have a region
|
||||
associated.
|
||||
endpoints:
|
||||
- path: /
|
||||
method: GET
|
||||
title: List Regions
|
||||
description: >
|
||||
Retrieves the regions configured for the store.
|
||||
- path: /:id
|
||||
method: GET
|
||||
title: Retrieve a Region
|
||||
params:
|
||||
- name: id
|
||||
type: String
|
||||
description: Id of the region.
|
||||
description: >
|
||||
Retrieves a region
|
||||
|
||||
response: |
|
||||
{
|
||||
"region": {
|
||||
"name": "Denmark",
|
||||
"currency_code": "DKK",
|
||||
"tax_rate": 0.25,
|
||||
"countries": [
|
||||
"DK"
|
||||
],
|
||||
"payment_providers": [
|
||||
"stripe"
|
||||
],
|
||||
"fulfillment_providers": [
|
||||
"manual"
|
||||
],
|
||||
"_id": "5f4cd45b5d1e3200214c0e49"
|
||||
}
|
||||
}
|
||||
Reference in new issue
Block a user