chore: updates API reference docs
This commit is contained in:
@@ -1,41 +1,58 @@
|
||||
title: Regions
|
||||
domain: store
|
||||
routes:
|
||||
- method: POST
|
||||
path: /regions
|
||||
- method: GET
|
||||
path: /regions/:id
|
||||
route: /regions
|
||||
description: >
|
||||
A Region represents a collection of countries that have common pricing
|
||||
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
|
||||
title: Retrieve region
|
||||
params:
|
||||
- name: id
|
||||
type: String
|
||||
description: Id of the region.
|
||||
description: >
|
||||
Retrieves a region
|
||||
- path: /
|
||||
method: GET
|
||||
title: List regions
|
||||
description: >
|
||||
Retrieves the regions configured for the store.
|
||||
|
||||
response: |
|
||||
{
|
||||
"region": {
|
||||
"id": "reg_HMnixPlOicAs7aBlXuchAGxd",
|
||||
"name": "Denmark",
|
||||
"currency_code": "DKK",
|
||||
"currency": "DKK",
|
||||
"tax_rate": 0.25,
|
||||
"countries": [
|
||||
"DK"
|
||||
],
|
||||
"payment_providers": [
|
||||
"stripe"
|
||||
],
|
||||
"fulfillment_providers": [
|
||||
"manual"
|
||||
],
|
||||
"_id": "5f4cd45b5d1e3200214c0e49"
|
||||
"tax_code": null,
|
||||
"countries": [{
|
||||
"id": "1001",
|
||||
"iso_2": "DK",
|
||||
"iso_3": "DNK",
|
||||
"num_code": "208",
|
||||
"name": "denmark",
|
||||
"display_name": "Denmark"
|
||||
}],
|
||||
"payment_providers": [{
|
||||
"id": "stripe",
|
||||
"is_installed": true
|
||||
}],
|
||||
"fulfillment_providers": [{
|
||||
"id": "manual",
|
||||
"is_installed": true
|
||||
}],
|
||||
"created_at": "2020-12-11T17:03:54.458Z",
|
||||
"updated_at": "2020-12-11T17:03:54.458Z",
|
||||
"metadata": null
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user