GET api/shipping/methods/{shippingMethod}

Retrieved allowed service codes and packaging types for a shipping method.

Request Information

URI Parameters

NameDescriptionTypeAdditional information
shippingMethod

The shipping method requested for information retrieval.

ShippingMethod

Required

Body Parameters

None.

Response Information

Resource Description

A representation of the allowed service codes and packaging types.

OrderShippingMethodDetails
NameDescriptionTypeAdditional information
PackageCodes

The valid package codes for the requested shipping method.

Collection of ShippingPackageDetail

None.

ServiceCodes

The valid service codes for the requested shipping method.

Collection of ShippingServiceDetail

None.

Response Formats

application/json, text/json

Sample:
{
  "PackageCodes": [
    {
      "Code": "sample string 1",
      "Description": "sample string 2",
      "RequiresDimensions": true,
      "RequiresWeight": true,
      "DefaultLengthInInches": 1.0,
      "DefaultWidthInInches": 1.0,
      "DefaultHeightInInches": 1.0,
      "IsExclusive": true,
      "MinimumDimensions": 1.0,
      "MaximumDimensions": 1.0,
      "MaximumWeight": 6.0
    },
    {
      "Code": "sample string 1",
      "Description": "sample string 2",
      "RequiresDimensions": true,
      "RequiresWeight": true,
      "DefaultLengthInInches": 1.0,
      "DefaultWidthInInches": 1.0,
      "DefaultHeightInInches": 1.0,
      "IsExclusive": true,
      "MinimumDimensions": 1.0,
      "MaximumDimensions": 1.0,
      "MaximumWeight": 6.0
    }
  ],
  "ServiceCodes": [
    {
      "Code": "sample string 1",
      "Description": "sample string 2",
      "IsInternational": true,
      "MaxPackageCount": 4,
      "MaxEmailNotificationCount": 5,
      "SignatureRequiredAvailable": true,
      "ScheduledPickupAvailable": true,
      "SaturdayDeliveryAvailable": true,
      "SupportsCustomLabelData": true,
      "SupportsCustomLabelDataHeader": true,
      "SupportsReturnLabelsAsSource": true,
      "SupportsReturnLabelsAsDestination": true,
      "PackageCodes": [
        {
          "Code": "sample string 1",
          "Description": "sample string 2",
          "RequiresDimensions": true,
          "RequiresWeight": true,
          "DefaultLengthInInches": 1.0,
          "DefaultWidthInInches": 1.0,
          "DefaultHeightInInches": 1.0,
          "IsExclusive": true,
          "MinimumDimensions": 1.0,
          "MaximumDimensions": 1.0,
          "MaximumWeight": 6.0
        },
        {
          "Code": "sample string 1",
          "Description": "sample string 2",
          "RequiresDimensions": true,
          "RequiresWeight": true,
          "DefaultLengthInInches": 1.0,
          "DefaultWidthInInches": 1.0,
          "DefaultHeightInInches": 1.0,
          "IsExclusive": true,
          "MinimumDimensions": 1.0,
          "MaximumDimensions": 1.0,
          "MaximumWeight": 6.0
        }
      ]
    },
    {
      "Code": "sample string 1",
      "Description": "sample string 2",
      "IsInternational": true,
      "MaxPackageCount": 4,
      "MaxEmailNotificationCount": 5,
      "SignatureRequiredAvailable": true,
      "ScheduledPickupAvailable": true,
      "SaturdayDeliveryAvailable": true,
      "SupportsCustomLabelData": true,
      "SupportsCustomLabelDataHeader": true,
      "SupportsReturnLabelsAsSource": true,
      "SupportsReturnLabelsAsDestination": true,
      "PackageCodes": [
        {
          "Code": "sample string 1",
          "Description": "sample string 2",
          "RequiresDimensions": true,
          "RequiresWeight": true,
          "DefaultLengthInInches": 1.0,
          "DefaultWidthInInches": 1.0,
          "DefaultHeightInInches": 1.0,
          "IsExclusive": true,
          "MinimumDimensions": 1.0,
          "MaximumDimensions": 1.0,
          "MaximumWeight": 6.0
        },
        {
          "Code": "sample string 1",
          "Description": "sample string 2",
          "RequiresDimensions": true,
          "RequiresWeight": true,
          "DefaultLengthInInches": 1.0,
          "DefaultWidthInInches": 1.0,
          "DefaultHeightInInches": 1.0,
          "IsExclusive": true,
          "MinimumDimensions": 1.0,
          "MaximumDimensions": 1.0,
          "MaximumWeight": 6.0
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<OrderShippingMethodDetails xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
  <PackageCodes>
    <ShippingPackageDetail>
      <Code>sample string 1</Code>
      <Description>sample string 2</Description>
      <RequiresDimensions>true</RequiresDimensions>
      <RequiresWeight>true</RequiresWeight>
      <DefaultLengthInInches>1</DefaultLengthInInches>
      <DefaultWidthInInches>1</DefaultWidthInInches>
      <DefaultHeightInInches>1</DefaultHeightInInches>
      <IsExclusive>true</IsExclusive>
      <MinimumDimensions>1</MinimumDimensions>
      <MaximumDimensions>1</MaximumDimensions>
      <MaximumWeight>6</MaximumWeight>
    </ShippingPackageDetail>
    <ShippingPackageDetail>
      <Code>sample string 1</Code>
      <Description>sample string 2</Description>
      <RequiresDimensions>true</RequiresDimensions>
      <RequiresWeight>true</RequiresWeight>
      <DefaultLengthInInches>1</DefaultLengthInInches>
      <DefaultWidthInInches>1</DefaultWidthInInches>
      <DefaultHeightInInches>1</DefaultHeightInInches>
      <IsExclusive>true</IsExclusive>
      <MinimumDimensions>1</MinimumDimensions>
      <MaximumDimensions>1</MaximumDimensions>
      <MaximumWeight>6</MaximumWeight>
    </ShippingPackageDetail>
  </PackageCodes>
  <ServiceCodes>
    <ShippingServiceDetail>
      <Code>sample string 1</Code>
      <Description>sample string 2</Description>
      <IsInternational>true</IsInternational>
      <MaxPackageCount>4</MaxPackageCount>
      <MaxEmailNotificationCount>5</MaxEmailNotificationCount>
      <SignatureRequiredAvailable>true</SignatureRequiredAvailable>
      <ScheduledPickupAvailable>true</ScheduledPickupAvailable>
      <SaturdayDeliveryAvailable>true</SaturdayDeliveryAvailable>
      <SupportsCustomLabelData>true</SupportsCustomLabelData>
      <SupportsCustomLabelDataHeader>true</SupportsCustomLabelDataHeader>
      <SupportsReturnLabelsAsSource>true</SupportsReturnLabelsAsSource>
      <SupportsReturnLabelsAsDestination>true</SupportsReturnLabelsAsDestination>
      <PackageCodes>
        <ShippingPackageDetail>
          <Code>sample string 1</Code>
          <Description>sample string 2</Description>
          <RequiresDimensions>true</RequiresDimensions>
          <RequiresWeight>true</RequiresWeight>
          <DefaultLengthInInches>1</DefaultLengthInInches>
          <DefaultWidthInInches>1</DefaultWidthInInches>
          <DefaultHeightInInches>1</DefaultHeightInInches>
          <IsExclusive>true</IsExclusive>
          <MinimumDimensions>1</MinimumDimensions>
          <MaximumDimensions>1</MaximumDimensions>
          <MaximumWeight>6</MaximumWeight>
        </ShippingPackageDetail>
        <ShippingPackageDetail>
          <Code>sample string 1</Code>
          <Description>sample string 2</Description>
          <RequiresDimensions>true</RequiresDimensions>
          <RequiresWeight>true</RequiresWeight>
          <DefaultLengthInInches>1</DefaultLengthInInches>
          <DefaultWidthInInches>1</DefaultWidthInInches>
          <DefaultHeightInInches>1</DefaultHeightInInches>
          <IsExclusive>true</IsExclusive>
          <MinimumDimensions>1</MinimumDimensions>
          <MaximumDimensions>1</MaximumDimensions>
          <MaximumWeight>6</MaximumWeight>
        </ShippingPackageDetail>
      </PackageCodes>
    </ShippingServiceDetail>
    <ShippingServiceDetail>
      <Code>sample string 1</Code>
      <Description>sample string 2</Description>
      <IsInternational>true</IsInternational>
      <MaxPackageCount>4</MaxPackageCount>
      <MaxEmailNotificationCount>5</MaxEmailNotificationCount>
      <SignatureRequiredAvailable>true</SignatureRequiredAvailable>
      <ScheduledPickupAvailable>true</ScheduledPickupAvailable>
      <SaturdayDeliveryAvailable>true</SaturdayDeliveryAvailable>
      <SupportsCustomLabelData>true</SupportsCustomLabelData>
      <SupportsCustomLabelDataHeader>true</SupportsCustomLabelDataHeader>
      <SupportsReturnLabelsAsSource>true</SupportsReturnLabelsAsSource>
      <SupportsReturnLabelsAsDestination>true</SupportsReturnLabelsAsDestination>
      <PackageCodes>
        <ShippingPackageDetail>
          <Code>sample string 1</Code>
          <Description>sample string 2</Description>
          <RequiresDimensions>true</RequiresDimensions>
          <RequiresWeight>true</RequiresWeight>
          <DefaultLengthInInches>1</DefaultLengthInInches>
          <DefaultWidthInInches>1</DefaultWidthInInches>
          <DefaultHeightInInches>1</DefaultHeightInInches>
          <IsExclusive>true</IsExclusive>
          <MinimumDimensions>1</MinimumDimensions>
          <MaximumDimensions>1</MaximumDimensions>
          <MaximumWeight>6</MaximumWeight>
        </ShippingPackageDetail>
        <ShippingPackageDetail>
          <Code>sample string 1</Code>
          <Description>sample string 2</Description>
          <RequiresDimensions>true</RequiresDimensions>
          <RequiresWeight>true</RequiresWeight>
          <DefaultLengthInInches>1</DefaultLengthInInches>
          <DefaultWidthInInches>1</DefaultWidthInInches>
          <DefaultHeightInInches>1</DefaultHeightInInches>
          <IsExclusive>true</IsExclusive>
          <MinimumDimensions>1</MinimumDimensions>
          <MaximumDimensions>1</MaximumDimensions>
          <MaximumWeight>6</MaximumWeight>
        </ShippingPackageDetail>
      </PackageCodes>
    </ShippingServiceDetail>
  </ServiceCodes>
</OrderShippingMethodDetails>