POST v1/ShipStation
Request Information
URI Parameters
None.
Body Parameters
ShipStationShipNoticeName | Description | Type | Additional information |
---|---|---|---|
OrderNumber | string |
None. |
|
OrderID | string |
None. |
|
CustomerCode | string |
None. |
|
CustomerNotes | string |
None. |
|
InternalNotes | string |
None. |
|
NotesToCustomer | string |
None. |
|
NotifyCustomer | string |
None. |
|
LabelCreateDate | string |
None. |
|
ShipDate | string |
None. |
|
Carrier | string |
None. |
|
Service | string |
None. |
|
TrackingNumber | string |
None. |
|
ShippingCost | decimal number |
None. |
|
CustomField1 | string |
None. |
|
CustomField2 | string |
None. |
|
CustomField3 | string |
None. |
|
Recipient | ShipStationShipNoticeRecipient |
None. |
|
Items | Collection of ShipStationShipNoticeItem |
None. |
Request Formats
application/json, text/json
Sample:
{ "OrderNumber": "sample string 1", "OrderID": "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, "CustomField1": "sample string 14", "CustomField2": "sample string 15", "CustomField3": "sample string 16", "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": [ { "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:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"> <OrderNumber>sample string 1</OrderNumber> <OrderID>sample string 2</OrderID> <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> <CustomField1>sample string 14</CustomField1> <CustomField2>sample string 15</CustomField2> <CustomField3>sample string 16</CustomField3> <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> <LineItemID>sample string 1</LineItemID> <SKU>sample string 2</SKU> <Name>sample string 3</Name> <Quantity>4</Quantity> </Item> <Item> <LineItemID>sample string 1</LineItemID> <SKU>sample string 2</SKU> <Name>sample string 3</Name> <Quantity>4</Quantity> </Item> </Items> </ShipNotice>
application/x-www-form-urlencoded
Sample:
Response Information
Resource Description
HttpResponseMessageName | Description | Type | Additional information |
---|---|---|---|
Version | Version |
None. |
|
Content | HttpContent |
None. |
|
StatusCode | HttpStatusCode |
None. |
|
ReasonPhrase | string |
None. |
|
Headers | Collection of Object |
None. |
|
RequestMessage | HttpRequestMessage |
None. |
|
IsSuccessStatusCode | boolean |
None. |