Fulfillments

Get Fulfillments

get/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

Query parameters

$topnumber

Show only the first n items

$skipnumber

Skip the first n items

$filterstring

Filter items by property values

$countboolean

Include count of items

$orderbystring[]

Order items by property values

$selectstring[]

Select properties to be returned

$expandstring[]

Expand related entities

Response

Retrieved collection

@odata.countnumber nullable
@odata.nextLinkstring nullable

Example response

{
  "value": [
    {
      "ID": 0,
      "ProfileID": 0,
      "OrderID": 0,
      "CreatedDateUtc": "0001-01-01T00:00:00.0000000+00:00",
      "UpdatedDateUtc": "0001-01-01T00:00:00.0000000+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.0000000+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.0000000+00:00",
      "EarliestShipDateUtc": "0001-01-01T00:00:00.0000000+00:00",
      "EstimatedDeliveryDateUtc": "0001-01-01T00:00:00.0000000+00:00",
      "EstimatedShipDateUtc": "0001-01-01T00:00:00.0000000+00:00",
      "LabelFormat": "JPEG",
      "ReturnLabelFormat": "JPEG",
      "ChannelReturnLabelFormat": "JPEG",
      "Weight": 0,
      "WeightUnit": "Gram",
      "Height": 0,
      "Width": 0,
      "Length": 0,
      "MeasurementUnit": "Centimeter",
      "Order": {
        "@odata.type": "ChannelAdvisor.RestApi.V1.Models.Order"
      },
      "Items": [
        {
          "@odata.type": "ChannelAdvisor.RestApi.V1.Models.FulfillmentItem"
        }
      ]
    }
  ]
}

Changes

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