GET api/ShipmentOuts/ShippingBoxInfoes?orderID={orderID}&keyType={keyType}

Get a shipping box list

Request Information

URI Parameters

NameDescriptionTypeAdditional information
orderID

Customer OrderId

string

Required

keyType

SHIPMENT_MASTERKEYTYPE

Default value is ORDERID

Body Parameters

None.

Response Information

Resource Description

ResponseApiInfoOfShipmentOutShippingBoxInfoesResponse
NameDescriptionTypeAdditional information
data

ShipmentOutShippingBoxInfoesResponse

None.

UpdateResult

UPDATECODE

None.

isErrorOnRequest

boolean

None.

errorMessage

string

None.

errorMessages

Collection of ErrorInfo

None.

warningMessages

Collection of ErrorInfo

None.

isSuccess

boolean

None.

Response Formats

application/json, text/json

Sample:
{
  "isSuccess": true,
  "data": {
    "BoxInfoes": [
      {
        "items": [
          {
            "sku": "sample string 1",
            "quantity": 2,
            "receivedQuantity": 3,
            "unitPrice": 4.0,
            "otherSku": "sample string 5"
          },
          {
            "sku": "sample string 1",
            "quantity": 2,
            "receivedQuantity": 3,
            "unitPrice": 4.0,
            "otherSku": "sample string 5"
          }
        ],
        "serialNo": 1,
        "width": 2.0,
        "length": 3.0,
        "height": 4.0,
        "weight": 5.0,
        "isBoxProduct": true
      },
      {
        "items": [
          {
            "sku": "sample string 1",
            "quantity": 2,
            "receivedQuantity": 3,
            "unitPrice": 4.0,
            "otherSku": "sample string 5"
          },
          {
            "sku": "sample string 1",
            "quantity": 2,
            "receivedQuantity": 3,
            "unitPrice": 4.0,
            "otherSku": "sample string 5"
          }
        ],
        "serialNo": 1,
        "width": 2.0,
        "length": 3.0,
        "height": 4.0,
        "weight": 5.0,
        "isBoxProduct": true
      }
    ]
  },
  "UpdateResult": "CREATE",
  "isErrorOnRequest": true,
  "errorMessage": null,
  "errorMessages": [],
  "warningMessages": []
}

application/xml, text/xml

Sample:
<xml xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <isSuccess>true</isSuccess>
  <UpdateResult>CREATE</UpdateResult>
  <isErrorOnRequest>true</isErrorOnRequest>
  <errorMessages />
  <warningMessages />
  <data>
    <BoxInfoes>
      <ShipmentOutShippingBoxInfo>
        <items>
          <ShipmentProductQuantityInfo>
            <sku>sample string 1</sku>
            <quantity>2</quantity>
            <receivedQuantity>3</receivedQuantity>
            <unitPrice>4</unitPrice>
            <otherSku>sample string 5</otherSku>
          </ShipmentProductQuantityInfo>
          <ShipmentProductQuantityInfo>
            <sku>sample string 1</sku>
            <quantity>2</quantity>
            <receivedQuantity>3</receivedQuantity>
            <unitPrice>4</unitPrice>
            <otherSku>sample string 5</otherSku>
          </ShipmentProductQuantityInfo>
        </items>
        <serialNo>1</serialNo>
        <width>2</width>
        <length>3</length>
        <height>4</height>
        <weight>5</weight>
        <isBoxProduct>true</isBoxProduct>
      </ShipmentOutShippingBoxInfo>
      <ShipmentOutShippingBoxInfo>
        <items>
          <ShipmentProductQuantityInfo>
            <sku>sample string 1</sku>
            <quantity>2</quantity>
            <receivedQuantity>3</receivedQuantity>
            <unitPrice>4</unitPrice>
            <otherSku>sample string 5</otherSku>
          </ShipmentProductQuantityInfo>
          <ShipmentProductQuantityInfo>
            <sku>sample string 1</sku>
            <quantity>2</quantity>
            <receivedQuantity>3</receivedQuantity>
            <unitPrice>4</unitPrice>
            <otherSku>sample string 5</otherSku>
          </ShipmentProductQuantityInfo>
        </items>
        <serialNo>1</serialNo>
        <width>2</width>
        <length>3</length>
        <height>4</height>
        <weight>5</weight>
        <isBoxProduct>true</isBoxProduct>
      </ShipmentOutShippingBoxInfo>
    </BoxInfoes>
  </data>
</xml>