Fulfillments

Create Fulfillments

post/v1/Fulfillments

Request

  • Base URL: https://api.channeladvisor.com
  • URL: https://api.channeladvisor.com/v1/Fulfillments
  • Auth: OAuth 2 (authorization code, authorization URL https://api.channeladvisor.com/oauth2/authorize, token URL https://api.channeladvisor.com/oauth2/token; implicit, authorization URL https://api.channeladvisor.com/oauth2/authorize, scopes: orders, inventory) and HTTP bearer

Request body

ProfileIDnumber
OrderIDnumber nullable
Type'Ship' | 'Pickup' | 'ShipToStore' | 'Courier'
DeliveryStatus'NoChange' | 'InTransit' | 'ReadyForPickup' | 'Complete' | 'Canceled' | 'ThirdPartyManaged' | 'Confirmed' | 'PickAndPack' | 'LabelCreated' | 'Held' | 'Delivered' | 'FailedDelivery'

Indicates the delivery state of a fulfillment.

ValueDescription
NoChangeThe fulfillment is unshipped. Making a request with this value will set a fulfillment or order to unshipped.
InTransitThe fulfillment is in transit to a location where the recipient may pick it up. Used for eBay In-Store-Pickup orders.
ReadyForPickupThe fulfillment has arrived at the pickup location and is ready for the recipient to pick up. Used for eBay In-Store-Pickup orders.
CompleteThe fulfillment is complete and/or fully shipped.
CanceledThe items on this fulfillment have been canceled and will not be fulfilled.
ThirdPartyManagedThe fulfillment is handled outside Rithum.
ConfirmedThe fulfillment location confirms receipt of the order.
PickAndPackThe items in the fulfillment are in the process of being retrieved and packed.
LabelCreatedThe items in the fulfillment are packed and a label has been generated for pickup or retrieval.
HeldThe fulfillment is in Held status when decisions are needed for change in the fulfillment.
DeliveredThe shipment was delivered to the final destination.
FailedDeliveryThe shipment failed delivery to the final destination.
TrackingNumberstring nullable
TrackingUrlstring nullable
ReturnTrackingNumberstring nullable
ShippingCarrierstring nullable
ShippingClassstring nullable
DistributionCenterIDnumber
ShippingCostnumber nullable
InsuranceCostnumber nullable
TaxCostnumber nullable
ShippedDateUtcstring date-time nullable
SellerFulfillmentIDstring nullable
ShippingLabelRequestIDstring nullable
StagingLocationstring nullable
SerialShippingContainerCodestring nullable
Weightnumber nullable
WeightUnit'Gram' | 'Pound'
Heightnumber nullable
Widthnumber nullable
Lengthnumber nullable
MeasurementUnit'Centimeter' | 'Inch'

Example request

{
  "ProfileID": 0,
  "OrderID": 0,
  "Type": "Ship",
  "DeliveryStatus": "NoChange",
  "TrackingNumber": "string",
  "TrackingUrl": "string",
  "ReturnTrackingNumber": "string",
  "ShippingCarrier": "string",
  "ShippingClass": "string",
  "DistributionCenterID": 0,
  "ShippingCost": 0,
  "InsuranceCost": 0,
  "TaxCost": 0,
  "ShippedDateUtc": "0001-01-01T00:00:00+00:00",
  "SellerFulfillmentID": "string",
  "ShippingLabelRequestID": "string",
  "StagingLocation": "string",
  "SerialShippingContainerCode": "string",
  "Weight": 0,
  "WeightUnit": "Gram",
  "Height": 0,
  "Width": 0,
  "Length": 0,
  "MeasurementUnit": "Centimeter"
}

Response

Created entity

IDnumber
ProfileIDnumber
OrderIDnumber nullable
CreatedDateUtcstring date-time nullable
UpdatedDateUtcstring date-time nullable
Type'Ship' | 'Pickup' | 'ShipToStore' | 'Courier'
DeliveryStatus'NoChange' | 'InTransit' | 'ReadyForPickup' | 'Complete' | 'Canceled' | 'ThirdPartyManaged' | 'Confirmed' | 'PickAndPack' | 'LabelCreated' | 'Held' | 'Delivered' | 'FailedDelivery'

Indicates the delivery state of a fulfillment.

ValueDescription
NoChangeThe fulfillment is unshipped. Making a request with this value will set a fulfillment or order to unshipped.
InTransitThe fulfillment is in transit to a location where the recipient may pick it up. Used for eBay In-Store-Pickup orders.
ReadyForPickupThe fulfillment has arrived at the pickup location and is ready for the recipient to pick up. Used for eBay In-Store-Pickup orders.
CompleteThe fulfillment is complete and/or fully shipped.
CanceledThe items on this fulfillment have been canceled and will not be fulfilled.
ThirdPartyManagedThe fulfillment is handled outside Rithum.
ConfirmedThe fulfillment location confirms receipt of the order.
PickAndPackThe items in the fulfillment are in the process of being retrieved and packed.
LabelCreatedThe items in the fulfillment are packed and a label has been generated for pickup or retrieval.
HeldThe fulfillment is in Held status when decisions are needed for change in the fulfillment.
DeliveredThe shipment was delivered to the final destination.
FailedDeliveryThe shipment failed delivery to the final destination.
TrackingNumberstring nullable
TrackingUrlstring nullable
ReturnTrackingNumberstring nullable
ShippingCarrierstring nullable
ShippingClassstring nullable
DistributionCenterIDnumber
ExternalFulfillmentCenterCodestring nullable
ExternalFulfillmentStatus'New' | 'Pending' | 'Sent' | 'Processing' | 'Complete' | 'Held' | 'Failed'
ShippingCostnumber nullable
InsuranceCostnumber nullable
TaxCostnumber nullable
ShippedDateUtcstring date-time nullable
SellerFulfillmentIDstring nullable
HasShippingLabelboolean
HasChannelPackingSlipboolean
HasReturnLabelboolean
HasChannelReturnLabelboolean
ExternalFulfillmentNumberstring nullable
ExternalFulfillmentReferenceNumberstring nullable
ShippingLabelRequestIDstring nullable
StagingLocationstring nullable
SerialShippingContainerCodestring nullable
EarliestDeliveryDateUtcstring date-time nullable
EarliestShipDateUtcstring date-time nullable
EstimatedDeliveryDateUtcstring date-time nullable
EstimatedShipDateUtcstring date-time nullable
LabelFormat'JPEG' | 'PDF' | 'PNG' | 'GzipPDF' | 'GIFLandscape' | 'GzipPNG' | 'GIFPortrait' | 'ZPL' | 'GzipZPL'
ReturnLabelFormat'JPEG' | 'PDF' | 'PNG' | 'GzipPDF' | 'GIFLandscape' | 'GzipPNG' | 'GIFPortrait' | 'ZPL' | 'GzipZPL'
ChannelReturnLabelFormat'JPEG' | 'PDF' | 'PNG' | 'GzipPDF' | 'GIFLandscape' | 'GzipPNG' | 'GIFPortrait' | 'ZPL' | 'GzipZPL'
Weightnumber nullable
WeightUnit'Gram' | 'Pound'
Heightnumber nullable
Widthnumber nullable
Lengthnumber nullable
MeasurementUnit'Centimeter' | 'Inch'

Example response

{
  "ID": 0,
  "ProfileID": 0,
  "OrderID": 0,
  "CreatedDateUtc": "0001-01-01T00:00:00+00:00",
  "UpdatedDateUtc": "0001-01-01T00:00:00+00:00",
  "Type": "Ship",
  "DeliveryStatus": "NoChange",
  "TrackingNumber": "string",
  "TrackingUrl": "string",
  "ReturnTrackingNumber": "string",
  "ShippingCarrier": "string",
  "ShippingClass": "string",
  "DistributionCenterID": 0,
  "ExternalFulfillmentCenterCode": "string",
  "ExternalFulfillmentStatus": "New",
  "ShippingCost": 0,
  "InsuranceCost": 0,
  "TaxCost": 0,
  "ShippedDateUtc": "0001-01-01T00:00:00+00:00",
  "SellerFulfillmentID": "string",
  "HasShippingLabel": true,
  "HasChannelPackingSlip": true,
  "HasReturnLabel": true,
  "HasChannelReturnLabel": true,
  "ExternalFulfillmentNumber": "string",
  "ExternalFulfillmentReferenceNumber": "string",
  "ShippingLabelRequestID": "string",
  "StagingLocation": "string",
  "SerialShippingContainerCode": "string",
  "EarliestDeliveryDateUtc": "0001-01-01T00:00:00+00:00",
  "EarliestShipDateUtc": "0001-01-01T00:00:00+00:00",
  "EstimatedDeliveryDateUtc": "0001-01-01T00:00:00+00:00",
  "EstimatedShipDateUtc": "0001-01-01T00:00:00+00:00",
  "LabelFormat": "JPEG",
  "ReturnLabelFormat": "JPEG",
  "ChannelReturnLabelFormat": "JPEG",
  "Weight": 0,
  "WeightUnit": "Gram",
  "Height": 0,
  "Width": 0,
  "Length": 0,
  "MeasurementUnit": "Centimeter"
}

Changes

No recorded changes to this operation across all 1 revision of this API.