shipment

POST /shipment

API endpoint for creating a new Ice Delivery shipment in the Maven system. destinationTerminalCode, productCode(s), and consignee customer number are all foreign keys that must exist in the system.

post/shipment

Request

Base URL: https://reddy-ice.middleware.mavenmachines.com
URL: https://reddy-ice.middleware.mavenmachines.com/shipment
Auth: API key in header apiKey

Request body

Example request

{
  "associatedShipment": {
    "consigneeCustomerNumber": "045037666",
    "distributorId": "relationship123",
    "deliveryServiceStartDate": "2025-12-11",
    "deliveryServiceDueDate": "2025-12-10",
    "destinationTerminalCode": "206",
    "instructions": "printNameAndSignature",
    "proNumber": "808003052_168",
    "inboundInterlineProNumber": "2025-10-02",
    "shipmentItems": [
      {
        "description": "7_LB Bags",
        "sku": "7_LB",
        "productCode": "200771",
        "upc": "00860006114916",
        "required": true,
        "quantities": [
          {
            "unit": "Bags"
          }
        ]
      }
    ],
    "podRequirements": {
      "printNameAndSignature": true
    },
    "paymentOnDelivery": {
      "accept": {
        "check": true,
        "cash": true,
        "credit": true
      }
    },
    "customerOrderNumber": "23979620",
    "reddyiceGUID": "67d2a718-578a-f011-b4cb-7c1e5280196d",
    "purchaseOrderNumber": "varchar36",
    "shipmentTags": [
      "3P"
    ],
    "shipmentType": "delivery",
    "ticketType": "1",
    "deliveryPriorityLevel": 4,
    "deliveryDate": "2025-11-20"
  }
}

Response

Shipment created successfully

taskIdstring required

Example response

{
  "taskId": "t:bef3536e-d100-4b25-9725-750b67f89aac"
}

Changes

No recorded changes to this operation across all 1 revision of this API.