POST api/OrderDetails/ShipStationXML?action={action}&order_number={order_number}&carrier={carrier}&service={service}&tracking_number={tracking_number}

Documentation for 'ShipStationXML'.

Request Information

Parameters

NameDescriptionAdditional information
shipnotice 
Documentation for 'shipnotice'.

Define this parameter in the request body.
action 
Documentation for 'action'.

Define this parameter in the request URI.
order_number 
Documentation for 'order_number'.

Define this parameter in the request URI.
carrier 
Documentation for 'carrier'.

Define this parameter in the request URI.
service 
Documentation for 'service'.

Define this parameter in the request URI.
tracking_number 
Documentation for 'tracking_number'.

Define this parameter in the request URI.

Request body formats

application/json, text/json

Sample: 
{
  "OrderID": "sample string 1",
  "OrderNumber": "sample string 2",
  "CustomerCode": "sample string 3",
  "CustomerNotes": "sample string 4",
  "InternalNotes": "sample string 5",
  "NotesToCustomer": "sample string 6",
  "NotifyCustomer": "sample string 7",
  "LabelCreateDate": "sample string 8",
  "ShipDate": "sample string 9",
  "Carrier": "sample string 10",
  "Service": "sample string 11",
  "TrackingNumber": "sample string 12",
  "ShippingCost": 13.0,
  "Recipient": {
    "Name": "sample string 1",
    "Company": "sample string 2",
    "Address1": "sample string 3",
    "Address2": "sample string 4",
    "City": "sample string 5",
    "State": "sample string 6",
    "PostalCode": "sample string 7",
    "Country": "sample string 8"
  },
  "Items": {
    "Item": [
      {
        "LineItemID": "sample string 1",
        "SKU": "sample string 2",
        "Name": "sample string 3",
        "Quantity": 4
      },
      {
        "LineItemID": "sample string 1",
        "SKU": "sample string 2",
        "Name": "sample string 3",
        "Quantity": 4
      },
      {
        "LineItemID": "sample string 1",
        "SKU": "sample string 2",
        "Name": "sample string 3",
        "Quantity": 4
      }
    ]
  }
}

application/xml, text/xml

Sample: 
<ShipNotice xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <OrderID>sample string 1</OrderID>
  <OrderNumber>sample string 2</OrderNumber>
  <CustomerCode>sample string 3</CustomerCode>
  <CustomerNotes>sample string 4</CustomerNotes>
  <InternalNotes>sample string 5</InternalNotes>
  <NotesToCustomer>sample string 6</NotesToCustomer>
  <NotifyCustomer>sample string 7</NotifyCustomer>
  <LabelCreateDate>sample string 8</LabelCreateDate>
  <ShipDate>sample string 9</ShipDate>
  <Carrier>sample string 10</Carrier>
  <Service>sample string 11</Service>
  <TrackingNumber>sample string 12</TrackingNumber>
  <ShippingCost>13</ShippingCost>
  <Recipient>
    <Name>sample string 1</Name>
    <Company>sample string 2</Company>
    <Address1>sample string 3</Address1>
    <Address2>sample string 4</Address2>
    <City>sample string 5</City>
    <State>sample string 6</State>
    <PostalCode>sample string 7</PostalCode>
    <Country>sample string 8</Country>
  </Recipient>
  <Items>
    <Item>
      <ShipmentItem>
        <LineItemID>sample string 1</LineItemID>
        <SKU>sample string 2</SKU>
        <Name>sample string 3</Name>
        <Quantity>4</Quantity>
      </ShipmentItem>
      <ShipmentItem>
        <LineItemID>sample string 1</LineItemID>
        <SKU>sample string 2</SKU>
        <Name>sample string 3</Name>
        <Quantity>4</Quantity>
      </ShipmentItem>
      <ShipmentItem>
        <LineItemID>sample string 1</LineItemID>
        <SKU>sample string 2</SKU>
        <Name>sample string 3</Name>
        <Quantity>4</Quantity>
      </ShipmentItem>
    </Item>
  </Items>
</ShipNotice>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'FormUrlEncodedMediaTypeFormatterTracer' to write type 'ShipNotice'.