---
title: "Processes Request to Ship"
method: POST
path: "/request/Ship"
tags: ["Ship"]
---

# Processes Request to Ship

`POST /request/Ship`

## Request

- Base URL: `https://api.idsfulfillment.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.idsfulfillment.com/request/Ship`
- Auth: none declared. Required headers: `ApiKey`

Processes a list of orders in a Request to Ship

## Request body

- RequestToShip
  - `Orders` RequestToShipOrder[], nullable
    - `CustomerOrderReferenceNumber` string, nullable
    - `ConsigneeCode` string, nullable
    - `ConsigneePONumber` string, nullable
    - `ZoneCode` string, nullable
    - `CZone` string, nullable
    - `ScheduledShipDate` string, nullable
    - `ScheduledShipTime` string, nullable
    - `ScheduledArrivalDate` string, nullable
    - `CarrierCode` string, nullable
    - `ShipType` string, nullable
    - `BrokerName` string, nullable
    - `FreightChargeCode` string, nullable
    - `COD` string, nullable
    - `ProNumber` string, nullable
    - `F856` string, nullable
    - `F128` string, nullable
    - `ConsolidationLoadNumber` string, nullable
    - `ConsolidationStopNumber` string, nullable
    - `ThirdPartyAccount` string, nullable
    - `PackingInstructions` string, nullable
    - `POs` RequestToShipPO[], nullable
      - `PONumber` string, nullable
    - `Events` RequestToShipEvent[], nullable
      - `DataElementCode` string, nullable
      - `StatusCode` string, nullable
      - `Description` string, nullable
    - `OrderExtraDataFields` RequestToShipOrderExtraDataField[], nullable
      - `ExtraDataFieldLabel` string, nullable
      - `ExtraDataFieldValue` string, nullable
      - `ExtraDataFieldLength` string, nullable
    - `OrderItems` RequestToShipOrderItem[], nullable
      - `LineNumber` string, nullable
      - `WMSLineNumber` integer, nullable
      - `ShipFromBucket` string, nullable
      - `QuantityOrdered` integer, nullable
      - `QuantityShipped` integer, nullable
      - `SKU` string, nullable
      - `LotCode1` string, nullable
      - `LotCode2` string, nullable
      - `LotCode3` string, nullable
      - `OrderItemComments` RequestToShipOrderItemComment[], nullable
        - `PrintSequence` string, nullable
        - `EDISegmentID` string, nullable
        - `Qual` string, nullable
        - `CommentText` string, nullable
      - `OrderItemExtraDataFields` RequestToShipOrderItemExtraDataField[], nullable
        - `ExtraDataFieldLabel` string, nullable
        - `ExtraDataFieldValue` string, nullable
        - `ExtraDataFieldLength` string, nullable
    - `BillToAddress` RequestToShipAddress
      - `Name` string, nullable
      - `Company` string, nullable: Secondary Name - company/attn/contact. "contact" in IRMS.
      - `AddressLine1` string, nullable
      - `AddressLine2` string, nullable
      - `AddressLine3` string, nullable
      - `Phone` string, nullable
      - `Email` string, nullable
      - `City` string, nullable
      - `State` string, nullable
      - `Zip` string, nullable
      - `CountryCode` string, nullable
      - `Classification` 'U' | 'R' | 'C' | 'M': <p>Members:</p><ul></ul>
      - `ExternalID` string, nullable
      - `ExternalType` string, nullable
    - `ShipToAddress` RequestToShipAddress
      - `Name` string, nullable
      - `Company` string, nullable: Secondary Name - company/attn/contact. "contact" in IRMS.
      - `AddressLine1` string, nullable
      - `AddressLine2` string, nullable
      - `AddressLine3` string, nullable
      - `Phone` string, nullable
      - `Email` string, nullable
      - `City` string, nullable
      - `State` string, nullable
      - `Zip` string, nullable
      - `CountryCode` string, nullable
      - `Classification` 'U' | 'R' | 'C' | 'M': <p>Members:</p><ul></ul>
      - `ExternalID` string, nullable
      - `ExternalType` string, nullable
    - `ThreePAddress` RequestToShipAddress
      - `Name` string, nullable
      - `Company` string, nullable: Secondary Name - company/attn/contact. "contact" in IRMS.
      - `AddressLine1` string, nullable
      - `AddressLine2` string, nullable
      - `AddressLine3` string, nullable
      - `Phone` string, nullable
      - `Email` string, nullable
      - `City` string, nullable
      - `State` string, nullable
      - `Zip` string, nullable
      - `CountryCode` string, nullable
      - `Classification` 'U' | 'R' | 'C' | 'M': <p>Members:</p><ul></ul>
      - `ExternalID` string, nullable
      - `ExternalType` string, nullable
    - `ShipFromAddress` RequestToShipAddress
      - `Name` string, nullable
      - `Company` string, nullable: Secondary Name - company/attn/contact. "contact" in IRMS.
      - `AddressLine1` string, nullable
      - `AddressLine2` string, nullable
      - `AddressLine3` string, nullable
      - `Phone` string, nullable
      - `Email` string, nullable
      - `City` string, nullable
      - `State` string, nullable
      - `Zip` string, nullable
      - `CountryCode` string, nullable
      - `Classification` 'U' | 'R' | 'C' | 'M': <p>Members:</p><ul></ul>
      - `ExternalID` string, nullable
      - `ExternalType` string, nullable
    - `OrderComments` RequestToShipOrderComment[], nullable
      - `PrintSequence` string, nullable
      - `EDISegmentID` string, nullable
      - `Qual` string, nullable
      - `CommentText` string, nullable
      - `PrintLabel` string, nullable
    - `RetryCount` integer, nullable

## Response `200`

Ok

## Other responses

- `400`: Bad Request
- `500`: Internal Server Error

---

[API](https://skmtc.dev/idsfulfillment/apis/ids-public-api.md) · [All operations](https://skmtc.dev/idsfulfillment/apis/ids-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/idsfulfillment/apis/ids-public-api/revisions/3dd5de07443b?raw)