POST order/shipping

Authorized only.

Request Information

URI Parameters

None.

Body Parameters

ApiUpdateShippingRequest
NameDescriptionTypeAdditional information
Orders

Collection of integer

None.
ShippingStatusId

integer

None.
ShippingOptionId

integer

None.
ShippingDate

date

None.
ServingDate

date

None.
DeliveryProviderId

integer

None.
DeliveryEmployeeId

integer

None.
ChangeReason

string

None.
EstimatedTimeSeconds

integer

None.
EstimatedDistanceMeters

integer

None.
Params

Dictionary of string [key] and Object [value]

None.
Cellphone

string

None.
Email

string

None.
Address1

string

None.
Address2

string

None.
City

string

None.
State

integer

None.
StateName

string

None.
Zip

string

None.
ShippingMethod

string

None.
ShippingCarrierCode

string

None.
ShippingServiceCode

string

None.
PickupLocationId

integer

None.

Request Formats

application/json, text/json

Sample: 
{
  "Orders": [
    1,
    2
  ],
  "ShippingStatusId": 1,
  "ShippingOptionId": 1,
  "ShippingDate": "2024-11-21T02:31:21.500969-05:00",
  "ServingDate": "2024-11-21T02:31:21.500969-05:00",
  "DeliveryProviderId": 1,
  "DeliveryEmployeeId": 1,
  "ChangeReason": "sample string 1",
  "EstimatedTimeSeconds": 1,
  "EstimatedDistanceMeters": 1,
  "Params": {
    "sample string 1": {},
    "sample string 3": {}
  },
  "Cellphone": "sample string 2",
  "Email": "sample string 3",
  "Address1": "sample string 4",
  "Address2": "sample string 5",
  "City": "sample string 6",
  "State": 1,
  "StateName": "sample string 7",
  "Zip": "sample string 8",
  "ShippingMethod": "sample string 9",
  "ShippingCarrierCode": "sample string 10",
  "ShippingServiceCode": "sample string 11",
  "PickupLocationId": 1
}

application/xml, text/xml

Sample: 
<ApiUpdateShippingRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/IConnect.Domain.Mobile.Api.Requests">
  <Address1>sample string 4</Address1>
  <Address2>sample string 5</Address2>
  <Cellphone>sample string 2</Cellphone>
  <ChangeReason>sample string 1</ChangeReason>
  <City>sample string 6</City>
  <DeliveryEmployeeId>1</DeliveryEmployeeId>
  <DeliveryProviderId>1</DeliveryProviderId>
  <Email>sample string 3</Email>
  <EstimatedDistanceMeters>1</EstimatedDistanceMeters>
  <EstimatedTimeSeconds>1</EstimatedTimeSeconds>
  <Orders xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:int>1</d2p1:int>
    <d2p1:int>2</d2p1:int>
  </Orders>
  <Params xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>sample string 3</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </Params>
  <PickupLocationId>1</PickupLocationId>
  <ServingDate>2024-11-21T02:31:21.500969-05:00</ServingDate>
  <ShippingCarrierCode>sample string 10</ShippingCarrierCode>
  <ShippingDate>2024-11-21T02:31:21.500969-05:00</ShippingDate>
  <ShippingMethod>sample string 9</ShippingMethod>
  <ShippingOptionId>1</ShippingOptionId>
  <ShippingServiceCode>sample string 11</ShippingServiceCode>
  <ShippingStatusId>1</ShippingStatusId>
  <State>1</State>
  <StateName>sample string 7</StateName>
  <Zip>sample string 8</Zip>
</ApiUpdateShippingRequest>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

HttpResponseMessage
NameDescriptionTypeAdditional information
Version

Version

None.
Content

HttpContent

None.
StatusCode

HttpStatusCode

None.
ReasonPhrase

string

None.
Headers

Collection of Object

None.
RequestMessage

HttpRequestMessage

None.
IsSuccessStatusCode

boolean

None.