PUT /purchases/{id}/move-dropship-provider.json
Path parameters
-
id integer(int64) Required
Numeric ID of the instance
Minimum value is
1
.
Body Required
-
adjustmentReasonId integer(int32) | null
Adjustment reason
-
adminNotes string | null
Admin notes
-
approved boolean Required
Approved
Default value is
true
. -
billingAddressLineOne string | null
Billing address line one
-
billingAddressLineTwo string | null
Billing address line two
-
billingAddressMessage string | null
Billing address message
-
billingCity string | null
Billing city
-
billingCountry string | null
Billing country
-
billingFirstName string | null
Billing first name
- billingFullName object | null | array | boolean | integer | number | string
Any of: Billing full name
Billing full name
Billing full name
Billing full name
Billing full name
Billing full name
-
billingLastName string | null
Billing last name
-
billingName string | null
Billing name
-
billingState string | null
Billing state
-
billingZip string | null
Billing zip
-
cancellationStatus string Required
Cancellation status
Values are
none
,partial
, orfull
. Default value isnone
. -
cancelled boolean Required
Cancelled
Default value is
false
. -
cancelledAt string(date-time) | null
Cancelled at
-
cityTaxLocation string | null
City tax location
-
cityTaxRate number(float) | null
City tax rate
-
combinedTaxRate number(float) | null
Combined tax rate
-
countyTaxLocation string | null
County tax location
-
countyTaxRate number(float) | null
County tax rate
-
createdAt string(date-time)
Created at
-
customerReference string | null
Customer reference
-
dateOrdered string(date-time) Required
Date ordered
Default value is
{}
(empty). -
deliveryExpectedAt string(date-time) | null
Delivery expected at
-
discounts number Required
Discounts
Default value is
0
. -
districtTaxRate number(float) | null
District tax rate
-
dropshipNotes string | null
Dropship notes
-
dropshipProviderAddressId integer(int32) | null
Dropship provider address
-
dropshipProviderId integer(int32) | null
Dropship provider
-
finalized boolean Required
Finalized
Default value is
true
. -
id integer(int32)
Id
-
intercomMessageId string | null
Intercom message
-
internalReference string | null
Internal reference
-
invalidBillingAddress string | null
Invalid billing address
-
invalidShippingAddress boolean | null Required
Invalid shipping address
Default value is
false
. -
inventoryStatus string Required
Inventory status
Values are
notReceived
,partiallyReceived
, orreceived
. Default value isnotReceived
. -
invoiceStatus string Required
Invoice status
Values are
notInvoiced
,partiallyInvoiced
, orinvoiced
. Default value isnotInvoiced
. -
isDropship boolean Required
Is dropship
- labelProblem object | null | array | boolean | integer | number | string
-
lastDropshipmentReference integer(int32) | null Required
Last dropshipment reference
Default value is
0
. -
lastGoodsReceiptReference integer(int32) | null Required
Last goods receipt reference
Default value is
0
. -
lastPurchaseInvoiceReference integer(int32) | null Required
Last purchase invoice reference
Default value is
0
. -
locked boolean Required
Locked
Default value is
false
. -
muteError boolean | null Required
Mute error
Default value is
false
. -
notes string | null
Notes
- orderProblem object | null | array | boolean | integer | number | string
-
orderSplitting string | null Required
Order splitting
Values are
group
,splitTag
, orsplitQuantity
. Default value isgroup
. -
orderSplittingKey string | null
Order splitting key
-
paymentExpectedAt string(date-time) | null
Payment expected at
-
paymentStatus string Required
Payment status
Values are
notPaid
,partiallyPaid
, orpaid
. Default value isnotPaid
. -
priceListId integer(int32) | null
Price list
-
purchaseId integer(int32) | null
Purchase
-
purchaseImportExternalId string | null
Purchase import external
-
purchaseStatusId integer(int32) | null
Purchase status
-
purchaseType string Required
Purchase type
Values are
replenishment
,dropship
,automated_dropship
,automated_replenishment
, oradjusted_dropship
. Default value isreplenishment
. -
quantity integer(int32) Required
Quantity
Default value is
0
. -
receiverAddressLineOne string | null
Receiver address line one
-
receiverAddressLineTwo string | null
Receiver address line two
-
receiverCity string | null
Receiver city
-
receiverCountry string | null
Receiver country
-
receiverName string | null
Receiver name
-
receiverState string | null
Receiver state
-
receiverZip string | null
Receiver zip
-
reference string Required
Reference
-
reminderLastSent string(date-time) | null
Reminder last sent
-
reminderSent integer(int32) | null Required
Reminder sent
Default value is
false
. -
returnStatus string Required
Return status
Values are
notReturned
,partiallyReturned
, orreturned
. Default value isnotReturned
. -
saleId integer(int32) | null
Sale
-
shipmentRouting string | null Required
Shipment routing
Values are
customer
,consolidated
, orconsolidatedInternational
. Default value iscustomer
. -
shippingAddressLineOne string | null
Shipping address line one
-
shippingAddressLineTwo string | null
Shipping address line two
-
shippingAddressMessage boolean | null Required
Shipping address message
Default value is
false
. -
shippingCity string | null
Shipping city
-
shippingCountry string | null
Shipping country
-
shippingExpectedAt string(date-time) | null
Shipping expected at
-
shippingFirstName string | null
Shipping first name
- shippingFullName object | null | array | boolean | integer | number | string
Any of: Shipping full name
Shipping full name
Shipping full name
Shipping full name
Shipping full name
Shipping full name
-
shippingLastName string | null
Shipping last name
-
shippingName string | null
Shipping name
-
shippingRateError string | null
Shipping rate error
Values are
value
orweight
. -
shippingState string | null
Shipping state
-
shippingZip string | null
Shipping zip
-
splitTag string | null
Split tag
-
stateTaxLocation string | null
State tax location
-
stateTaxRate number(float) | null
State tax rate
-
subtotal number Required
Subtotal
Default value is
0
. -
tax number Required
Tax
Default value is
0
. -
taxCalculation string | null Required
Tax calculation
Values are
default
orcustom
. Default value isdefault
. -
taxIncluded boolean Required
Tax included
Default value is
false
. -
taxShipping boolean | null Required
Tax shipping
Default value is
true
. -
total number Required
Total
Default value is
0
. -
updatedAt string(date-time)
Updated at
-
userId integer(int32) | null
User
-
vendorEndpointFormat string | null
Vendor endpoint format
Values are
json
,xml
,csv
,text
,email
,website
, orphone
. - vendorEndpointHeaders object | null | array | boolean | integer | number | string
Any of: Vendor endpoint headers
Vendor endpoint headers
Vendor endpoint headers
Vendor endpoint headers
Vendor endpoint headers
Vendor endpoint headers
-
vendorEndpointResponse string | null
Vendor endpoint response
-
vendorId integer(int32) | null
Vendor
-
vendorReceivedId string | null
Vendor received
-
vendorReceivedReference string | null
Vendor received reference
-
vendorReceivedStatus string | null Required
Vendor received status
Values are
notSent
,received
, orerror
. Default value isnotSent
. -
vendorReference string | null
Vendor reference
-
warehouseId integer(int32) | null
Warehouse
-
weight number(float) | null Required
Weight
Default value is
0
.
curl \
-X PUT http://api.example.com/v1/purchases/{id}/move-dropship-provider.json \
-H "Content-Type: application/json" \
-d '{"adjustmentReasonId":42,"adminNotes":"string","approved":true,"billingAddressLineOne":"string","billingAddressLineTwo":"string","billingAddressMessage":"string","billingCity":"string","billingCountry":"string","billingFirstName":"string","billingFullName":{},"billingLastName":"string","billingName":"string","billingState":"string","billingZip":"string","cancellationStatus":"none","cancelled":false,"cancelledAt":"2023-05-04T09:42:00+00:00","cityTaxLocation":"string","cityTaxRate":42.0,"combinedTaxRate":42.0,"countyTaxLocation":"string","countyTaxRate":42.0,"createdAt":"2023-05-04T09:42:00+00:00","customerReference":"string","dateOrdered":{},"deliveryExpectedAt":"2023-05-04T09:42:00+00:00","discounts":0,"districtTaxRate":42.0,"dropshipNotes":"string","dropshipProviderAddressId":42,"dropshipProviderId":42,"files":{},"finalized":true,"id":42,"intercomMessageId":"string","internalReference":"string","invalidBillingAddress":"string","invalidShippingAddress":false,"inventoryStatus":"notReceived","invoiceStatus":"notInvoiced","isDropship":true,"labelProblem":{},"lastDropshipmentReference":0,"lastGoodsReceiptReference":0,"lastPurchaseInvoiceReference":0,"locked":false,"muteError":false,"notes":"string","orderProblem":{},"orderSplitting":"group","orderSplittingKey":"string","paymentExpectedAt":"2023-05-04T09:42:00+00:00","paymentStatus":"notPaid","priceListId":42,"purchaseId":42,"purchaseImportExternalId":"string","purchaseStatusId":42,"purchaseType":"replenishment","quantity":0,"receiverAddressLineOne":"string","receiverAddressLineTwo":"string","receiverCity":"string","receiverCountry":"string","receiverName":"string","receiverState":"string","receiverZip":"string","reference":"string","reminderLastSent":"2023-05-04T09:42:00+00:00","reminderSent":false,"returnStatus":"notReturned","saleId":42,"shipmentRouting":"customer","shippingAddressLineOne":"string","shippingAddressLineTwo":"string","shippingAddressMessage":false,"shippingCity":"string","shippingCountry":"string","shippingExpectedAt":"2023-05-04T09:42:00+00:00","shippingFirstName":"string","shippingFullName":{},"shippingLastName":"string","shippingName":"string","shippingRateError":"value","shippingState":"string","shippingZip":"string","splitTag":"string","stateTaxLocation":"string","stateTaxRate":42.0,"subtotal":0,"tags":["string"],"tax":0,"taxCalculation":"default","taxIncluded":false,"taxShipping":true,"total":0,"updatedAt":"2023-05-04T09:42:00+00:00","userId":42,"vendorEndpointFormat":"json","vendorEndpointHeaders":{},"vendorEndpointResponse":"string","vendorId":42,"vendorReceivedId":"string","vendorReceivedReference":"string","vendorReceivedStatus":"notSent","vendorReference":"string","warehouseId":42,"weight":0}'
{
"adjustmentReasonId": 42,
"adminNotes": "string",
"approved": true,
"billingAddressLineOne": "string",
"billingAddressLineTwo": "string",
"billingAddressMessage": "string",
"billingCity": "string",
"billingCountry": "string",
"billingFirstName": "string",
"billingFullName": {},
"billingLastName": "string",
"billingName": "string",
"billingState": "string",
"billingZip": "string",
"cancellationStatus": "none",
"cancelled": false,
"cancelledAt": "2023-05-04T09:42:00+00:00",
"cityTaxLocation": "string",
"cityTaxRate": 42.0,
"combinedTaxRate": 42.0,
"countyTaxLocation": "string",
"countyTaxRate": 42.0,
"createdAt": "2023-05-04T09:42:00+00:00",
"customerReference": "string",
"dateOrdered": {},
"deliveryExpectedAt": "2023-05-04T09:42:00+00:00",
"discounts": 0,
"districtTaxRate": 42.0,
"dropshipNotes": "string",
"dropshipProviderAddressId": 42,
"dropshipProviderId": 42,
"files": {},
"finalized": true,
"id": 42,
"intercomMessageId": "string",
"internalReference": "string",
"invalidBillingAddress": "string",
"invalidShippingAddress": false,
"inventoryStatus": "notReceived",
"invoiceStatus": "notInvoiced",
"isDropship": true,
"labelProblem": {},
"lastDropshipmentReference": 0,
"lastGoodsReceiptReference": 0,
"lastPurchaseInvoiceReference": 0,
"locked": false,
"muteError": false,
"notes": "string",
"orderProblem": {},
"orderSplitting": "group",
"orderSplittingKey": "string",
"paymentExpectedAt": "2023-05-04T09:42:00+00:00",
"paymentStatus": "notPaid",
"priceListId": 42,
"purchaseId": 42,
"purchaseImportExternalId": "string",
"purchaseStatusId": 42,
"purchaseType": "replenishment",
"quantity": 0,
"receiverAddressLineOne": "string",
"receiverAddressLineTwo": "string",
"receiverCity": "string",
"receiverCountry": "string",
"receiverName": "string",
"receiverState": "string",
"receiverZip": "string",
"reference": "string",
"reminderLastSent": "2023-05-04T09:42:00+00:00",
"reminderSent": false,
"returnStatus": "notReturned",
"saleId": 42,
"shipmentRouting": "customer",
"shippingAddressLineOne": "string",
"shippingAddressLineTwo": "string",
"shippingAddressMessage": false,
"shippingCity": "string",
"shippingCountry": "string",
"shippingExpectedAt": "2023-05-04T09:42:00+00:00",
"shippingFirstName": "string",
"shippingFullName": {},
"shippingLastName": "string",
"shippingName": "string",
"shippingRateError": "value",
"shippingState": "string",
"shippingZip": "string",
"splitTag": "string",
"stateTaxLocation": "string",
"stateTaxRate": 42.0,
"subtotal": 0,
"tags": [
"string"
],
"tax": 0,
"taxCalculation": "default",
"taxIncluded": false,
"taxShipping": true,
"total": 0,
"updatedAt": "2023-05-04T09:42:00+00:00",
"userId": 42,
"vendorEndpointFormat": "json",
"vendorEndpointHeaders": {},
"vendorEndpointResponse": "string",
"vendorId": 42,
"vendorReceivedId": "string",
"vendorReceivedReference": "string",
"vendorReceivedStatus": "notSent",
"vendorReference": "string",
"warehouseId": 42,
"weight": 0
}
{
"adjustmentReasonId": 42,
"adminNotes": "string",
"approved": true,
"billingAddressLineOne": "string",
"billingAddressLineTwo": "string",
"billingAddressMessage": "string",
"billingCity": "string",
"billingCountry": "string",
"billingFirstName": "string",
"billingFullName": {},
"billingLastName": "string",
"billingName": "string",
"billingState": "string",
"billingZip": "string",
"cancellationStatus": "none",
"cancelled": false,
"cancelledAt": "2023-05-04T09:42:00+00:00",
"cityTaxLocation": "string",
"cityTaxRate": 42.0,
"combinedTaxRate": 42.0,
"countyTaxLocation": "string",
"countyTaxRate": 42.0,
"createdAt": "2023-05-04T09:42:00+00:00",
"customerReference": "string",
"dateOrdered": {},
"deliveryExpectedAt": "2023-05-04T09:42:00+00:00",
"discounts": 0,
"districtTaxRate": 42.0,
"dropshipNotes": "string",
"dropshipProviderAddressId": 42,
"dropshipProviderId": 42,
"files": {},
"finalized": true,
"id": 42,
"intercomMessageId": "string",
"internalReference": "string",
"invalidBillingAddress": "string",
"invalidShippingAddress": false,
"inventoryStatus": "notReceived",
"invoiceStatus": "notInvoiced",
"isDropship": true,
"labelProblem": {},
"lastDropshipmentReference": 0,
"lastGoodsReceiptReference": 0,
"lastPurchaseInvoiceReference": 0,
"locked": false,
"muteError": false,
"notes": "string",
"orderProblem": {},
"orderSplitting": "group",
"orderSplittingKey": "string",
"paymentExpectedAt": "2023-05-04T09:42:00+00:00",
"paymentStatus": "notPaid",
"priceListId": 42,
"purchaseId": 42,
"purchaseImportExternalId": "string",
"purchaseStatusId": 42,
"purchaseType": "replenishment",
"quantity": 0,
"receiverAddressLineOne": "string",
"receiverAddressLineTwo": "string",
"receiverCity": "string",
"receiverCountry": "string",
"receiverName": "string",
"receiverState": "string",
"receiverZip": "string",
"reference": "string",
"reminderLastSent": "2023-05-04T09:42:00+00:00",
"reminderSent": false,
"returnStatus": "notReturned",
"saleId": 42,
"shipmentRouting": "customer",
"shippingAddressLineOne": "string",
"shippingAddressLineTwo": "string",
"shippingAddressMessage": false,
"shippingCity": "string",
"shippingCountry": "string",
"shippingExpectedAt": "2023-05-04T09:42:00+00:00",
"shippingFirstName": "string",
"shippingFullName": {},
"shippingLastName": "string",
"shippingName": "string",
"shippingRateError": "value",
"shippingState": "string",
"shippingZip": "string",
"splitTag": "string",
"stateTaxLocation": "string",
"stateTaxRate": 42.0,
"subtotal": 0,
"tags": [
"string"
],
"tax": 0,
"taxCalculation": "default",
"taxIncluded": false,
"taxShipping": true,
"total": 0,
"updatedAt": "2023-05-04T09:42:00+00:00",
"userId": 42,
"vendorEndpointFormat": "json",
"vendorEndpointHeaders": {},
"vendorEndpointResponse": "string",
"vendorId": 42,
"vendorReceivedId": "string",
"vendorReceivedReference": "string",
"vendorReceivedStatus": "notSent",
"vendorReference": "string",
"warehouseId": 42,
"weight": 0
}