UMG-UK
  1. TMS Endpoints
UMG-UK
  • Outbound Orders
    • Get SalesOrder List
      GET
    • Create a SalesOrder
      POST
    • Get Sales Order Information
      GET
    • Sales Order Acknowledgement
      POST
    • Bulk Upload SalesOrders
      POST
    • Get Job Status of an Async Bulk Sales Order Import
      GET
    • Get a single SalesOrder
      GET
    • Update SalesOrder
      PUT
    • Cancel SalesOrder
      DELETE
    • Get Shipments for a Sales Order
      GET
    • Get B2B Customers For Business Unit
      GET
  • Ship Confirmation
    • Sales Order Ship Confirmation
      POST
  • Business Units
    • Get Buildings associated to a Business Unit
      GET
    • Remove associated Building from a Business Unit
      DELETE
    • Associate a Building to a Business Unit
      PUT
    • Get Business Unit Detail
      GET
    • Update Business Unit
      PUT
    • List Business Units
      GET
    • Create Business Unit
      POST
    • Get Business Unit General Settings
      GET
    • Update Business Unit General Settings
      PUT
    • Update Business Unit Amazon SFP Keys
      PUT
    • Remove Business Unit Amazon SFP Keys
      DELETE
    • Get Business Unit Amazon SFP Keys
      GET
    • List Broker Accounts
      GET
    • Create Broker Account
      POST
    • Delete Broker Account
      DELETE
  • Product
    • Batch Upload SKUs
    • Get Product Information
    • List SKUs
    • Create SKU
    • Get SKU Details
    • Update SKU Details
    • Update SKU Details
  • Inbound
    • List Inbound ASNs
    • Create Inbound ASN
    • Get single Inbound ASN
    • Update single Inbound ASN
    • Cancel single Inbound ASN
    • Get receipt lines for single Inbound ASN
    • Get receipt lines for single Inbound RMA
    • Get single Inbound RMA
    • Update single Inbound RMA
    • Cancel single Inbound RMA
    • List Inbound RMAs
    • Create Inbound RMA
    • Get receipt lines for single Inbound PO
    • Get single Inbound PO
    • Update single Inbound PO
    • Cancel single Inbound PO
    • List Inbound POs
    • Create Inbound PO
  • Inventory
    • List Inventory Transactions
    • List Inventory stats grouped by SKU
    • List Inventory stats grouped by Lot
    • List Inventory stats grouped by SKU and Building
    • List Inventory stats grouped by Lot and Building
    • List Inventory Serial Numbers
  • Inventory Movement
    • Inventory Movement
  • TMS Endpoints
    • Generate TMS Quotes for Sales Order
      POST
    • Book TMS Shipment for Sales Order
      POST
    • Delete Booked TMS Shipment For Sales Order
      DELETE
    • Update BOL for Order
      PUT
    • Approve Quote for Order & Drop to WMS
      PUT
    • Get ERP Token
      POST
  1. TMS Endpoints

Generate TMS Quotes for Sales Order

POST
/organizations/{orgId}/sales_orders/{salesOrderNumber}/tms_quote
TMS Endpoints

Request

Path Params
orgId
string 
required
salesOrderNumber
string 
required
Body Params application/json
data
object (TmsShipmentQuoteRequest) 
optional
origin
object 
required
destination
object 
required
billTo
object 
optional
If not provided, will populate when submitting request to TMS
containers
array [object {8}] 
required
Handling unit data type, required for LTL, not required for Parcel
accesorials
array [object {3}] 
optional
shipmentType
enum<string> 
required
Allowed values:
LTLTLTL MultistopTL Multistop DeliveryTL Multistop PickupTL Multistop Pickup & Delivery
shipmentMode
enum<string> 
required
Carrier type
Allowed values:
AirBulkDry VanFlat BedIntermodalOceanOTRTemp Controlled
weightUom
enum<string> 
required
Allowed values:
LBKG
lengthUom
enum<string> 
optional
Allowed values:
INCMFTM
deliveryInstructions1
string 
optional
Special instructions will get printed on the BOL and have a 255 character limit.
<= 255 characters
deliveryInstructions2
string 
optional
Special instructions will get printed on the BOL and have a 255 character limit.
<= 255 characters
carrierCodes
array[string]
optional
Restrict rate quotes to only these carriers. An empty array will retrieve rates from any carrier. e.g. UPGF.
serviceLevel
string 
optional
Requested service level. standard
requestedShipDate
string <date-time>
optional
The latest date-time the order should ship by
deliveryStartDate
string <date-time>
optional
Beginning of date-time window in which delivery arrives at destination
deliveryEndDate
string <date-time>
optional
End of date-time window in which delivery arrives at destination
Example
{
    "data": {
        "origin": {
            "facilityId": "string",
            "shortName": "string",
            "name": "string",
            "countryCode": "string",
            "region": "string",
            "locality": "string",
            "postalCode": "string",
            "address1": "string",
            "address2": "string",
            "address3": "string",
            "contact": {
                "name": "string",
                "phone": "string",
                "email": "string"
            }
        },
        "destination": {
            "name": "string",
            "countryCode": "string",
            "region": "string",
            "locality": "string",
            "postalCode": "string",
            "address1": "string",
            "address2": "string",
            "address3": "string",
            "contact": {
                "name": "string",
                "phone": "string",
                "email": "string"
            }
        },
        "billTo": {
            "name": "string",
            "countryCode": "string",
            "region": "string",
            "locality": "string",
            "postalCode": "string",
            "address1": "string",
            "address2": "string",
            "address3": "string",
            "contact": {
                "name": "string",
                "phone": "string",
                "email": "string"
            },
            "carrierCode": "string",
            "accountNumber": "string"
        },
        "containers": [
            {
                "height": 0,
                "width": 0,
                "length": 0,
                "weight": 0,
                "stackable": true,
                "quantity": "string",
                "type": "Pallet",
                "lines": [
                    {
                        "skuId": "string",
                        "description": "string",
                        "quantity": 0,
                        "purchaseOrderNumber": "string",
                        "packageType": "Bag(s)",
                        "perishable": true,
                        "dimensions": {
                            "height": 0,
                            "width": 0,
                            "length": 0,
                            "weight": 0
                        },
                        "hazmat": [
                            {
                                "unNumber": "string",
                                "groundClass": "string",
                                "oceanClass": "string",
                                "airClass": "string",
                                "railClass": "string",
                                "packingGroup": "I",
                                "labelCode": "string"
                            }
                        ]
                    }
                ]
            }
        ],
        "accesorials": [
            {
                "code": "CODAMT_LTL",
                "accessorialType": "Pickup",
                "parameters": [
                    {
                        "name": "string",
                        "value": "string"
                    }
                ]
            }
        ],
        "shipmentType": "LTL",
        "shipmentMode": "Air",
        "weightUom": "LB",
        "lengthUom": "IN",
        "deliveryInstructions1": "string",
        "deliveryInstructions2": "string",
        "carrierCodes": [
            "string"
        ],
        "serviceLevel": "string",
        "requestedShipDate": "2019-08-24T14:15:22Z",
        "deliveryStartDate": "2019-08-24T14:15:22Z",
        "deliveryEndDate": "2019-08-24T14:15:22Z"
    }
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST '/organizations//sales_orders//tms_quote' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": {
        "origin": {
            "facilityId": "string",
            "shortName": "string",
            "name": "string",
            "countryCode": "string",
            "region": "string",
            "locality": "string",
            "postalCode": "string",
            "address1": "string",
            "address2": "string",
            "address3": "string",
            "contact": {
                "name": "string",
                "phone": "string",
                "email": "string"
            }
        },
        "destination": {
            "name": "string",
            "countryCode": "string",
            "region": "string",
            "locality": "string",
            "postalCode": "string",
            "address1": "string",
            "address2": "string",
            "address3": "string",
            "contact": {
                "name": "string",
                "phone": "string",
                "email": "string"
            }
        },
        "billTo": {
            "name": "string",
            "countryCode": "string",
            "region": "string",
            "locality": "string",
            "postalCode": "string",
            "address1": "string",
            "address2": "string",
            "address3": "string",
            "contact": {
                "name": "string",
                "phone": "string",
                "email": "string"
            },
            "carrierCode": "string",
            "accountNumber": "string"
        },
        "containers": [
            {
                "height": 0,
                "width": 0,
                "length": 0,
                "weight": 0,
                "stackable": true,
                "quantity": "string",
                "type": "Pallet",
                "lines": [
                    {
                        "skuId": "string",
                        "description": "string",
                        "quantity": 0,
                        "purchaseOrderNumber": "string",
                        "packageType": "Bag(s)",
                        "perishable": true,
                        "dimensions": {
                            "height": 0,
                            "width": 0,
                            "length": 0,
                            "weight": 0
                        },
                        "hazmat": [
                            {
                                "unNumber": "string",
                                "groundClass": "string",
                                "oceanClass": "string",
                                "airClass": "string",
                                "railClass": "string",
                                "packingGroup": "I",
                                "labelCode": "string"
                            }
                        ]
                    }
                ]
            }
        ],
        "accesorials": [
            {
                "code": "CODAMT_LTL",
                "accessorialType": "Pickup",
                "parameters": [
                    {
                        "name": "string",
                        "value": "string"
                    }
                ]
            }
        ],
        "shipmentType": "LTL",
        "shipmentMode": "Air",
        "weightUom": "LB",
        "lengthUom": "IN",
        "deliveryInstructions1": "string",
        "deliveryInstructions2": "string",
        "carrierCodes": [
            "string"
        ],
        "serviceLevel": "string",
        "requestedShipDate": "2019-08-24T14:15:22Z",
        "deliveryStartDate": "2019-08-24T14:15:22Z",
        "deliveryEndDate": "2019-08-24T14:15:22Z"
    }
}'

Responses

🟢201Created
application/json
Body
object {0}
Example
{}
🟠400Bad Request
🟠403Forbidden
🔴500Internal Server Error
Modified at 2024-07-02 10:16:06
Previous
Inventory Movement
Next
Book TMS Shipment for Sales Order
Built with