Banyan Technology LIVE Connect™
  1. v3
Banyan Technology LIVE Connect™
  • Version 3
    • Authentication
      • Retrieve a token
    • Shipments
      • Creating
        • Create a Full Shipment
        • Create an EZ Rate Shipment
      • Updating
        • Add Document(s) to a Shipment
        • Update a Shipment
        • Adds one or more Reference Numbers to a Shipment
        • Mark as Exported
      • Retrieving
        • Get a Shipment
        • Get multiple Shipments
        • Get Quotes
        • Get Reference Numbers for a Shipment
        • Get documents for the specified shipment.
      • Booking
        • Book a Shipment
        • Unbooks the awarded quote on the specified load.
      • Canceling
        • Cancels a shipment.
    • Invoice
      • Get multiple invoices
      • Mark as Exported
    • Tracking
      • Get tracking statuses
      • Mark as exported.
    • StaticData
      • Accessorials
      • Document Types
      • Equipment Types
      • Package Types
      • Limited Access Types
      • Size UOMs
      • Weight UOMs
      • Pay Types
      • Ship Types
      • Countries
      • Statuses
      • Service Modes
    • Insurance
      • Get Vendors
  • Version 2
    • Recommended Workflow
      • Rating
        • ImportForQuote
        • ImportForQuote_Sync
        • GetQuotes
      • Booking/Dispatching
        • BookLoad
      • Tracking
        • GetTrackingStatuses
      • Documents
        • GetDocuments
      • Invoices
        • GetInvoices
        • GetInvoicesWithLoadDetails
    • Additional Offerings
      • Cancelling
        • Cancel a Load
      • Updating
        • UpdateLoad
        • UpdateLoadStatus
        • UpdateShipmentsExport
      • Importing
        • PendingImport
        • ImportForBook
      • Manual Quotes
        • AddManualQuote
      • EZ Rates
        • EzRate
        • EzRate_Sync
      • Waterfall Tendering
        • StartWaterfallTendering
        • CancelWaterfallTendering
      • Unbooking
        • UnBookLoad
      • Additional Dispatching
        • DispatchLoad
      • Load Details
        • GetLoadDetails
        • GetNotes
      • Additional Tracking
        • GetTrackingByLoad
      • Other
        • Normalized Charge Codes
      • SOAP
    • Changelog
  • Exports and Webhooks
    • Standard Load Export - v1
    • Standard Load Export - v2
    • Standard Load Export - v3
    • Push Tracking
  • Schemas
    • Schemas
      • v2
        • Enums
          • Package Type Enum
          • Freight Class Enum
          • Document Types Enum
          • Limited Access Types Enum
          • Equipment Type Enum
          • Service Code Enum
          • Size UOM Enum
          • Weight UOM Enum
          • Inco Terms Enum
          • Ship Type Enum
          • Pay Type Enum
          • Note Type Enum
          • Failure Reason Codes Enum
          • Currency Types Enum
          • Image Format Enum
          • Date Filter Types Enum
          • Invoice Status Enum
          • Load Status Enum
        • common
          • Authentication Data
          • ErrorObject
        • Invoices
          • objects
            • InvoiceBatchDetails
            • InvoiceLoadDetails
            • InvoiceQuoteDetails
            • InvoiceLineDetails
            • InvoicePaymentDetails
            • InvoiceAddressDetails
            • InvoiceDetails
          • GetInvoicesResponse
          • GetInvoicesRequest
        • Import
          • ImportAsBookedRequest
          • ImportForRatingAndPendingRequest
          • ImportAsBookedResponse
          • ImportForRatingAndPendingResponse
        • tracking
          • GetTrackingStatusesResponse
          • GetTrackingStatusesRequest
          • GetTrackingByLoadRequest
          • GetTrackingByLoadResponse
        • documents
          • objects
            • Document
          • GetDocumentsRequest
          • GetDocumentResponse
        • booking/dispatching
          • DispatchRequest
          • BookLoadRequest
          • DispatchResponse
          • BookLoadResponse
          • DispatchLoadRequest
          • DispatchLoadResponse
        • updates
          • UpdateLoadRequest
          • UpdateLoadResponse
          • UpdateLoadStatusRequest
          • UpdateLoadStatusResponse
          • UpdateShipmentExportRequest
          • UpdateShipmentExportResponse
        • quotes
          • objects
            • FailedQuote
            • PendingQuote
            • QuoteCharge
            • PriceBreakout
            • Quote
            • ManualQuote
          • AddManualQuoteRequest
          • AddManualQuoteResponse
          • GetQuotesResponse
          • GetQuotesRequest
        • ezrates
          • EZRateRequest
          • EZRateResponse
        • accessorials
          • ShipperAccessorials
          • ConsigneeAccessorials
          • LoadAccessorials
        • notes
          • GetNotesRequest
          • GetNotesResponse
        • load details
          • GetLoadDetailsRequest
          • GetLoadDetailsResponse
        • AddressInfo
        • ContactInfo
        • Dock
        • PackageInfo
        • Product
        • ParcelOptions
        • InternationalOptions
        • Shipper
        • Consignee
        • BillTo
        • Loadinfo
        • RateServices
        • ReturnLocation
        • InsuranceInfo
        • ReferenceField
        • UserDefined
        • Note
        • InsuranceDetails
        • FullLoadDetails
      • Webhooks
        • Tracking Event
      • v3
        • Enums
          • ClientDocumentTypesEnum
          • ImportStatusEnum
          • LimitedAccessEnum
          • DocumentTypesEnum
          • CurrencyEnum
          • PackageTypesEnum
          • FreightClassEnum
          • Weight UOM Enum
          • ShipTypeEnum
          • PayTypeEnum
          • ServiceModeEnum
          • EquipmentTypeEnum
          • LoadStatusEnum
          • ExportReasonsEnum
          • InternationalTermsEnum
          • ShipmentAccessorialsAbbrevEnum
          • ShipmentAccessorialsDescEnum
          • ShipperAccessorialsDescEnum
          • ShipperAccessorialsAbbrevEnum
          • ConsigneeAccessorialsAbbrevEnum
          • ConsigneeAccessorialsDescEnum
          • Size UOM Enum
          • Web Tracking codes
          • EDI Tracking Codes
        • DocumentPostDto
        • BrokerDto
        • ClientDto
        • ManualQuoteDto
        • BanyanWebServices.Domain.Dtos.CreateShipment.ShipmentDataDto
        • BanyanWebServices.Domain.Dtos.DocumentDto
        • BanyanWebServices.Domain.Dtos.GetShipment.ShipmentDto
        • BanyanWebServices.Domain.Dtos.ErrorWrapperDto
        • BanyanWebServices.Domain.Dtos.GetQuotesDto
        • AwardedQuotePricingDto
        • ContactPersonDto
        • InsuranceDetailsDto
        • QuoteChargeDto
        • QuoteDto
        • QuotePriceDto
        • BanyanWebServices.Domain.Dtos.GetShipment.UpdateShipmentResponseDto
        • BanyanWebServices.Domain.Dtos.Invoices.BatchDetailsDto
        • BanyanWebServices.Domain.Dtos.Invoices.InvoiceAddressDto
        • BanyanWebServices.Domain.Dtos.Invoices.InvoiceDto
        • BanyanWebServices.Domain.Dtos.Invoices.InvoiceLineItemDto
        • BanyanWebServices.Domain.Dtos.Invoices.PaymentDto
        • BanyanWebServices.Domain.Dtos.Invoices.QuoteDetailsDto
        • BanyanWebServices.Domain.Dtos.Invoices.ShipmentDetailsDto
        • NoteDto
        • BanyanWebServices.Domain.Dtos.Quotes.FailedQuoteDto
        • BanyanWebServices.Domain.Dtos.Quotes.PendingQuoteDto
        • ShipmentAccessorialDto
        • ShipperAccessorialDto
        • ConsigneeAccessorialDto
        • AddressDto
        • BillToDto
        • BanyanWebServices.Domain.Dtos.Shipment.CarbonQuoteDto
        • ContactMethodsDto
        • DimensionsDto
        • BanyanWebServices.Domain.Dtos.Shipment.DispatchResponseDto
        • DockDetailsDto
        • HandlingUnitDto
        • HazmatDetailsDto
        • BanyanWebServices.Domain.Dtos.Shipment.InsuranceDto
        • InternationalDetailDto
        • LocationDto
        • BanyanWebServices.Domain.Dtos.Shipment.MarketRateDto
        • PackageInfoDto
        • ProductDto
        • ReferenceFieldDto
        • ShipmentServiceDto
        • StaticData.AccessorialsDto
        • TimeZoneDto
        • TrackingDto
        • TrackingStatusDto
        • BanyanWebServices.Domain.Enums.LoadStatus
        • BanyanWebServices.Domain.Enums.NoteFilter
        • BanyanWebServices.Domain.Enums.QuoteFilter
        • BanyanWebServices.Domain.Requests.BookQuoteRequest
        • BanyanWebServices.Domain.Requests.Common.IdListRequest
        • BanyanWebServices.Domain.Requests.Common.IdRequest
        • BanyanWebServices.Domain.Requests.CreateReferenceNumberRequest
        • BanyanWebServices.Domain.Requests.MarkTrackingExportedRequest
        • CreateShipmentRequest
        • GetDocumentsRequest
        • BanyanWebServices.Domain.Requests.Version3.GetInvoicesRequest
        • BanyanWebServices.Domain.Requests.Version3.GetShipmentsRequest
        • BanyanWebServices.Domain.Requests.Version3.GetTrackingByLoadRequest
        • BanyanWebServices.Domain.Requests.Version3.UpdateShipmentRequest
        • ErrorResponse
  1. v3

BanyanWebServices.Domain.Dtos.CreateShipment.ShipmentDataDto

The ShipmentData data transfer object. This will contain all relevant information about a shipment.

{
    "manifestId": "string",
    "bolNumber": "string",
    "customerPo": "string",
    "invoiceId": "string",
    "billingId": "string",
    "shipperConfirmationNumber": "string",
    "consigneeConfirmationNumber": "string",
    "estimatedPickup": "2019-08-24T14:15:22Z",
    "actualPickup": "2019-08-24T14:15:22Z",
    "estimatedDelivery": "2019-08-24T14:15:22Z",
    "actualDelivery": "2019-08-24T14:15:22Z",
    "shipType": "Shipper",
    "payType": "Collect",
    "exportReason": "Temporary",
    "internationalTerm": "Cost and Freight",
    "usBrokerSameAsShipper": false,
    "usBrokerSameAsConsignee": false,
    "internationalBrokerSameAsShipper": false,
    "internationalBrokerSameAsConsignee": false,
    "useDefaultUSBroker": false,
    "useDefaultInternationalBroker": false,
    "usBroker": {
        "LocationName": "string",
        "ContactFirstName": "string",
        "ContactLastName": "string",
        "ContactMethods": {
            "phoneNumber": "string",
            "extension": "string",
            "faxNumber": "string",
            "email": "string"
        },
        "Address": {
            "lineOne": "string",
            "lineTwo": "string",
            "city": "string",
            "stateOrProvince": "string",
            "zipCode": "string",
            "country": "string"
        }
    },
    "internationalBroker": {
        "LocationName": "string",
        "ContactFirstName": "string",
        "ContactLastName": "string",
        "ContactMethods": {
            "phoneNumber": "string",
            "extension": "string",
            "faxNumber": "string",
            "email": "string"
        },
        "Address": {
            "lineOne": "string",
            "lineTwo": "string",
            "city": "string",
            "stateOrProvince": "string",
            "zipCode": "string",
            "country": "string"
        }
    },
    "shipperLocation": {
        "companyName": "string",
        "locationName": "string",
        "einNumber": "string",
        "note": "string",
        "contactMethods": {
            "phoneNumber": "string",
            "extension": "string",
            "faxNumber": "string",
            "email": "string"
        },
        "contactPerson": {
            "firstName": "string",
            "lastName": "string"
        },
        "address": {
            "lineOne": "string",
            "lineTwo": "string",
            "city": "string",
            "stateOrProvince": "string",
            "zipCode": "string",
            "country": "string"
        },
        "vendorId": "string",
        "distributionCenterReferenceNumber": "string",
        "dock": {
            "name": "string",
            "note": "string",
            "confirmationNumber": "string",
            "openTime": "2019-08-24T14:15:22Z",
            "accessTime": "2019-08-24T14:15:22Z",
            "closeTime": "2019-08-24T14:15:22Z",
            "isFirstComeFirstServe": true,
            "limitedAccessType": "Airport"
        }
    },
    "consigneeLocation": {
        "companyName": "string",
        "locationName": "string",
        "einNumber": "string",
        "note": "string",
        "contactMethods": {
            "phoneNumber": "string",
            "extension": "string",
            "faxNumber": "string",
            "email": "string"
        },
        "contactPerson": {
            "firstName": "string",
            "lastName": "string"
        },
        "address": {
            "lineOne": "string",
            "lineTwo": "string",
            "city": "string",
            "stateOrProvince": "string",
            "zipCode": "string",
            "country": "string"
        },
        "vendorId": "string",
        "distributionCenterReferenceNumber": "string",
        "dock": {
            "name": "string",
            "note": "string",
            "confirmationNumber": "string",
            "openTime": "2019-08-24T14:15:22Z",
            "accessTime": "2019-08-24T14:15:22Z",
            "closeTime": "2019-08-24T14:15:22Z",
            "isFirstComeFirstServe": true,
            "limitedAccessType": "Airport"
        }
    },
    "useDefaultBillTo": false,
    "billTo": {
        "name": "string",
        "contactMethods": {
            "phoneNumber": "string",
            "extension": "string",
            "faxNumber": "string",
            "email": "string"
        },
        "note": "string",
        "address": {
            "lineOne": "string",
            "lineTwo": "string",
            "city": "string",
            "stateOrProvince": "string",
            "zipCode": "string",
            "country": "string"
        }
    },
    "shipmentServices": [
        {
            "serviceMode": "Standard Parcel Service",
            "quantity": 1,
            "packageType": "ACC",
            "equipmentType": "16ft Straight Truck",
            "additionalWeight": 0,
            "weightUnitOfMeasurement": "LBS",
            "specialInstructions": "string",
            "dimensions": {
                "unitOfMeasurement": "CM",
                "length": 0,
                "width": 0,
                "height": 0
            }
        }
    ],
    "packageInfo": {
        "routeNumber": "string",
        "cod": 0,
        "declaredLiability": 0
    },
    "insuranceInfo": {
        "vendor": "string",
        "commodityType": "string",
        "commodityCondition": "string",
        "commodityCoverageType": "string",
        "commodityPackagingCateogry": "string",
        "insuredValue": 0
    },
    "handlingUnits": [
        {
            "packageType": "ACC",
            "quantity": 0,
            "length": 0,
            "width": 0,
            "height": 0,
            "additionalWeight": 0,
            "unitOfMeasurement": "CM",
            "weightUnitOfMeasurement": "LBS",
            "products": [
                {
                    "packageType": "ACC",
                    "quantity": 1,
                    "class": 0,
                    "weight": 1,
                    "weightUnitOfMeasurement": "LBS",
                    "dimensions": {
                        "unitOfMeasurement": "CM",
                        "length": 0,
                        "width": 0,
                        "height": 0
                    },
                    "nmfc": "string",
                    "description": "string",
                    "sku": "string",
                    "referenceNumber": "string",
                    "hazmatDetails": {
                        "name": "string",
                        "contactMethods": {
                            "phoneNumber": "string",
                            "extension": "string",
                            "faxNumber": "string",
                            "email": "string"
                        },
                        "isPoison": true,
                        "unNumber": "string",
                        "shippingName": "string",
                        "class": "string",
                        "packageGroup": "string"
                    },
                    "isHazmat": true,
                    "internationalDetails": {
                        "harmonizedSystemCode": "string",
                        "systemBCode": "string",
                        "eccn": "strin"
                    }
                }
            ]
        }
    ],
    "documents": [
        {
            "filename": "string",
            "extension": "  bmp",
            "base64Document": "string",
            "documentType": "BOL"
        }
    ],
    "referenceFields": [
        {
            "type": "string",
            "value": "string",
            "printOnBol": true,
            "printOnShippingLabel": true
        }
    ],
    "shipperAccessorials": [
        {
            "description": "Trade Show Pickup",
            "abbreviation": "LTPCK",
            "value": "string"
        }
    ],
    "consigneeAccessorials": [
        {
            "description": "Appointment Required",
            "abbreviation": "CAPPT",
            "value": "string"
        }
    ],
    "loadAccessorials": [
        {
            "description": "Age Restricted",
            "abbreviation": "AGE  ",
            "value": "string"
        }
    ]
}
Built with