PUT /warehouses/{id}.json
Path parameters
-
Numeric ID of the instance
Minimum value is
1
.
Body Required
-
addressLineOne string | null
Address line one
-
addressLineTwo string | null
Address line two
-
billingAddressLineOne string | null
Billing address line one
-
billingAddressLineTwo string | null
Billing address line two
-
billingCity string | null
Billing city
-
billingCountry string | null
Billing country
-
billingFirstName string | null
Billing first name
-
billingLastName string | null
Billing last name
-
billingName string | null
Billing name
-
billingState string | null
Billing state
-
billingZip string | null
Billing zip
-
city string | null
City
-
Countries
Default value is
[]
(empty). -
Countries filter
Values are
all
,domestic
,rest_of_world
,exclude
, orinclude
. Default value isall
. -
country string | null
Country
-
createdAt string(date-time)
Created at
-
Default return status
Values are
draft
,requested
,finalized
,shipped
, orreceived
. Default value isreceived
. -
firstName string | null
First name
-
id integer(int32)
Id
-
includeLabelInPackingSlip boolean | null
Include label in packing slip
-
Label format
Values are
png
,pdf
,pdf_4x6
, orpdf_4x8
. Default value ispng
. -
lastName string | null
Last name
-
name string | null
Name
-
pdfLegal string | null
Pdf legal
-
setInvoiceAddresss boolean | null
Set invoice addresss
-
shippingRateId integer(int32) | null
Shipping rate
-
Skip online inventory
Default value is
false
. -
state string | null
State
-
States
Default value is
[]
(empty). -
States filter
Values are
all
,exclude
, orinclude
. Default value isall
. -
Status
Values are
active
orarchived
. Default value isactive
. -
updatedAt string(date-time)
Updated at
-
zip string | null
Zip
-
Zips
Default value is
[]
(empty). -
Zips filter
Values are
all
,exclude
,include
, orstartsWith
. Default value isall
.
curl \
-X PUT http://api.example.com/v1/warehouses/{id}.json \
-H "Authorization: Bearer $ACCESS_TOKEN" \
-H "Content-Type: application/json" \
-d '{"addressLineOne":"string","addressLineTwo":"string","billingAddressLineOne":"string","billingAddressLineTwo":"string","billingCity":"string","billingCountry":"string","billingFirstName":"string","billingLastName":"string","billingName":"string","billingState":"string","billingZip":"string","city":"string","countries":[],"countriesFilter":"all","country":"string","createdAt":"2024-05-04T09:42:00+00:00","defaultReturnStatus":"received","firstName":"string","id":42,"includeLabelInPackingSlip":true,"labelFormat":"png","lastName":"string","name":"string","pdfLegal":"string","setInvoiceAddresss":true,"shippingRateId":42,"skipOnlineInventory":false,"state":"string","states":[],"statesFilter":"all","status":"active","updatedAt":"2024-05-04T09:42:00+00:00","zip":"string","zips":[],"zipsFilter":"all"}'
{
"addressLineOne": "string",
"addressLineTwo": "string",
"billingAddressLineOne": "string",
"billingAddressLineTwo": "string",
"billingCity": "string",
"billingCountry": "string",
"billingFirstName": "string",
"billingLastName": "string",
"billingName": "string",
"billingState": "string",
"billingZip": "string",
"city": "string",
"countries": [],
"countriesFilter": "all",
"country": "string",
"createdAt": "2024-05-04T09:42:00+00:00",
"defaultReturnStatus": "received",
"firstName": "string",
"id": 42,
"includeLabelInPackingSlip": true,
"labelFormat": "png",
"lastName": "string",
"name": "string",
"pdfLegal": "string",
"setInvoiceAddresss": true,
"shippingRateId": 42,
"skipOnlineInventory": false,
"state": "string",
"states": [],
"statesFilter": "all",
"status": "active",
"updatedAt": "2024-05-04T09:42:00+00:00",
"zip": "string",
"zips": [],
"zipsFilter": "all"
}