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.stockLocation.updateSalesChannels("sloc_123", {
add: ["sc_123"],
remove: ["sc_456"],
})
.then(({ stock_location }) => {
console.log(stock_location)
}){
"stock_location": {
"id": "<string>",
"name": "<string>",
"address_id": "<string>",
"address": {
"id": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"company": "<string>",
"country_code": "us",
"city": "<string>",
"phone": "<string>",
"postal_code": "<string>",
"province": "us-ca"
},
"sales_channels": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"is_disabled": true,
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"fulfillment_providers": [
{
"id": "<string>",
"is_enabled": true
}
],
"fulfillment_sets": [
{}
]
}
}Manage Sales Channels of a Stock Location
Manage the sales channels in a stock location by adding or removing them.
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.stockLocation.updateSalesChannels("sloc_123", {
add: ["sc_123"],
remove: ["sc_456"],
})
.then(({ stock_location }) => {
console.log(stock_location)
}){
"stock_location": {
"id": "<string>",
"name": "<string>",
"address_id": "<string>",
"address": {
"id": "<string>",
"address_1": "<string>",
"address_2": "<string>",
"company": "<string>",
"country_code": "us",
"city": "<string>",
"phone": "<string>",
"postal_code": "<string>",
"province": "us-ca"
},
"sales_channels": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"is_disabled": true,
"metadata": {},
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"deleted_at": "2023-11-07T05:31:56Z"
}
],
"fulfillment_providers": [
{
"id": "<string>",
"is_enabled": true
}
],
"fulfillment_sets": [
{}
]
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The stock location's ID.
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
Response
OK
The stock location's details.
The stock location's details.
Show child attributes
Show child attributes
The location's ID.
The location's name.
The ID of the associated address.
The details of the stock location address.
Show child attributes
Show child attributes
The address's ID.
The address's first line.
The address's second line.
The address's company.
The address's country code.
"us"
The address's city.
The address's phone.
The address's postal code.
The address's lower-case ISO 3166-2 province code.
"us-ca"
The sales channels associated with the location.
Show child attributes
Show child attributes
The sales channel's ID.
The sales channel's name.
The sales channel's description.
Whether the sales channel is disabled.
The sales channel's metadata, can hold custom key-value pairs.
The date the sales channel was created.
The date the sales channel was updated.
The date the sales channel was deleted.
The fulfillment sets associated with the location.