UMG-UK
  1. Outbound Orders
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
    • Book TMS Shipment for Sales Order
    • Delete Booked TMS Shipment For Sales Order
    • Update BOL for Order
    • Approve Quote for Order & Drop to WMS
    • Get ERP Token
  1. Outbound Orders

Bulk Upload SalesOrders

POST
/business_units/{businessUnitId}/sales_orders/bulk

Request

Path Params

Body Params application/json

Example
{
    "data": [
        {
            "orderLines": [
                {
                    "skuId": "string",
                    "quantity": 0,
                    "quantityMeasure": "EA",
                    "customerLineNumber": "string",
                    "customerSku": "string",
                    "giftMessage": "string",
                    "notes": "string",
                    "lineType": "S",
                    "amount": 0,
                    "giftCardInfo": {
                        "amount": 0,
                        "code": "string",
                        "detail": "string",
                        "type": "string"
                    }
                }
            ],
            "customerOrderNumber": "string",
            "jobId": "string",
            "orderCreatedDate": "2019-08-24T14:15:22Z",
            "requestedBuildingId": "strin",
            "shipTo": {
                "name": "string",
                "address1": "string",
                "address2": "string",
                "address3": "string",
                "city": "string",
                "state": "strin",
                "country": "strin",
                "postalCode": "string",
                "email": "foo@bar.com,fish@sea.net",
                "phoneNumber": "string",
                "faxNumber": "string",
                "attentionTo": "string"
            },
            "notes": "string",
            "carrierId": "UPS",
            "shippingSpeed": "1D",
            "deliveryInstructions1": "string",
            "deliveryInstructions2": "string",
            "buyerOrderNumber": "string",
            "fulfillFlag": true,
            "fillKillIndicator": "1",
            "customerOrderType": "HL",
            "billTo": {
                "name": "string",
                "address1": "string",
                "address2": "string",
                "address3": "string",
                "city": "string",
                "state": "strin",
                "country": "strin",
                "postalCode": "string",
                "email": "foo@bar.com,fish@sea.net",
                "phoneNumber": "string",
                "faxNumber": "string",
                "attentionTo": "string"
            },
            "giftMessage": "string",
            "orderAmount": 0,
            "isSignatureRequired": true,
            "isInsuranceRequired": true,
            "orderDropDate": "2019-08-24",
            "customerDates": {
                "requestedDeliveryDate": "2019-08-24",
                "requestedShipDate": "2019-08-24",
                "deliveryStartDate": "2019-08-24",
                "deliveryEndDate": "2019-08-24",
                "doNotShipBefore": "2019-08-24",
                "doNotShipAfter": "2019-08-24",
                "cancelAfter": "2019-08-24",
                "cancelIfNotDeliveredBy": "2019-08-24"
            },
            "salesChannelOrderInfo": {
                "salesChannelName": "string",
                "orderNumber": "string",
                "purchaseDate": "2019-08-24",
                "lastUpdateDate": "2019-08-24",
                "shipServiceLevel": "G",
                "earliestShipDate": "2019-08-24",
                "latestShipDate": "2019-08-24",
                "earliestDeliveryDate": "2019-08-24",
                "latestDeliveryDate": "2019-08-24"
            },
            "customerId": "string",
            "priority": "1",
            "shipServiceLevel": "G",
            "purchaseOrderNumber": "string",
            "accessorials": [
                {
                    "code": "Residential/RESIDNTL",
                    "accessorialType": "Pickup",
                    "parameters": [
                        {
                            "name": "accessType",
                            "value": "string"
                        }
                    ]
                }
            ],
            "thirdPartyAccountNumber": "string",
            "useAccountFrom": "C",
            "mondialRelayId": "string",
            "shippingCost": 0,
            "bundleFlag": "s",
            "currencyCd": "string",
            "storeid": "string",
            "taxAmt": 0,
            "orderLines \\ lineTaxAmt": 0,
            "cartonCode": "string"
        }
    ]
}

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 '/business_units//sales_orders/bulk' \
--header 'Content-Type: application/json' \
--data-raw '{
    "data": [
        {
            "orderLines": [
                {
                    "skuId": "string",
                    "quantity": 0,
                    "quantityMeasure": "EA",
                    "customerLineNumber": "string",
                    "customerSku": "string",
                    "giftMessage": "string",
                    "notes": "string",
                    "lineType": "S",
                    "amount": 0,
                    "giftCardInfo": {
                        "amount": 0,
                        "code": "string",
                        "detail": "string",
                        "type": "string"
                    }
                }
            ],
            "customerOrderNumber": "string",
            "jobId": "string",
            "orderCreatedDate": "2019-08-24T14:15:22Z",
            "requestedBuildingId": "strin",
            "shipTo": {
                "name": "string",
                "address1": "string",
                "address2": "string",
                "address3": "string",
                "city": "string",
                "state": "strin",
                "country": "strin",
                "postalCode": "string",
                "email": "foo@bar.com,fish@sea.net",
                "phoneNumber": "string",
                "faxNumber": "string",
                "attentionTo": "string"
            },
            "notes": "string",
            "carrierId": "UPS",
            "shippingSpeed": "1D",
            "deliveryInstructions1": "string",
            "deliveryInstructions2": "string",
            "buyerOrderNumber": "string",
            "fulfillFlag": true,
            "fillKillIndicator": "1",
            "customerOrderType": "HL",
            "billTo": {
                "name": "string",
                "address1": "string",
                "address2": "string",
                "address3": "string",
                "city": "string",
                "state": "strin",
                "country": "strin",
                "postalCode": "string",
                "email": "foo@bar.com,fish@sea.net",
                "phoneNumber": "string",
                "faxNumber": "string",
                "attentionTo": "string"
            },
            "giftMessage": "string",
            "orderAmount": 0,
            "isSignatureRequired": true,
            "isInsuranceRequired": true,
            "orderDropDate": "2019-08-24",
            "customerDates": {
                "requestedDeliveryDate": "2019-08-24",
                "requestedShipDate": "2019-08-24",
                "deliveryStartDate": "2019-08-24",
                "deliveryEndDate": "2019-08-24",
                "doNotShipBefore": "2019-08-24",
                "doNotShipAfter": "2019-08-24",
                "cancelAfter": "2019-08-24",
                "cancelIfNotDeliveredBy": "2019-08-24"
            },
            "salesChannelOrderInfo": {
                "salesChannelName": "string",
                "orderNumber": "string",
                "purchaseDate": "2019-08-24",
                "lastUpdateDate": "2019-08-24",
                "shipServiceLevel": "G",
                "earliestShipDate": "2019-08-24",
                "latestShipDate": "2019-08-24",
                "earliestDeliveryDate": "2019-08-24",
                "latestDeliveryDate": "2019-08-24"
            },
            "customerId": "string",
            "priority": "1",
            "shipServiceLevel": "G",
            "purchaseOrderNumber": "string",
            "accessorials": [
                {
                    "code": "Residential/RESIDNTL",
                    "accessorialType": "Pickup",
                    "parameters": [
                        {
                            "name": "accessType",
                            "value": "string"
                        }
                    ]
                }
            ],
            "thirdPartyAccountNumber": "string",
            "useAccountFrom": "C",
            "mondialRelayId": "string",
            "shippingCost": 0,
            "bundleFlag": "s",
            "currencyCd": "string",
            "storeid": "string",
            "taxAmt": 0,
            "orderLines \\ lineTaxAmt": 0,
            "cartonCode": "string"
        }
    ]
}'

Responses

🟢200Returns the initial async job state so that it can be polled for status
application/json
Body

Example
{
    "data": {
        "jobId": "string",
        "status": "CREATED",
        "failedOrders": [
            {
                "customerOrderNumber": "string",
                "message": "string",
                "lines": [
                    {
                        "customerLineNumber": "string",
                        "message": "string"
                    }
                ]
            }
        ],
        "progress": {
            "processed": 0,
            "total": 0
        }
    }
}
🟠400Bad Request
🟠404Not Found
🔴500Internal Server Error
Modified at 2024-07-02 10:16:06
Previous
Sales Order Acknowledgement
Next
Get Job Status of an Async Bulk Sales Order Import
Built with