Medusa
  1. Stock Locations
Medusa
  • Store API
  • Admin API
    • Auth
      • Apps Oauth
        • Generate Token for App
        • List Applications
      • Get Current User
        GET
      • User Logout
        DELETE
      • User Login
        POST
      • User Login (JWT)
        POST
    • Batch Jobs
      • Cancel a Batch Job
        POST
      • Get a Batch Job
        GET
      • Confirm a Batch Job
        POST
      • List Batch Jobs
        GET
      • Create a Batch Job
        POST
    • Currencies
      • List Currency
        GET
      • Update a Currency
        POST
    • Customers
      • Create a Customer
      • List Customers
      • Update a Customer
      • Get a Customer
    • Customer Groups
      • Remove Customers from Group
      • Add Customers to Group
      • List Customers
      • Create a Customer Group
      • List Customer Groups
      • Get a Customer Group
      • Delete a Customer Group
      • Update a Customer Group
    • Discounts
      • Create a Condition
      • Create a Discount
      • List Discounts
      • Get a Condition
      • Update a Condition
      • Delete a Condition
      • Create a Dynamic Code
      • Remove Batch Resources
      • Add Batch Resources
      • Get Discount by Code
      • Delete a Dynamic Code
      • Add Region to Discount
      • Remove Region
      • Delete a Discount
      • Update a Discount
      • Get a Discount
    • Draft Orders
      • Create a Line Item
      • Delete a Line Item
      • Update a Line Item
      • Update a Draft Order
      • Delete a Draft Order
      • Get a Draft Order
      • Create a Draft Order
      • List Draft Orders
      • Mark Paid
    • Gift Cards
      • Create a Gift Card
      • List Gift Cards
      • Delete a Gift Card
      • Get a Gift Card
      • Update a Gift Card
    • Inventory Items
      • Create an Inventory Item
      • List Inventory Items
      • List Inventory Level
      • Create an Location Level
      • Update an Inventory Item
      • Get an Inventory Item
      • Delete an Inventory Item
      • Update a Location Level
      • Delete a Location Level
    • Invites
      • Lists Invites
      • Create an Invite
      • Delete an Invite
      • Accept an Invite
      • Resend an Invite
    • Notes
      • List Notes
      • Create a Note
      • Get a Note
      • Delete a Note
      • Update a Note
    • Notifications
      • Resend Notification
      • List Notifications
    • Orders
      • Create a Reservation
      • Cancel Claim's Fulfillment
      • Ship a Claim's Fulfillment
      • Cancel Swap's Fulfilmment
      • Get Order Reservations
      • Add a Shipping Method
      • Create a Refund
      • Get an Order
      • Update an Order
      • Create a Fulfillment
      • Cancel a Swap
      • List Orders
      • Create a Swap
      • Complete an Order
      • Create a Swap Fulfillment
      • Cancel a Claim
      • Process a Swap Payment
      • Ship a Fulfillment
      • Capture an Order's Payments
      • Archive Order
      • Update a Claim
      • Request a Return
      • Create a Claim Fulfillment
      • Ship a Swap's Fulfillment
      • Cancel a Fulfilmment
      • Create a Claim
      • Cancel an Order
    • Order Edits
      • Delete a Line Item Change
      • Add a Line Item
      • Upsert Line Item Change
      • Delete Line Item
      • Cancel an Order Edit
      • Delete an Order Edit
      • Get an Order Edit
      • Update an Order Edit
      • Request Confirmation
      • Create an OrderEdit
      • List Order Edits
      • Confirm an OrderEdit
    • Payments
      • Capture a Payment
      • Get Payment details
      • Refund Payment
    • Payment Collections
      • Delete a Payment Collection
      • Get a Payment Collection
      • Update Payment Collection
      • Mark Authorized
    • Product Collections
      • Add Products to Collection
      • Remove Products from Collection
      • Get a Collection
      • Update a Collection
      • Delete a Collection
      • List Collections
      • Create a Collection
    • Product Tags
      • List Product Tags
    • Product Types
      • List Product Types
    • Product Variants
      • Get Variant's Inventory
      • List Product Variants
      • Get a Product variant
    • Price Lists
      • Delete a Product's Prices
      • List Products
      • Delete a Variant's Prices
      • Get a Price List
      • Update a Price List
      • Delete a Price List
      • Add or Update Prices
      • Delete Prices
      • Create a Price List
      • List Price Lists
    • Products
      • List Product Types
      • List Tags Usage Number
      • List a Product's Variants
      • Create a Product Variant
      • Update a Product Variant
      • Delete a Product Variant
      • Add a Product Option
      • Set Metadata
      • Delete a Product Option
      • Update a Product Option
    • Product Categories
      • Create a Product Category
      • List Product Categories
      • Update a Product Category
      • Delete a Product Category
      • Get a Product Category
      • Add Products to a Category
      • Remove Products from Category
    • Publishable Api Keys
      • List Sales Channels
      • Delete Publishable API Key
      • Get a Publishable API Key
      • Revoke a Publishable API Key
      • Remove Sales Channels
      • Add Sales Channels
      • Update Publishable API Key
      • List Publishable API keys
      • Create Publishable API Key
    • Reservations
      • Delete a Reservation
      • Update a Reservation
      • Get a Reservation
      • Create a Reservation
      • List Reservations
    • Regions
      • List Fulfillment Options
      • Add Country
      • Remove Fulfillment Provider
      • Remove Payment Provider
      • Add Payment Provider
      • Delete a Region
      • Update a Region
      • Get a Region
      • List Regions
      • Create a Region
      • Add Fulfillment Provider
      • Remove Country
    • Return Reasons
      • Get a Return Reason
      • Delete a Return Reason
      • Update a Return Reason
      • List Return Reasons
      • Create a Return Reason
    • Returns
      • Receive a Return
      • List Returns
      • Cancel a Return
    • Sales Channels
      • Remove Stock Location from Sales Channels.
      • Associate a Stock Location
      • Get a Sales Channel
      • Delete a Sales Channel
      • Update a Sales Channel
      • Remove Products from Sales Channel
      • Add Products to Sales Channel
      • Create a Sales Channel
      • List Sales Channels
    • Shipping Options
      • Update Shipping Option
      • Get a Shipping Option
      • Delete Shipping Option
      • List Shipping Options
      • Create Shipping Option
    • Shipping Profiles
      • List Shipping Profiles
      • Create a Shipping Profile
      • Delete a Shipping Profile
      • Update a Shipping Profile
      • Get a Shipping Profile
    • Stock Locations
      • Get a Stock Location
        GET
      • Update a Stock Location
        POST
      • Delete a Stock Location
        DELETE
      • List Stock Locations
        GET
      • Create a Stock Location
        POST
    • Store
      • List Payment Providers
      • Add a Currency Code
      • Remove a Currency
      • List Tax Providers
      • Update Store Details
      • Get Store details
    • Swaps
      • Get a Swap
      • List Swaps
    • Uploads
      • Upload Files
      • Delete an Uploaded File
      • Get a File's Download URL
      • Protected File Upload
    • Tax Rates
      • Add to Shipping Options
      • Remove Shipping Options from Rate
      • Create a Tax Rate
      • List Tax Rates
      • Add to Products
      • Remove Products from Rate
      • Delete a Tax Rate
      • Get a Tax Rate
      • Update a Tax Rate
      • Add to Product Types
      • Remove Product Types from Rate
    • Users
      • Reset Password
      • Request Password Reset
      • Get a User
      • Delete a User
      • Update a User
      • Create a User
      • List Users
  • 【Demo】Products
    • 检索产品列表
    • 创建新产品
    • 删除产品
    • 更新产品信息
    • 检索产品详情
  1. Stock Locations

Update a Stock Location

POST
/admin/stock-locations/{id}
Admin API/Stock LocationsStock Locations
Update a Stock Location's details.

Request

Path Params
id
string 
required
The ID of the Stock Location.
Query Params
expand
string 
optional
Comma-separated relations that should be expanded in the returned stock location.
fields
string 
optional
Comma-separated fields that should be included in the returned stock location.
Body Params application/json
name
string 
optional
the name of the stock location
address_id
string 
optional
the stock location address ID
metadata
object 
optional
An optional key-value map with additional details
Example:
{"car":"white"}
address
object (Stock Location Address Input) 
optional
Represents a Stock Location Address Input
address_1
string 
required
Stock location address
Example:
35, Jhon Doe Ave
address_2
string 
optional
Stock location address' complement
Example:
apartment 4432
city
string 
optional
Stock location address' city
Example:
Mexico city
country_code
string 
required
Stock location address' country
Example:
MX
phone
string 
optional
Stock location address' phone number
Example:
+1 555 61646
postal_code
string 
optional
Stock location address' postal code
Example:
HD3-1G8
province
string 
optional
Stock location address' province
Example:
Sinaloa
metadata
object 
optional
An optional key-value map with additional details
Example:
{"car":"white"}
Example
{
  "name": "string",
  "address_id": "string",
  "metadata": {
    "car": "white"
  },
  "address": {
    "address_1": "35, Jhon Doe Ave",
    "address_2": "apartment 4432",
    "city": "Mexico city",
    "country_code": "MX",
    "phone": "+1 555 61646",
    "postal_code": "HD3-1G8",
    "province": "Sinaloa",
    "metadata": {
      "car": "white"
    }
  }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/admin/stock-locations/' \
--header 'Content-Type: application/json' \
--data-raw ''

Responses

🟢200OK
application/json
Body
stock_location
object (StockLocationExpandedDTO) 
required
Represents a Stock Location
id
string 
required
The stock location's ID
Example:
sloc_51G4ZW853Y6TFXWPG5ENJ81X42
address_id
string 
required
Stock location address' ID
Example:
laddr_05B2ZE853Y6FTXWPW85NJ81A44
name
string 
required
The name of the stock location
Example:
Main Warehouse
created_at
string <date-time>
required
The date with timezone at which the resource was created.
updated_at
string <date-time>
required
The date with timezone at which the resource was updated.
deleted_at
string <date-time>
optional
The date with timezone at which the resource was deleted.
metadata
object 
optional
An optional key-value map with additional details
Example:
{"car":"white"}
address
object 
optional
The Address of the Stock Location
sales_channels
object 
Sales Channel
optional
A Sales Channel is a method a business offers its products for purchase for the customers. For example, a Webshop can be a sales channel, and a mobile app can be another.
Example
{
  "stock_location": {
    "id": "sloc_51G4ZW853Y6TFXWPG5ENJ81X42",
    "address_id": "laddr_05B2ZE853Y6FTXWPW85NJ81A44",
    "name": "Main Warehouse",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z",
    "deleted_at": "2019-08-24T14:15:22Z",
    "metadata": {
      "car": "white"
    },
    "address": {
      "id": "laddr_51G4ZW853Y6TFXWPG5ENJ81X42",
      "address_1": "35, Jhon Doe Ave",
      "address_2": "apartment 4432",
      "company": "Medusa",
      "city": "Mexico city",
      "country_code": "MX",
      "phone": "+1 555 61646",
      "postal_code": "HD3-1G8",
      "province": "Sinaloa",
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "metadata": {
        "car": "white"
      }
    },
    "sales_channels": {
      "id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A",
      "name": "Market",
      "description": "Multi-vendor market",
      "is_disabled": false,
      "created_at": "2019-08-24T14:15:22Z",
      "updated_at": "2019-08-24T14:15:22Z",
      "deleted_at": "2019-08-24T14:15:22Z",
      "metadata": {
        "car": "white"
      },
      "locations": [
        {
          "id": "scloc_01G8X9A7ESKAJXG2H0E6F1MW7A",
          "sales_channel_id": "sc_01G8X9A7ESKAJXG2H0E6F1MW7A",
          "location_id": "string",
          "sales_channel": {},
          "created_at": "2019-08-24T14:15:22Z",
          "updated_at": "2019-08-24T14:15:22Z",
          "deleted_at": "2019-08-24T14:15:22Z"
        }
      ]
    }
  }
}
🟠400Client Error or Multiple Errors
🟠401User is not authorized. Must log in first
🟠404Not Found Error
🟠409Invalid State Error
🟠422Invalid Request Error
🔴500Server Error
Modified at 2024-05-23 07:10:14
Previous
Get a Stock Location
Next
Delete a Stock Location
Built with