Build Version:

GET shippingoptions

Gets a list of shipping options.

Request Information

» Expands

Name	Description	Usage
shippingType	This will retrieve the related shipping type.	GET shippingoptions?expand=shippingtype

» Filters

Name	Description	Usage
countryCode	This will filter the request by country code.	GET shippingoptions?filter=countrycode~{operator}~{value}
externalId	This will filter the request by external ID.	GET shippingoptions?filter=externalid~{operator}~{value}
isActive	This will filter the request by the is active flag.	GET shippingoptions?filter=isactive~{operator}~{value}
profileId	This will filter the request by profile ID.	GET shippingoptions?filter=profileid~{operator}~{value}
shippingCode	This will filter the request by shipping code.	GET shippingoptions?filter=shippingcode~{operator}~{value}
shippingTypeId	This will filter the request by shipping type ID.	GET shippingoptions?filter=shippingtypeid~{operator}~{value}

» Sorting

Name	Description	Usage
countryCode	This will sort the response by country code.	GET shippingoptions?sort=countrycode
description	This will sort the response by description.	GET shippingoptions?sort=description
displayOrder	This will sort the response by display order.	GET shippingoptions?sort=displayorder
shippingCode	This will sort the response by shipping code.	GET shippingoptions?sort=shippingcode
shippingOptionId	This will sort the response by shipping option ID.	GET shippingoptions?sort=shippingoptionid

» Paging

Name	Description	Usage
index	The index to retrieve when requesting paged results.	GET shippingoptions?page=index~{value}
size	The size of the page when retrieving paged results.	GET shippingoptions?page=size~{value}

Response Information

» Response Body Formats

If this endpoint supports expands, they will be included in the sample response body below. However, please note that expands are NOT included in the response body by default. Expands are only included in the response body if they came through as part of the request.

application/json

Sample:

	{
  "ShippingOptions": [
    {
      "CountryCode": "US",
      "Description": "Custom Flat Rate",
      "CustomErrorMessage": null,
      "DisplayOrder": 1,
      "ExternalId": null,
      "HandlingCharge": 2.50,
      "ActiveInd": true,
      "ProfileId": 7,
      "ShippingCode": "FLAT",
      "ShippingId": 9,
      "PortalId": 0,
      "ShippingType": {
        "ClassName": "ZnodeShippingFedEx",
        "Description": "Calculates shipping rates when using FedEx.",
        "IsActive": true,
        "Name": "FedEx",
        "ShippingTypeId": 1
      },
      "ShippingTypeId": 1,
      "ShippingRule": null,
      "ShippingServiceCodeId": 0,
      "ShippingServiceCode": null,
      "ShippingtypeName": null,
      "ProfileName": null,
      "ClassName": null,
      "UserType": null,
      "IsFreeShipping": false
    }
  ],
  "PageIndex": null,
  "PageSize": null,
  "TotalPages": null,
  "TotalResults": null,
  "ErrorCode": null,
  "ErrorMessage": null,
  "StackTrace": null,
  "AllowHtmlResponse": false,
  "HasError": false,
  "StringResponse": null
}