PUT /dropshipments/{id}/move-to-fulfill.json
PUT
/dropshipments/{id}/move-to-fulfill.json
Path parameters
-
id integer(int64) Required
Numeric ID of the instance
Minimum value is
1.
Body Required
-
adminNotes string | null
Admin notes
-
aftershipId string | null
Aftership
-
channelAttempts integer(int32) | null Required
Channel attempts
Default value is
0. -
channelError boolean | null
Channel error
-
channelNotification string | null Required
Channel notification
Values are
triggerormute. Default value istrigger. -
commercialInvoiceUrl string | null
Commercial invoice url
-
createdAt string(date-time)
Created at
-
days integer(int32) | null
Days
-
durationTerms string | null
Duration terms
-
externalId string | null
External
-
fulfillmentType string Required
Fulfillment type
Values are
automated,manual, oradjusted. Default value ismanual. -
grams number | null Required
Grams
Default value is
0. -
id integer(int32)
Id
-
intercomMessageId string | null
Intercom message
-
inventoryStatus string Required
Inventory status
Values are
notShippedorshipped. Default value isnotShipped. -
labelError string | null
Label error
-
labelFileFormat string | null
Label file format
Values are
pngorpdf. - labelFiles object | null | array | boolean | integer | number | string
-
labelRefund boolean | null Required
Label refund
Default value is
false. -
labelUrl string | null
Label url
-
manifestId integer(int32) | null
Manifest
-
muteError boolean | null Required
Mute error
Default value is
false. -
packed boolean | null Required
Packed
Default value is
false. -
packedAt string(date-time) | null
Packed at
-
picked boolean | null Required
Picked
Default value is
false. -
pickedAt string(date-time) | null
Picked at
-
price number | null Required
Price
Default value is
0. -
printedLabel boolean | null Required
Printed label
Default value is
false. -
printedLabelAt string(date-time) | null
Printed label at
-
provider string | null
Provider
-
quoteId string | null
Quote
-
reference string Required
Reference
-
requiresShippingApproval string | null Required
Requires shipping approval
Values are
notRequired,rateRequired,approvalRequired, orapproved. Default value isnotRequired. -
saleId integer(int32) Required
Sale
-
serviceLevel string | null
Service level
-
serviceLevelTerms string | null
Service level terms
-
shippedAt string(date-time) | null
Shipped at
-
shippoLabelIds array[string] | null
Shippo label ids
-
shipstationId string | null
Shipstation
-
status string | null Required
Status
Values are
pendingorfinalized. Default value isfinalized. -
trackingCompany string | null
Tracking company
-
trackingNumber string | null
Tracking number
-
trackingStatus string | null
Tracking status
Values are
delivered,failure,pre_transit,returned,transit, orunknown. -
trackingStatusDate string(date-time) | null
Tracking status date
-
trackingStatusDetails string | null
Tracking status details
-
trackingUrl string | null
Tracking url
-
updatedAt string(date-time)
Updated at
-
userId integer(int32) | null
User
-
xeroId string | null
Xero
PUT /dropshipments/{id}/move-to-fulfill.json
curl \
-X PUT http://api.example.com/v1/dropshipments/{id}/move-to-fulfill.json \
-H "Content-Type: application/json" \
-d '{"adminNotes":"string","aftershipId":"string","channelAttempts":0,"channelError":true,"channelNotification":"trigger","commercialInvoiceUrl":"string","createdAt":"2023-05-04T09:42:00+00:00","days":42,"durationTerms":"string","externalId":"string","files":{},"fulfillmentType":"manual","grams":0,"id":42,"intercomMessageId":"string","inventoryStatus":"notShipped","labelError":"string","labelFileFormat":"png","labelFiles":{},"labelRefund":false,"labelUrl":"string","manifestId":42,"muteError":false,"packed":false,"packedAt":"2023-05-04T09:42:00+00:00","picked":false,"pickedAt":"2023-05-04T09:42:00+00:00","price":0,"printedLabel":false,"printedLabelAt":"2023-05-04T09:42:00+00:00","provider":"string","quoteId":"string","reference":"string","requiresShippingApproval":"notRequired","saleId":42,"serviceLevel":"string","serviceLevelTerms":"string","shippedAt":"2023-05-04T09:42:00+00:00","shippoLabelIds":["string"],"shipstationId":"string","status":"finalized","tags":["string"],"trackingCompany":"string","trackingNumber":"string","trackingStatus":"delivered","trackingStatusDate":"2023-05-04T09:42:00+00:00","trackingStatusDetails":"string","trackingUrl":"string","updatedAt":"2023-05-04T09:42:00+00:00","userId":42,"xeroId":"string"}'
Request example
{
"adminNotes": "string",
"aftershipId": "string",
"channelAttempts": 0,
"channelError": true,
"channelNotification": "trigger",
"commercialInvoiceUrl": "string",
"createdAt": "2023-05-04T09:42:00+00:00",
"days": 42,
"durationTerms": "string",
"externalId": "string",
"files": {},
"fulfillmentType": "manual",
"grams": 0,
"id": 42,
"intercomMessageId": "string",
"inventoryStatus": "notShipped",
"labelError": "string",
"labelFileFormat": "png",
"labelFiles": {},
"labelRefund": false,
"labelUrl": "string",
"manifestId": 42,
"muteError": false,
"packed": false,
"packedAt": "2023-05-04T09:42:00+00:00",
"picked": false,
"pickedAt": "2023-05-04T09:42:00+00:00",
"price": 0,
"printedLabel": false,
"printedLabelAt": "2023-05-04T09:42:00+00:00",
"provider": "string",
"quoteId": "string",
"reference": "string",
"requiresShippingApproval": "notRequired",
"saleId": 42,
"serviceLevel": "string",
"serviceLevelTerms": "string",
"shippedAt": "2023-05-04T09:42:00+00:00",
"shippoLabelIds": [
"string"
],
"shipstationId": "string",
"status": "finalized",
"tags": [
"string"
],
"trackingCompany": "string",
"trackingNumber": "string",
"trackingStatus": "delivered",
"trackingStatusDate": "2023-05-04T09:42:00+00:00",
"trackingStatusDetails": "string",
"trackingUrl": "string",
"updatedAt": "2023-05-04T09:42:00+00:00",
"userId": 42,
"xeroId": "string"
}
Response example (200)
{
"adminNotes": "string",
"aftershipId": "string",
"channelAttempts": 0,
"channelError": true,
"channelNotification": "trigger",
"commercialInvoiceUrl": "string",
"createdAt": "2023-05-04T09:42:00+00:00",
"days": 42,
"durationTerms": "string",
"externalId": "string",
"files": {},
"fulfillmentType": "manual",
"grams": 0,
"id": 42,
"intercomMessageId": "string",
"inventoryStatus": "notShipped",
"labelError": "string",
"labelFileFormat": "png",
"labelFiles": {},
"labelRefund": false,
"labelUrl": "string",
"manifestId": 42,
"muteError": false,
"packed": false,
"packedAt": "2023-05-04T09:42:00+00:00",
"picked": false,
"pickedAt": "2023-05-04T09:42:00+00:00",
"price": 0,
"printedLabel": false,
"printedLabelAt": "2023-05-04T09:42:00+00:00",
"provider": "string",
"quoteId": "string",
"reference": "string",
"requiresShippingApproval": "notRequired",
"saleId": 42,
"serviceLevel": "string",
"serviceLevelTerms": "string",
"shippedAt": "2023-05-04T09:42:00+00:00",
"shippoLabelIds": [
"string"
],
"shipstationId": "string",
"status": "finalized",
"tags": [
"string"
],
"trackingCompany": "string",
"trackingNumber": "string",
"trackingStatus": "delivered",
"trackingStatusDate": "2023-05-04T09:42:00+00:00",
"trackingStatusDetails": "string",
"trackingUrl": "string",
"updatedAt": "2023-05-04T09:42:00+00:00",
"userId": 42,
"xeroId": "string"
}