POST api/UPS/CreateInternationalShipment

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
RefNumber	string	None.
id	string	None.
Type	string	None.
Marketplace	string	None.
OrderNumber	integer	None.
NSOrderNumber	string	None.
NSOrderInternalId	string	None.
AppliedOrderNumber	string	None.
OrderStatus	string	None.
NSOrderStatus	string	None.
AccountNumber	string	None.
UserName	string	None.
UserId	string	None.
FirstName	string	None.
LastName	string	None.
MiddleName	string	None.
EmailAddress	string	None.
PayPalEmailAddress	string	None.
Notes	string	None.
TrackingNumber	string	None.
LabelLocation	string	None.
TrackingNumbers	Collection of string	None.
LabelLocations	Collection of string	None.
CouponCode	string	None.
PaymentMethod	string	None.
CompanyName	string	None.
StoreCreditBonus	integer	None.
CouponDiscount	integer	None.
AdditionalStoreCredit	decimal number	None.
OrderSubTotal	decimal number	None.
OrderTotal	decimal number	None.
OrderBonus	decimal number	None.
OrderCoupon	decimal number	None.
OrderShipping	decimal number	None.
OrderPaymentFee	decimal number	None.
RewardsPoints	integer	None.
IsTotalAdjusted	boolean	None.
CreatedDate	date	None.
ModifiedDate	date	None.
ReminderDate	date	None.
Reminder2Date	date	None.
ReceivedDate	date	None.
CreatedBy	string	None.
ModifiedBy	string	None.
BillingAddress	Address	None.
ShippingAddress	Address	None.
OrderLines	Collection of OrderLine	None.
NumberOfLabels	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "RefNumber": "sample string 1",
  "id": "sample string 2",
  "Type": "sample string 3",
  "Marketplace": "sample string 4",
  "OrderNumber": 5,
  "NSOrderNumber": "sample string 6",
  "NSOrderInternalId": "sample string 7",
  "AppliedOrderNumber": "sample string 8",
  "OrderStatus": "sample string 9",
  "NSOrderStatus": "sample string 10",
  "AccountNumber": "sample string 11",
  "UserName": "sample string 12",
  "UserId": "sample string 13",
  "FirstName": "sample string 14",
  "LastName": "sample string 15",
  "MiddleName": "sample string 16",
  "EmailAddress": "sample string 17",
  "PayPalEmailAddress": "sample string 18",
  "Notes": "sample string 19",
  "TrackingNumber": "sample string 20",
  "LabelLocation": "sample string 21",
  "TrackingNumbers": [
    "sample string 1",
    "sample string 2"
  ],
  "LabelLocations": [
    "sample string 1",
    "sample string 2"
  ],
  "CouponCode": "sample string 22",
  "PaymentMethod": "sample string 23",
  "CompanyName": "sample string 24",
  "StoreCreditBonus": 25,
  "CouponDiscount": 26,
  "AdditionalStoreCredit": 27.1,
  "OrderSubTotal": 28.1,
  "OrderTotal": 29.1,
  "OrderBonus": 30.1,
  "OrderCoupon": 31.1,
  "OrderShipping": 32.1,
  "OrderPaymentFee": 33.1,
  "RewardsPoints": 34,
  "IsTotalAdjusted": true,
  "CreatedDate": "2025-03-15T17:44:46.9199349+00:00",
  "ModifiedDate": "2025-03-15T17:44:46.9199349+00:00",
  "ReminderDate": "2025-03-15T17:44:46.9199349+00:00",
  "Reminder2Date": "2025-03-15T17:44:46.9199349+00:00",
  "ReceivedDate": "2025-03-15T17:44:46.9199349+00:00",
  "CreatedBy": "sample string 41",
  "ModifiedBy": "sample string 42",
  "BillingAddress": {
    "Name": "sample string 1",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "AddressName": "sample string 4",
    "CompanyName": "sample string 5",
    "AddressLine1": "sample string 6",
    "AddressLine2": "sample string 7",
    "City": "sample string 8",
    "State": "sample string 9",
    "Zip": "sample string 10",
    "Country": "sample string 11",
    "HomePhone": "sample string 12",
    "MobilePhone": "sample string 13"
  },
  "ShippingAddress": {
    "Name": "sample string 1",
    "FirstName": "sample string 2",
    "LastName": "sample string 3",
    "AddressName": "sample string 4",
    "CompanyName": "sample string 5",
    "AddressLine1": "sample string 6",
    "AddressLine2": "sample string 7",
    "City": "sample string 8",
    "State": "sample string 9",
    "Zip": "sample string 10",
    "Country": "sample string 11",
    "HomePhone": "sample string 12",
    "MobilePhone": "sample string 13"
  },
  "OrderLines": [
    {
      "Sku": "sample string 1",
      "NSInternalId": "sample string 2",
      "Quantity": 3,
      "ClubCount": 4,
      "ClubType": "sample string 5",
      "ClubDexterity": "sample string 6",
      "ShaftType": "sample string 7",
      "ClubBrand": "sample string 8",
      "ClubModel": "sample string 9",
      "Condition": "sample string 10",
      "Location": "sample string 11",
      "Premium": "sample string 12",
      "Value": 13.1,
      "Cost": 14.1,
      "Headcover": true,
      "HeadcoverValue": 1.1,
      "Tool": true,
      "ToolValue": 1.1,
      "ShaftUpgrade": true,
      "ShaftUpgradeValue": 1.1
    },
    {
      "Sku": "sample string 1",
      "NSInternalId": "sample string 2",
      "Quantity": 3,
      "ClubCount": 4,
      "ClubType": "sample string 5",
      "ClubDexterity": "sample string 6",
      "ShaftType": "sample string 7",
      "ClubBrand": "sample string 8",
      "ClubModel": "sample string 9",
      "Condition": "sample string 10",
      "Location": "sample string 11",
      "Premium": "sample string 12",
      "Value": 13.1,
      "Cost": 14.1,
      "Headcover": true,
      "HeadcoverValue": 1.1,
      "Tool": true,
      "ToolValue": 1.1,
      "ShaftUpgrade": true,
      "ShaftUpgradeValue": 1.1
    }
  ],
  "NumberOfLabels": 43
}

application/xml, text/xml

Sample:

<ProOrder xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <Id>sample string 2</Id>
  <Type>sample string 3</Type>
  <Marketplace>sample string 4</Marketplace>
  <OrderNumber>5</OrderNumber>
  <NSOrderNumber>sample string 6</NSOrderNumber>
  <NSOrderInternalId>sample string 7</NSOrderInternalId>
  <AppliedOrderNumber>sample string 8</AppliedOrderNumber>
  <OrderStatus>sample string 9</OrderStatus>
  <NSOrderStatus>sample string 10</NSOrderStatus>
  <AccountNumber>sample string 11</AccountNumber>
  <UserName>sample string 12</UserName>
  <UserId>sample string 13</UserId>
  <FirstName>sample string 14</FirstName>
  <LastName>sample string 15</LastName>
  <MiddleName>sample string 16</MiddleName>
  <EmailAddress>sample string 17</EmailAddress>
  <PayPalEmailAddress>sample string 18</PayPalEmailAddress>
  <Notes>sample string 19</Notes>
  <TrackingNumber>sample string 20</TrackingNumber>
  <LabelLocation>sample string 21</LabelLocation>
  <TrackingNumbers>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </TrackingNumbers>
  <LabelLocations>
    <string>sample string 1</string>
    <string>sample string 2</string>
  </LabelLocations>
  <CouponCode>sample string 22</CouponCode>
  <PaymentMethod>sample string 23</PaymentMethod>
  <CompanyName>sample string 24</CompanyName>
  <StoreCreditBonus>25</StoreCreditBonus>
  <CouponDiscount>26</CouponDiscount>
  <AdditionalStoreCredit>27.1</AdditionalStoreCredit>
  <OrderSubTotal>28.1</OrderSubTotal>
  <OrderTotal>29.1</OrderTotal>
  <OrderBonus>30.1</OrderBonus>
  <OrderCoupon>31.1</OrderCoupon>
  <OrderShipping>32.1</OrderShipping>
  <OrderPaymentFee>33.1</OrderPaymentFee>
  <RewardsPoints>34</RewardsPoints>
  <IsTotalAdjusted>true</IsTotalAdjusted>
  <CreatedDate>2025-03-15T17:44:46.9199349+00:00</CreatedDate>
  <ModifiedDate>2025-03-15T17:44:46.9199349+00:00</ModifiedDate>
  <ReminderDate>2025-03-15T17:44:46.9199349+00:00</ReminderDate>
  <Reminder2Date>2025-03-15T17:44:46.9199349+00:00</Reminder2Date>
  <ReceivedDate>2025-03-15T17:44:46.9199349+00:00</ReceivedDate>
  <CreatedBy>sample string 41</CreatedBy>
  <ModifiedBy>sample string 42</ModifiedBy>
  <BillingAddress>
    <Name>sample string 1</Name>
    <FirstName>sample string 2</FirstName>
    <LastName>sample string 3</LastName>
    <AddressName>sample string 4</AddressName>
    <CompanyName>sample string 5</CompanyName>
    <AddressLine1>sample string 6</AddressLine1>
    <AddressLine2>sample string 7</AddressLine2>
    <City>sample string 8</City>
    <State>sample string 9</State>
    <Zip>sample string 10</Zip>
    <Country>sample string 11</Country>
    <HomePhone>sample string 12</HomePhone>
    <MobilePhone>sample string 13</MobilePhone>
  </BillingAddress>
  <ShippingAddress>
    <Name>sample string 1</Name>
    <FirstName>sample string 2</FirstName>
    <LastName>sample string 3</LastName>
    <AddressName>sample string 4</AddressName>
    <CompanyName>sample string 5</CompanyName>
    <AddressLine1>sample string 6</AddressLine1>
    <AddressLine2>sample string 7</AddressLine2>
    <City>sample string 8</City>
    <State>sample string 9</State>
    <Zip>sample string 10</Zip>
    <Country>sample string 11</Country>
    <HomePhone>sample string 12</HomePhone>
    <MobilePhone>sample string 13</MobilePhone>
  </ShippingAddress>
  <OrderLines>
    <OrderLine>
      <Sku>sample string 1</Sku>
      <NSInternalId>sample string 2</NSInternalId>
      <Quantity>3</Quantity>
      <ClubCount>4</ClubCount>
      <ClubType>sample string 5</ClubType>
      <ClubDexterity>sample string 6</ClubDexterity>
      <ShaftType>sample string 7</ShaftType>
      <ClubBrand>sample string 8</ClubBrand>
      <ClubModel>sample string 9</ClubModel>
      <Condition>sample string 10</Condition>
      <Location>sample string 11</Location>
      <Premium>sample string 12</Premium>
      <Value>13.1</Value>
      <Cost>14.1</Cost>
      <Headcover>true</Headcover>
      <HeadcoverValue>1.1</HeadcoverValue>
      <Tool>true</Tool>
      <ToolValue>1.1</ToolValue>
      <ShaftUpgrade>true</ShaftUpgrade>
      <ShaftUpgradeValue>1.1</ShaftUpgradeValue>
    </OrderLine>
    <OrderLine>
      <Sku>sample string 1</Sku>
      <NSInternalId>sample string 2</NSInternalId>
      <Quantity>3</Quantity>
      <ClubCount>4</ClubCount>
      <ClubType>sample string 5</ClubType>
      <ClubDexterity>sample string 6</ClubDexterity>
      <ShaftType>sample string 7</ShaftType>
      <ClubBrand>sample string 8</ClubBrand>
      <ClubModel>sample string 9</ClubModel>
      <Condition>sample string 10</Condition>
      <Location>sample string 11</Location>
      <Premium>sample string 12</Premium>
      <Value>13.1</Value>
      <Cost>14.1</Cost>
      <Headcover>true</Headcover>
      <HeadcoverValue>1.1</HeadcoverValue>
      <Tool>true</Tool>
      <ToolValue>1.1</ToolValue>
      <ShaftUpgrade>true</ShaftUpgrade>
      <ShaftUpgradeValue>1.1</ShaftUpgradeValue>
    </OrderLine>
  </OrderLines>
  <NumberOfLabels>43</NumberOfLabels>
  <RefNumber>sample string 1</RefNumber>
</ProOrder>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.