Overview
Scanner API
import Switchyard from "@switchyard/js-sdk"
export const sdk = new Medusa({
baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
debug: import.meta.env.DEV,
auth: {
type: "session",
},
})
sdk.admin.region.create({
name: "United States",
currency_code: "usd",
})
.then(({ region }) => {
console.log(region)
}){
"region": {
"id": "<string>",
"name": "<string>",
"currency_code": "usd",
"automatic_taxes": true,
"countries": [
{
"id": "<string>",
"iso_2": "us",
"iso_3": "usa",
"num_code": 840,
"name": "<string>",
"display_name": "<string>"
}
],
"payment_providers": [
{
"id": "<string>",
"is_enabled": true
}
],
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}Create Region
Create a region.
import Switchyard from "@switchyard/js-sdk"
export const sdk = new Medusa({
baseUrl: import.meta.env.VITE_BACKEND_URL || "/",
debug: import.meta.env.DEV,
auth: {
type: "session",
},
})
sdk.admin.region.create({
name: "United States",
currency_code: "usd",
})
.then(({ region }) => {
console.log(region)
}){
"region": {
"id": "<string>",
"name": "<string>",
"currency_code": "usd",
"automatic_taxes": true,
"countries": [
{
"id": "<string>",
"iso_2": "us",
"iso_3": "usa",
"num_code": 840,
"name": "<string>",
"display_name": "<string>"
}
],
"payment_providers": [
{
"id": "<string>",
"is_enabled": true
}
],
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Query Parameters
Comma-separated fields that should be included in the returned data. if a field is prefixed with + it will be added to the default fields, using - will remove it from the default fields. without prefix it will replace the entire default fields.
Body
The region's details.
The region's name.
The region's currency code.
"usd"
The region's countries.
A country code.
Whether taxes are calculated automatically during checkout in this region.
Whether prices in this region are tax inclusive.
The payment providers enabled in this region.
A payment provider's ID.
The region's metadata, used to store custom key-value pairs.
Response
OK
The region's details.
The region's details.
Show child attributes
Show child attributes
The region's ID.
The region's name.
The region's currency code.
"usd"
Whether taxes are applied automatically during checkout.
The region's countries.
Show child attributes
Show child attributes
The country's ID.
The country's iso 2.
"us"
The country's iso 3.
"usa"
The country's num code.
840
The country's name.
The country's display name.
The region's metadata, can hold custom key-value pairs.
The date the region was created.
The date the region was updated.