Update warehouse detail
curl --request PUT \
--url https://staging.api.commercengine.io/api/v1/{store_id}/admin/store/warehouses/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"city": "<string>",
"address_line1": "<string>",
"pincode": "<string>",
"state": "<string>",
"country": "<string>",
"contact_phone": 123,
"contact_email": "<string>",
"can_receive_stock": true,
"can_ship_parcel": true,
"can_collect": true,
"accepts_returns": true,
"is_checkout_point": true,
"active": true,
"gstin": "<string>",
"address_line2": "<string>",
"landmark": "<string>",
"country_code": "+91",
"is_default": true,
"image_url": "<string>",
"seller_warehouse_id": "<string>",
"service_provider_id": [
"<string>"
],
"channel_id": [
"<string>"
]
}
'import requests
url = "https://staging.api.commercengine.io/api/v1/{store_id}/admin/store/warehouses/{id}"
payload = {
"name": "<string>",
"city": "<string>",
"address_line1": "<string>",
"pincode": "<string>",
"state": "<string>",
"country": "<string>",
"contact_phone": 123,
"contact_email": "<string>",
"can_receive_stock": True,
"can_ship_parcel": True,
"can_collect": True,
"accepts_returns": True,
"is_checkout_point": True,
"active": True,
"gstin": "<string>",
"address_line2": "<string>",
"landmark": "<string>",
"country_code": "+91",
"is_default": True,
"image_url": "<string>",
"seller_warehouse_id": "<string>",
"service_provider_id": ["<string>"],
"channel_id": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
city: '<string>',
address_line1: '<string>',
pincode: '<string>',
state: '<string>',
country: '<string>',
contact_phone: 123,
contact_email: '<string>',
can_receive_stock: true,
can_ship_parcel: true,
can_collect: true,
accepts_returns: true,
is_checkout_point: true,
active: true,
gstin: '<string>',
address_line2: '<string>',
landmark: '<string>',
country_code: '+91',
is_default: true,
image_url: '<string>',
seller_warehouse_id: '<string>',
service_provider_id: ['<string>'],
channel_id: ['<string>']
})
};
fetch('https://staging.api.commercengine.io/api/v1/{store_id}/admin/store/warehouses/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://staging.api.commercengine.io/api/v1/{store_id}/admin/store/warehouses/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'city' => '<string>',
'address_line1' => '<string>',
'pincode' => '<string>',
'state' => '<string>',
'country' => '<string>',
'contact_phone' => 123,
'contact_email' => '<string>',
'can_receive_stock' => true,
'can_ship_parcel' => true,
'can_collect' => true,
'accepts_returns' => true,
'is_checkout_point' => true,
'active' => true,
'gstin' => '<string>',
'address_line2' => '<string>',
'landmark' => '<string>',
'country_code' => '+91',
'is_default' => true,
'image_url' => '<string>',
'seller_warehouse_id' => '<string>',
'service_provider_id' => [
'<string>'
],
'channel_id' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://staging.api.commercengine.io/api/v1/{store_id}/admin/store/warehouses/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"city\": \"<string>\",\n \"address_line1\": \"<string>\",\n \"pincode\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"contact_phone\": 123,\n \"contact_email\": \"<string>\",\n \"can_receive_stock\": true,\n \"can_ship_parcel\": true,\n \"can_collect\": true,\n \"accepts_returns\": true,\n \"is_checkout_point\": true,\n \"active\": true,\n \"gstin\": \"<string>\",\n \"address_line2\": \"<string>\",\n \"landmark\": \"<string>\",\n \"country_code\": \"+91\",\n \"is_default\": true,\n \"image_url\": \"<string>\",\n \"seller_warehouse_id\": \"<string>\",\n \"service_provider_id\": [\n \"<string>\"\n ],\n \"channel_id\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://staging.api.commercengine.io/api/v1/{store_id}/admin/store/warehouses/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"city\": \"<string>\",\n \"address_line1\": \"<string>\",\n \"pincode\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"contact_phone\": 123,\n \"contact_email\": \"<string>\",\n \"can_receive_stock\": true,\n \"can_ship_parcel\": true,\n \"can_collect\": true,\n \"accepts_returns\": true,\n \"is_checkout_point\": true,\n \"active\": true,\n \"gstin\": \"<string>\",\n \"address_line2\": \"<string>\",\n \"landmark\": \"<string>\",\n \"country_code\": \"+91\",\n \"is_default\": true,\n \"image_url\": \"<string>\",\n \"seller_warehouse_id\": \"<string>\",\n \"service_provider_id\": [\n \"<string>\"\n ],\n \"channel_id\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.commercengine.io/api/v1/{store_id}/admin/store/warehouses/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"city\": \"<string>\",\n \"address_line1\": \"<string>\",\n \"pincode\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"contact_phone\": 123,\n \"contact_email\": \"<string>\",\n \"can_receive_stock\": true,\n \"can_ship_parcel\": true,\n \"can_collect\": true,\n \"accepts_returns\": true,\n \"is_checkout_point\": true,\n \"active\": true,\n \"gstin\": \"<string>\",\n \"address_line2\": \"<string>\",\n \"landmark\": \"<string>\",\n \"country_code\": \"+91\",\n \"is_default\": true,\n \"image_url\": \"<string>\",\n \"seller_warehouse_id\": \"<string>\",\n \"service_provider_id\": [\n \"<string>\"\n ],\n \"channel_id\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"success": true,
"content": {
"warehouse": {
"name": "<string>",
"warehouse_type": "retail-store",
"city": "<string>",
"address_line1": "<string>",
"pincode": "<string>",
"state": "<string>",
"country": "<string>",
"contact_phone": 123,
"contact_email": "<string>",
"can_receive_stock": true,
"can_ship_parcel": true,
"can_collect": true,
"is_checkout_point": true,
"accepts_returns": true,
"id": "<string>",
"active": true,
"gstin": "<string>",
"address_line2": "<string>",
"landmark": "<string>",
"country_code": "+91",
"is_default": true,
"image_url": "<string>",
"seller_warehouse_id": "<string>",
"opening_hours": {
"monday": {
"opening_time": "<string>",
"closing_time": "<string>"
},
"tuesday": {
"opening_time": "<string>",
"closing_time": "<string>"
},
"wednesday": {
"opening_time": "<string>",
"closing_time": "<string>"
},
"thursday": {
"opening_time": "<string>",
"closing_time": "<string>"
},
"friday": {
"opening_time": "<string>",
"closing_time": "<string>"
},
"saturday": {
"opening_time": "<string>",
"closing_time": "<string>"
},
"sunday": {
"opening_time": "<string>",
"closing_time": "<string>"
}
},
"channels": [
{
"id": "<string>",
"name": "<string>",
"kind": "storefront",
"active": true
}
],
"shipping_boxes": [
{
"name": "<string>",
"length": 123,
"width": 123,
"height": 123,
"empty_box_weight": 123,
"max_weight_box_can_carry": 123,
"empty_box_price": 123,
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
}
],
"shipping_providers": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"is_connected": true,
"is_forward_shipping": true,
"is_return_shipping": true,
"logo_dark": "<string>",
"logo_light": "<string>",
"type": "auto",
"status": "active"
}
],
"manual_methods": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"is_connected": true,
"is_forward_shipping": true,
"is_return_shipping": true,
"logo_dark": "<string>",
"logo_light": "<string>",
"type": "auto",
"status": "active"
}
],
"available_shipping_options": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"is_connected": true,
"is_forward_shipping": true,
"is_return_shipping": true,
"logo_dark": "<string>",
"logo_light": "<string>",
"type": "auto",
"status": "active"
}
]
}
}
}Store
Update warehouse detail
Update warehouse detail
PUT
/
store
/
warehouses
/
{id}
Update warehouse detail
curl --request PUT \
--url https://staging.api.commercengine.io/api/v1/{store_id}/admin/store/warehouses/{id} \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "<string>",
"city": "<string>",
"address_line1": "<string>",
"pincode": "<string>",
"state": "<string>",
"country": "<string>",
"contact_phone": 123,
"contact_email": "<string>",
"can_receive_stock": true,
"can_ship_parcel": true,
"can_collect": true,
"accepts_returns": true,
"is_checkout_point": true,
"active": true,
"gstin": "<string>",
"address_line2": "<string>",
"landmark": "<string>",
"country_code": "+91",
"is_default": true,
"image_url": "<string>",
"seller_warehouse_id": "<string>",
"service_provider_id": [
"<string>"
],
"channel_id": [
"<string>"
]
}
'import requests
url = "https://staging.api.commercengine.io/api/v1/{store_id}/admin/store/warehouses/{id}"
payload = {
"name": "<string>",
"city": "<string>",
"address_line1": "<string>",
"pincode": "<string>",
"state": "<string>",
"country": "<string>",
"contact_phone": 123,
"contact_email": "<string>",
"can_receive_stock": True,
"can_ship_parcel": True,
"can_collect": True,
"accepts_returns": True,
"is_checkout_point": True,
"active": True,
"gstin": "<string>",
"address_line2": "<string>",
"landmark": "<string>",
"country_code": "+91",
"is_default": True,
"image_url": "<string>",
"seller_warehouse_id": "<string>",
"service_provider_id": ["<string>"],
"channel_id": ["<string>"]
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.put(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PUT',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
city: '<string>',
address_line1: '<string>',
pincode: '<string>',
state: '<string>',
country: '<string>',
contact_phone: 123,
contact_email: '<string>',
can_receive_stock: true,
can_ship_parcel: true,
can_collect: true,
accepts_returns: true,
is_checkout_point: true,
active: true,
gstin: '<string>',
address_line2: '<string>',
landmark: '<string>',
country_code: '+91',
is_default: true,
image_url: '<string>',
seller_warehouse_id: '<string>',
service_provider_id: ['<string>'],
channel_id: ['<string>']
})
};
fetch('https://staging.api.commercengine.io/api/v1/{store_id}/admin/store/warehouses/{id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://staging.api.commercengine.io/api/v1/{store_id}/admin/store/warehouses/{id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PUT",
CURLOPT_POSTFIELDS => json_encode([
'name' => '<string>',
'city' => '<string>',
'address_line1' => '<string>',
'pincode' => '<string>',
'state' => '<string>',
'country' => '<string>',
'contact_phone' => 123,
'contact_email' => '<string>',
'can_receive_stock' => true,
'can_ship_parcel' => true,
'can_collect' => true,
'accepts_returns' => true,
'is_checkout_point' => true,
'active' => true,
'gstin' => '<string>',
'address_line2' => '<string>',
'landmark' => '<string>',
'country_code' => '+91',
'is_default' => true,
'image_url' => '<string>',
'seller_warehouse_id' => '<string>',
'service_provider_id' => [
'<string>'
],
'channel_id' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://staging.api.commercengine.io/api/v1/{store_id}/admin/store/warehouses/{id}"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"city\": \"<string>\",\n \"address_line1\": \"<string>\",\n \"pincode\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"contact_phone\": 123,\n \"contact_email\": \"<string>\",\n \"can_receive_stock\": true,\n \"can_ship_parcel\": true,\n \"can_collect\": true,\n \"accepts_returns\": true,\n \"is_checkout_point\": true,\n \"active\": true,\n \"gstin\": \"<string>\",\n \"address_line2\": \"<string>\",\n \"landmark\": \"<string>\",\n \"country_code\": \"+91\",\n \"is_default\": true,\n \"image_url\": \"<string>\",\n \"seller_warehouse_id\": \"<string>\",\n \"service_provider_id\": [\n \"<string>\"\n ],\n \"channel_id\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("PUT", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.put("https://staging.api.commercengine.io/api/v1/{store_id}/admin/store/warehouses/{id}")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"city\": \"<string>\",\n \"address_line1\": \"<string>\",\n \"pincode\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"contact_phone\": 123,\n \"contact_email\": \"<string>\",\n \"can_receive_stock\": true,\n \"can_ship_parcel\": true,\n \"can_collect\": true,\n \"accepts_returns\": true,\n \"is_checkout_point\": true,\n \"active\": true,\n \"gstin\": \"<string>\",\n \"address_line2\": \"<string>\",\n \"landmark\": \"<string>\",\n \"country_code\": \"+91\",\n \"is_default\": true,\n \"image_url\": \"<string>\",\n \"seller_warehouse_id\": \"<string>\",\n \"service_provider_id\": [\n \"<string>\"\n ],\n \"channel_id\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://staging.api.commercengine.io/api/v1/{store_id}/admin/store/warehouses/{id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Put.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"city\": \"<string>\",\n \"address_line1\": \"<string>\",\n \"pincode\": \"<string>\",\n \"state\": \"<string>\",\n \"country\": \"<string>\",\n \"contact_phone\": 123,\n \"contact_email\": \"<string>\",\n \"can_receive_stock\": true,\n \"can_ship_parcel\": true,\n \"can_collect\": true,\n \"accepts_returns\": true,\n \"is_checkout_point\": true,\n \"active\": true,\n \"gstin\": \"<string>\",\n \"address_line2\": \"<string>\",\n \"landmark\": \"<string>\",\n \"country_code\": \"+91\",\n \"is_default\": true,\n \"image_url\": \"<string>\",\n \"seller_warehouse_id\": \"<string>\",\n \"service_provider_id\": [\n \"<string>\"\n ],\n \"channel_id\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_body{
"message": "<string>",
"success": true,
"content": {
"warehouse": {
"name": "<string>",
"warehouse_type": "retail-store",
"city": "<string>",
"address_line1": "<string>",
"pincode": "<string>",
"state": "<string>",
"country": "<string>",
"contact_phone": 123,
"contact_email": "<string>",
"can_receive_stock": true,
"can_ship_parcel": true,
"can_collect": true,
"is_checkout_point": true,
"accepts_returns": true,
"id": "<string>",
"active": true,
"gstin": "<string>",
"address_line2": "<string>",
"landmark": "<string>",
"country_code": "+91",
"is_default": true,
"image_url": "<string>",
"seller_warehouse_id": "<string>",
"opening_hours": {
"monday": {
"opening_time": "<string>",
"closing_time": "<string>"
},
"tuesday": {
"opening_time": "<string>",
"closing_time": "<string>"
},
"wednesday": {
"opening_time": "<string>",
"closing_time": "<string>"
},
"thursday": {
"opening_time": "<string>",
"closing_time": "<string>"
},
"friday": {
"opening_time": "<string>",
"closing_time": "<string>"
},
"saturday": {
"opening_time": "<string>",
"closing_time": "<string>"
},
"sunday": {
"opening_time": "<string>",
"closing_time": "<string>"
}
},
"channels": [
{
"id": "<string>",
"name": "<string>",
"kind": "storefront",
"active": true
}
],
"shipping_boxes": [
{
"name": "<string>",
"length": 123,
"width": 123,
"height": 123,
"empty_box_weight": 123,
"max_weight_box_can_carry": 123,
"empty_box_price": 123,
"id": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"modified_at": "2023-11-07T05:31:56Z"
}
],
"shipping_providers": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"is_connected": true,
"is_forward_shipping": true,
"is_return_shipping": true,
"logo_dark": "<string>",
"logo_light": "<string>",
"type": "auto",
"status": "active"
}
],
"manual_methods": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"is_connected": true,
"is_forward_shipping": true,
"is_return_shipping": true,
"logo_dark": "<string>",
"logo_light": "<string>",
"type": "auto",
"status": "active"
}
],
"available_shipping_options": [
{
"id": "<string>",
"name": "<string>",
"description": "<string>",
"is_connected": true,
"is_forward_shipping": true,
"is_return_shipping": true,
"logo_dark": "<string>",
"logo_light": "<string>",
"type": "auto",
"status": "active"
}
]
}
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
warehouse id
Body
application/json
Validations:
- Either 'can_receive_stock' or 'accepts_returns' must be set to true.
- 'can_receive_stock' cannot be set to false while the warehouse has existing inventory.
- 'is_checkout_point' must be true when the warehouse type is 'retail-store'.
- If 'can_receive_stock' is false then 'can_ship_parcel' and 'can_collect' fields should be false.
legal name
Available options:
retail-store, distribution-center 10 digit number without country code.
Show child attributes
Show child attributes
for courier integration.
array of channel ids
Was this page helpful?
⌘I