components: parameters: CpDropoffCity: in: query name: dropoff_city required: true schema: type: string CpDropoffLat: in: query name: dropoff_lat required: true schema: maximum: 90 minimum: -90 type: number CpDropoffLng: in: query name: dropoff_lng required: true schema: maximum: 180 minimum: -180 type: number CpDropoffState: description: Two letter abreviation of dropoff state in: query name: dropoff_state required: true schema: maxLength: 2 minLength: 2 type: string CpEquipmentType: in: query name: equipment_type required: true schema: enum: - dry_van - reefer - flatbed type: string CpPickupCity: in: query name: pickup_city required: true schema: type: string CpPickupLat: in: query name: pickup_lat required: true schema: maximum: 90 minimum: -90 type: number CpPickupLng: in: query name: pickup_lng required: true schema: maximum: 180 minimum: -180 type: number CpPickupState: description: Two letter abreviation of pickup state in: query name: pickup_state required: true schema: maxLength: 2 minLength: 2 type: string CpPickupTime: description: Pickup time in ISO-8601 (yyyy-mm-ddThh:mm:ss.sssss+tz.info) in: query name: pickup_time required: true schema: type: string CrRecommendationId: description: Id of the recommendation object. in: path name: CrRecommendationId required: true schema: format: uuid type: string CrRecommendationShipmentId: description: Id of the recommendation shipment object. in: path name: CrRecommendationShipmentId required: true schema: format: uuid type: string accessorialChargeTableId: description: The id of an accessorial charge table in: path name: accessorialChargeTableId required: true schema: type: string accountNumber: description: Fedex account number in: query name: account_number schema: type: string accountRepsContains: description: Return RateShareConfigs where once of the account reps names contains this string in: query name: accounts_reps__contains required: false schema: type: string accountRepsIds: description: Return RateShareConfigs where these user IDs are listed as account reps explode: true in: query name: account_reps_ids required: false schema: items: type: string type: array activeVendorAssignment: description: Include or exclude shipments with active CarrierAssignments in: query name: active_vendor_assignment required: false schema: type: boolean addressBookEntry: description: Include pickups with this address book entry id in: query name: address_book_entry required: false schema: type: string addressBookId: description: The id of a company address book entry in: path name: addressBookId required: true schema: format: uuid type: string alert_configuration_id: description: Return shipments that match this alert configuration definition in: query name: alert_configuration_id required: false schema: format: uuid type: string alert_shipments: description: Return shipments that match active alert configurations in: query name: alert_shipments required: false schema: type: boolean alerts: description: Filter on whether or not a Shipment has alert messages in: query name: alerts required: false schema: type: boolean alertsDashboardConfigurationId: description: The id of the alerts dashboard configuration in: path name: alertsDashboardConfigurationId required: true schema: format: uuid type: string apiKeyExpiresAtLte: description: Include api keys where expires_at is less than or equal to this value in: query name: expires_at__lte required: false schema: format: date-time type: string archived: description: Filter on whether or not a shipment is archived in: query name: archived required: false schema: type: boolean automationEventId: description: The id of the shipment automation event in: path name: automationEventId required: true schema: format: uuid type: string beginDatetime: description: For requesting data starting at a given date in: query name: beginDatetime required: false schema: format: date-time type: string billId: description: The id of the bill within Shipwell in: path name: billId required: true schema: format: uuid type: string bolNumber: description: Include shipments with these BOL Numbers explode: true in: query name: bol_number required: false schema: items: type: string type: array bolNumberContains: description: Return shipments where the BOL number contains this value in: query name: bol_number__contains required: false schema: type: string bolNumberExclude: description: Exclude shipments with these BOL Numbers explode: true in: query name: bol_number__exclude required: false schema: items: type: string type: array brokerageId: description: The id of the brokerage in: path name: brokerageId required: true schema: format: uuid type: string buyItNowAmountGte: description: Return shipments with a buy-it-now amount greater than or equal to this value in: query name: buy_it_now_amount__gte required: false schema: format: float type: number buyItNowAmountLte: description: Return shipments with a buy-it-now amount less than or equal to this value in: query name: buy_it_now_amount__lte required: false schema: format: float type: number callLogShipmentId: description: Id of the shipment object. in: path name: ShipmentId required: true schema: format: uuid type: string cancelled: description: Return pickups based on if they are cancelled in: query name: cancelled required: false schema: type: boolean carrierAssignmentId: description: The id of a CarrierAssignment in: path name: carrierAssignmentId required: true schema: format: uuid type: string carrierBidId: description: The id of the carrier bid in: path name: carrierBidId required: true schema: format: uuid type: string carrierBidShipmentId: description: Filter objects down to bids matching the provided shipment ID in: query name: shipment_id required: false schema: format: uuid type: string carrierId: description: The id of the carrier in: path name: carrierId required: true schema: format: uuid type: string carrierIdQuery: description: The id of the carrier in: query name: carrierId required: false schema: format: uuid type: string carrierNameContains: description: Name of the carrier in: query name: carrier_name__contains schema: type: string carrierOwnerEmail: description: Return vendor relationships where carrier_owner email address contains the value provided in: query name: carrier_owner_email__contains schema: type: string carrierOwnerId: description: Return vendor relationships where carrier_owner has this User ID in: query name: carrier_owner_id schema: format: uuid type: string carrierOwnerName: description: Return vendor relationships where carrier_owner name contains the value provided in: query name: carrier_owner_name__contains schema: type: string carrierRelationshipId: description: The id of the vendor relationship in: path name: carrierRelationshipId required: true schema: format: uuid type: string carrierRelationshipIdSearch: description: The id of the vendor relationship explode: true in: query name: carrier_relationship_id required: false schema: items: format: uuid type: string type: array carrierRelationshipPointOfContactId: description: The id of a vendor relationship point of contact in: path name: carrierRelationshipPointOfContactId required: true schema: format: uuid type: string carrierStatus: description: Return vendor relationships where carrier_status equals the value provided in: query name: carrier_status required: false schema: enum: - ACTIVE - INACTIVE - DO_NOT_USE type: string caseId: description: The id of the case in: path name: caseId required: true schema: format: uuid type: string caseNoteId: description: The id of the case note in: path name: caseNoteId required: true schema: format: uuid type: string chrobinsonAccountId: in: path name: chrobinsonAccountId required: true schema: format: uuid type: string companyBillingAddressContains: description: Return objects where the company billing address contains this string in: query name: billing_address__contains required: false schema: type: string companyContains: description: Return objects where the company name contains this string in: query name: company__contains required: false schema: type: string companyId: description: The id of the company in: path name: companyId required: true schema: format: uuid type: string companyImpersonation: description: allows request to retrieve information about the company given in the header instead of the company associated with the requesting user in: header name: X-Company-Id required: false schema: type: string companyMailingAddressContains: description: Return objects where the company mailing address contains this string in: query name: mailing_address__contains required: false schema: type: string companyPrimaryEmailContains: description: Return objects where the company primary email contains this string in: query name: primary_email__contains required: false schema: type: string companyPrimaryPhoneNumberContains: description: Return objects where the company primary phone number contains this string in: query name: primary_phone_number__contains required: false schema: type: string contractId: description: The id of a contract in: path name: contractId required: true schema: format: uuid type: string contractNameContains: description: Include Contracts where name contains this string in: query name: name__contains required: false schema: type: string contractStatus: description: Include Contracts where status is exactly this string in: query name: status required: false schema: type: string createDriver: description: Whether or not to create a driver if it does not exist in: query name: createDriver required: false schema: type: boolean createdAt: description: For requesting data created at a certain datetime in: query name: created_at required: false schema: format: date-time type: string createdBySource: description: Return shipments created by sources in the array. explode: true in: query name: created_by_source required: false schema: items: enum: - MAGENTO - SHIPWELL_WEB - SHOPIFY - IMPORT - TENDER - SHIPWELL_WEB_UNAUTH type: string type: array createdByUserContains: description: Return shipments where created_by_user object contains this string e.g first_name, last_name or email in: query name: created_by_user__contains required: false schema: type: string createdByUserId: description: Return shipments where created_by_user_id in the array. explode: true in: query name: created_by_user_id required: false schema: items: format: uuid type: string type: array createdByUserName: description: Return shipments where created_by_user_name is exactly this string in: query name: created_by_user_name required: false schema: type: string createdByUserNameContains: description: Return shipments where created_by_user_name contains this string in: query name: created_by_user_name__contains required: false schema: type: string customFieldId: description: The id of the custom field in: path name: customFieldId required: true schema: format: uuid type: string customFieldShipmentId: description: Include CustomFields where shipment_id is allowed to request user in: query name: shipment_id required: false schema: format: uuid type: string customer: description: Return shipments with this exact value as the customer company name in: query name: customer required: false schema: type: string customerContains: description: Return shipments where the customer company name contains this value in: query name: customer__contains required: false schema: type: string customerId: description: Return shipments with this exact id for the customer company in: query name: customer_id required: false schema: format: uuid type: string customerReferenceNumber: description: Include shipments with these Customer Reference Numbers explode: true in: query name: customer_reference_number required: false schema: items: type: string type: array customerReferenceNumberContains: description: Include shipments where the Customer Reference Numbers contains this value in: query name: customer_reference_number__contains required: false schema: type: string customerReferenceNumberExclude: description: Exclude shipments with these Customer Reference Numbers explode: true in: query name: customer_reference_number__exclude required: false schema: items: type: string type: array deliveryLat: description: Latitude of location to filter on for delivery stop in: query name: delivery_lat required: false schema: format: float type: number deliveryLon: description: Longitude of location to filter on for delivery stop in: query name: delivery_lon required: false schema: format: float type: number deliveryRadius: description: Radius from a delivery stop in: query name: delivery_radius required: false schema: type: integer deliveryStopsCompanyNameContains: description: Return shipments with this value in one of its delivery stops location company_name in: query name: delivery_stops_company_name__contains required: false schema: type: string deliveryStopsContains: description: Return shipments with this value in one of its dropoff stops in: query name: delivery_stops__contains required: false schema: type: string deliveryStopsStateProvince: description: Return shipments with this state province on its delivery stops in: query name: delivery_stops_state_province required: false schema: type: string destinationContains: description: Return shipments with this value in the destination in: query name: destination__contains required: false schema: type: string destinationLat: description: Latitude of location to filter on for destination stop in: query name: destination_lat required: false schema: format: float type: number destinationLon: description: Longitude of location to filter on for destination stop in: query name: destination_lon required: false schema: format: float type: number destinationRadius: description: Radius from the destination stop in: query name: destination_radius required: false schema: type: integer destinationStateProvince: description: Return shipments with this state province on its destination stop in: query name: destination_state_province required: false schema: type: string destinationsContains: description: Return shipments with this value in the destinations explode: true in: query name: destinations__contains required: false schema: items: type: string type: array destinationsStateProvince: description: Return shipments with this state province on its destinations in: query name: destinations_state_province required: false schema: items: type: string type: array deviceId: description: The id of the device in: path name: deviceId required: true schema: format: uuid type: string documentId: description: The id of the document in: path name: documentId required: true schema: format: uuid type: string drayageBookingNumber: description: Include shipments where the drayage booking number contains this value in: query name: drayage_booking_number__contains required: false schema: type: string drayageChassisNumber: description: Include shipments where the drayage chassis number contains this value in: query name: drayage_chassis_number__contains required: false schema: type: string drayageContainerNumber: description: Include shipments where the drayage container number contains this value in: query name: drayage_container_number__contains required: false schema: type: string drayageContainerReturnDateGte: description: Include shipments where the drayage container return date is greater than or equal to this value in: query name: drayage_container_return_date__gte required: false schema: type: string drayageContainerReturnDateLte: description: Include shipments where the drayage container return date is less than or equal to this value in: query name: drayage_container_return_date__lte required: false schema: type: string drayageEstimatedArrivalDateGte: description: Include shipments where the drayage estimated arrival date is greater than or equal to this value in: query name: drayage_estimated_arrival_date__gte required: false schema: type: string drayageEstimatedArrivalDateLte: description: Include shipments where the drayage estimated arrival date is less than or equal to this value in: query name: drayage_estimated_arrival_date__lte required: false schema: type: string drayageLastFreeDateGte: description: Include shipments where the drayage last free datetime is greater than or equal to this value in: query name: drayage_last_free_date__gte required: false schema: type: string drayageLastFreeDateLte: description: Include shipments where the drayage last free datetime is less than or equal to this value in: query name: drayage_last_free_date__lte required: false schema: type: string drayageReleaseDateGte: description: Include shipments where the drayage release datetime is greater than or equal to this value in: query name: drayage_release_date__gte required: false schema: type: string drayageReleaseDateLte: description: Include shipments where the drayage release datetime is less than or equal to this value in: query name: drayage_release_date__lte required: false schema: type: string drayageSealNumber: description: Include shipments where the drayage seal number contains this value in: query name: drayage_seal_number__contains required: false schema: type: string driverAssigned: description: Return shipments where the driver is assigned/unassigned in: query name: driver_assigned required: false schema: type: boolean driverId: description: The id of the driver in: path name: driverId required: true schema: format: uuid type: string dropoffGte: description: Return shipments with a dropoff stop with a planned date greater than or equal to this value in: query name: dropoff__gte required: false schema: format: date type: string dropoffLte: description: Return shipments with a dropoff stop with a planned data less than or equal to this value in: query name: dropoff__lte required: false schema: format: date type: string email: description: A valid email address in: query name: email required: true schema: type: string endDatetime: description: For requesting data ending at a given date in: query name: endDatetime required: false schema: format: date-time type: string entityType: description: Entity type of the Custom Field in: query name: entity_type schema: type: string equipmentType: description: Return shipments with this equipment type in: query name: equipment_type required: false schema: type: string equipmentTypeContains: description: Return shipments where the equipment type contains this value in: query name: equipment_type__contains required: false schema: type: string equipmentTypes: description: Return contracts with equipment types explode: true in: query name: equipment_types required: false schema: items: type: string type: array expandUsers: description: If True, render slim users on a CompanyWithOptionalUsers object in: query name: expand_users required: false schema: type: boolean expiresAtGte: description: Include load board shipments where expires_at is greater than or equal to this value in: query name: expires_at__gte required: false schema: format: date type: string expiresAtLte: description: Include load board shipments where expires_at is less than or equal to this value in: query name: expires_at__lte required: false schema: format: date type: string export: description: format to export data in in: query name: export required: false schema: enum: - csv type: string externalShipmentViewKey: description: Secret view key authorizing user to see the Shipment in: query name: key required: true schema: type: string fedexAccount: description: Return pickups specific to this FedEx account in: query name: fedex_account required: false schema: type: string fedexAccountId: in: path name: fedexAccountId required: true schema: format: uuid type: string fuelSurchargeTableId: description: The id of a fuel surcharge table in: path name: fuelSurchargeTableId required: true schema: type: string groupId: description: Group id for a shipment in: query name: groupId required: false schema: type: string hasBill: description: If true, show shipments which have at least one bill otherwise show those with none. in: query name: has_bill required: false schema: type: boolean hasDirectIntegration: description: Return vendor relationships where Shipwell has a direct integration with the vendor in: query name: has_direct_integration schema: type: boolean hasInvoice: description: If true, show shipments which have at least one invoice otherwise show those with none. in: query name: has_invoice required: false schema: type: boolean importColumnMappingId: description: The id of an import column mapping in: path name: importColumnMappingId required: true schema: format: uuid type: string importId: description: The id of an import in: path name: importId required: true schema: format: uuid type: string importJobId: description: The id of an import job in: path name: importJobId required: true schema: format: uuid type: string importRowId: description: The id of an import row in: path name: importRowId required: true schema: format: uuid type: string importValueId: description: The id of an import value in: path name: importValueId required: true schema: format: uuid type: string include: description: '[v3] A list of properties to include in the response resource' explode: true in: query name: include required: false schema: items: type: string type: array includeFailureQuotes: description: If true, include failed Quotes in the result set in: query name: include_failures required: false schema: type: boolean includeIds: description: Return objects whose ID is one of those provided explode: true in: query name: id required: false schema: items: format: uuid type: string type: array invoiceId: description: The id of an invoice in: path name: invoiceId required: true schema: format: uuid type: string isActive: in: query name: is_active required: false schema: type: boolean isRegularlyScheduled: description: Include pickups with this is_regularly_scheduled value in: query name: is_regularly_scheduled required: false schema: type: boolean is_contract: in: query name: is_contract required: false schema: type: boolean loadBoardBiddingStatus: description: The bidding status of shipments on the load board explode: true in: query name: bidding_status required: false schema: items: enum: - bidding - closed - open - won - tendered - accepted - rejected - expired type: string type: array loadBoardEnabled: description: Filter on whether or not a shipment is posted on the company load board in: query name: load_board_enabled required: false schema: type: boolean loadBoardId: description: Return shipments where the load board ID is equal to this value in: query name: load_board_id required: false schema: type: string loadBoardIdContains: description: Return shipments where the load board ID contains this value in: query name: load_board_id__contains required: false schema: type: string loadBoardShipmentId: description: The load board ID of a shipment on the load board in: path name: loadBoardShipmentId required: true schema: type: string loadBoardTenderStatus: description: The tender status of shipments on the load board explode: true in: query name: tender_status required: false schema: items: enum: - open - accepted - rejected - revoked - expired type: string type: array manual_entry: description: If the entry is being manually added instead of via search, set this to true in: query name: manual_entry required: true schema: type: boolean mcNumber: description: search by this (exact) mc number in: query name: mc_number schema: type: string mcNumberContains: description: Return companies where the mc number contains this string in: query name: mc_number__contains schema: type: string messageId: description: The id of the message in: path name: messageId required: true schema: format: uuid type: string mode: description: Return shipments with this shipment mode in: query name: mode required: false schema: type: string modeContains: description: Return shipments where the shipment mode contains this value in: query name: mode__contains required: false schema: type: string modes: description: Return contracts with shipment mode codes explode: true in: query name: modes required: false schema: items: type: string type: array nameContains: description: Return shipments where the shipment name contains this value in: query name: name__contains required: false schema: type: string onlyMyShipments: description: Whether to fetch all company requests or ones created by the user in: query name: only_my_shipments required: false schema: type: boolean open: description: Filter on whether or not a shipment is open in: query name: open required: false schema: type: boolean ordering: description: determines which column to sort by. Prepend with '-' to sort desc in: query name: ordering schema: type: string originContains: description: Return shipments with this value in the origin in: query name: origin__contains required: false schema: type: string originLat: description: Latitude of location to filter on for origin stop in: query name: origin_lat required: false schema: format: float type: number originLon: description: Longitude of location to filter on for origin stop in: query name: origin_lon required: false schema: format: float type: number originRadius: description: Radius from origin stop in: query name: origin_radius required: false schema: type: integer originStateProvince: description: Return shipments with this state province on its origin stop in: query name: origin_state_province required: false schema: type: string originsContains: description: Return shipments with this value in the origins explode: true in: query name: origins__contains required: false schema: items: type: string type: array originsStateProvince: description: Return shipments with this state province on its origins explode: true in: query name: origins_state_province required: false schema: items: type: string type: array page: description: indicates what page of a list of query results you want to view in: query name: page schema: type: integer page-size: description: indicates the how many items to return per page in a list request in: query name: page-size schema: type: integer parcelPickupStatus: description: Include shipments where the parcel pickup status equals one of these values explode: true in: query name: parcel_pickup_status required: false schema: items: enum: - CANCELLED - DELAYED - DELIVERED - IN_TRANSIT - NOT_SCHEDULED - SCHEDULED type: string type: array pickupCompany: description: Return pickups specific to this company in: query name: company required: false schema: type: string pickupGte: description: Return shipments with a pickup stop with a planned date greater than or equal to this value in: query name: pickup__gte required: false schema: format: date type: string pickupId: description: Include shipments currently associated with the provided ShipmentPickup's ID in: query name: pickup_id required: false schema: format: uuid type: string pickupLat: description: Latitude of location to filter on for pickup stop in: query name: pickup_lat required: false schema: format: float type: number pickupLon: description: Longitude of location to filter on for pickup stop in: query name: pickup_lon required: false schema: format: float type: number pickupLte: description: Return shipments with a pickup stop with a planned date less than or equal to this value in: query name: pickup__lte required: false schema: format: date type: string pickupNumber: description: Include shipments with these Pickup Numbers explode: true in: query name: pickup_number required: false schema: items: type: string type: array pickupNumberContains: description: Include shipments where the Pickup Number contains this value in: query name: pickup_number__contains required: false schema: type: string pickupNumberExclude: description: Exclude shipments with these Pickup Numbers explode: true in: query name: pickup_number__exclude required: false schema: items: type: string type: array pickupPickupNumber: description: Include pickups with this pickup number in: query name: pickup_number required: false schema: type: string pickupPickupNumberContains: description: Include pickups where the pickup number contains this value in: query name: pickup_number__contains required: false schema: type: string pickupPickupNumberExcludes: description: Exclude pickups with this pickup number in: query name: pickup_number__excludes required: false schema: type: string pickupRadius: description: Radius from a pickup stop in: query name: pickup_radius required: false schema: type: integer pickupShipmentIds: description: Return pickup with that include this shipment in: query name: shipment_ids required: false schema: type: string pickupStopsCompanyNameContains: description: Return shipments with this value in one of its pickup stops location company_name in: query name: pickup_stops_company_name__contains required: false schema: type: string pickupStopsContains: description: Return shipments with this value in one of its pickup stops in: query name: pickup_stops__contains required: false schema: type: string pickupStopsStateProvince: description: Return shipments with this state province on its pickup stops in: query name: pickup_stops_state_province required: false schema: type: string pointOfContact: description: Include pickups with this point of contact name in: query name: point_of_contact schema: type: string pointOfContactContains: description: Include pickups where the point of contact includes this value in: query name: point_of_contact__contains schema: type: string pointOfContactExcludes: description: Exclude pickups where the point of contact includes this value in: query name: point_of_contact__excludes schema: type: string pointOfContactsContains: description: Return objects where a point of contact contains this string in their name or email in: query name: point_of_contacts__contains required: false schema: type: string policyEndDateGte: description: Include Policies where end date is greater than or equal to this date in: query name: end_date__gte required: false schema: format: date type: string policyEndDateLte: description: Include Policies where end date is less than or equal to this date in: query name: end_date__lte required: false schema: format: date type: string policyId: description: The id of a policy in: path name: policyId required: true schema: format: uuid type: string policyNameContains: description: Include Policies where name contains this string in: query name: name__contains required: false schema: type: string policyReference: description: Include policies with this reference ID in: query name: reference required: false schema: type: string policyStartDateGte: description: Include Policies where start date is greater than or equal to this date in: query name: start_date__gte required: false schema: format: date type: string policyStartDateLte: description: Include Policies where start date is less than or equal to this date in: query name: start_date__lte required: false schema: format: date type: string policyStatus: description: Include Policies where status is equal to this value in: query name: status required: false schema: enum: - ACTIVE - INACTIVE type: string policyType: description: Include policies where the policy type is equal to this value in: query name: policy_type required: false schema: enum: - ROUTING_GUIDE - ORDER_CONSOLIDATION type: string policyWorkflowId: description: Include policies with this Workflow ID explode: true in: query name: workflow_id required: false schema: items: type: string type: array powerUnit: description: Return shipments where this power unit is assigned in: query name: power_unit required: false schema: format: uuid type: string powerUnitId: description: The id of the power unit in: path name: powerUnitId required: true schema: format: uuid type: string powerUnitName: description: PowerUnit name to query on in: query name: power_unit_name schema: type: string powerUnitNameContains: description: PowerUnit name substring to query on. Ignored if also querying for exact name. in: query name: power_unit_name__contains schema: type: string proNumber: description: Include shipments with these PRO Numbers explode: true in: query name: pro_number required: false schema: items: type: string type: array proNumberContains: description: Return shipments where the PRO number contains this value in: query name: pro_number__contains required: false schema: type: string proNumberExclude: description: Exclude shipments with these PRO Numbers explode: true in: query name: pro_number__exclude required: false schema: items: type: string type: array productId: description: The id of the product in: path name: productId required: true schema: format: uuid type: string provider: description: The provider of a carrier specific to a request in: query name: provider required: true schema: type: string providerCarrierCode: description: Include pickups with this provider carrier code in: query name: provider_carrier_code required: false schema: type: string providerCarrierCodeContains: description: Include pickups where the provider carrier code contains this value in: query name: provider_carrier_code__contains required: false schema: type: string providerCarrierCodeExcludes: description: Exclude pickups with this provider carrier code in: query name: provider_carrier_code__excludes required: false schema: type: string providerCode: description: Include pickups with this provider code in: query name: provider_code required: false schema: type: string providerLocationId: description: Include pickups with this provider location id in: query name: provider_location_id required: false schema: type: string providerLocationIdContains: description: Include pickups where the provider location id contains this value in: query name: provider_location_id__contains required: false schema: type: string providerLocationIdExcludes: description: Exclude pickups with this provider location id in: query name: provider_location_id__excludes required: false schema: type: string providers: description: An array of providers in: query name: providers required: false schema: items: type: string type: array purchaseOrderActualDeliveryDatetime: description: Include PurchaseOrders where actual_delivery_datetime is equal to this value in: query name: actual_delivery_datetime required: false schema: format: date-time type: string purchaseOrderActualDeliveryDatetimeGte: description: Include PurchaseOrders where actual_delivery_datetime is greater than or equal to this value in: query name: actual_delivery_datetime__gte required: false schema: format: date-time type: string purchaseOrderActualDeliveryDatetimeLte: description: Include PurchaseOrders where actual_delivery_datetime is less than or equal to this value in: query name: actual_delivery_datetime__lte required: false schema: format: date-time type: string purchaseOrderActualPickupDatetime: description: Include PurchaseOrders where actual_pickup_datetime is equal to this value in: query name: actual_pickup_datetime required: false schema: format: date-time type: string purchaseOrderActualPickupDatetimeGte: description: Include PurchaseOrders where actual_pickup_datetime is greater than or equal to this value in: query name: actual_pickup_datetime__gte required: false schema: format: date-time type: string purchaseOrderActualPickupDatetimeLte: description: Include PurchaseOrders where actual_pickup_datetime is less than or equal to this value in: query name: actual_pickup_datetime__lte required: false schema: format: date-time type: string purchaseOrderAlertId: description: The id of the purchase order alert in: path name: purchaseOrderAlertId required: true schema: format: uuid type: string purchaseOrderArchived: description: Filter on whether or not a PurchaseOrder is archived in: query name: archived required: false schema: type: boolean purchaseOrderCreatedAt: description: Include PurchaseOrders where created_at is equal to this value in: query name: created_at required: false schema: format: date type: string purchaseOrderCreatedAtGte: description: Include PurchaseOrders where created_at is greater than or equal to this value in: query name: created_at__gte required: false schema: format: date type: string purchaseOrderCreatedAtLte: description: Include PurchaseOrders where created_at is less than or equal to this value in: query name: created_at__lte required: false schema: format: date type: string purchaseOrderCreatedByUserContains: description: Include PurchaseOrders where created_by_user object contains this string e.g first_name, last_name or email in: query name: created_by_user__contains required: false schema: type: string purchaseOrderCreatedByUserId: description: Include PurchaseOrders where created_by_user_id is in the array. explode: true in: query name: created_by_user_id required: false schema: items: format: uuid type: string type: array purchaseOrderCreatedByUserName: description: Include PurchaseOrders where created_by_user_name is exactly this string in: query name: created_by_user_name required: false schema: type: string purchaseOrderCreatedByUserNameContains: description: Include PurchaseOrders where created_by_user_name contains this string in: query name: created_by_user_name__contains required: false schema: type: string purchaseOrderCustomerExternalIdContains: description: Include PurchaseOrders where customer_external_id contains this string in: query name: customer_external_id__contains required: false schema: type: string purchaseOrderCustomerNameContains: description: Include PurchaseOrders where customer_name contains this string in: query name: customer_name__contains required: false schema: type: string purchaseOrderDescriptionContains: description: Include PurchaseOrders where description contains this string in: query name: description__contains required: false schema: type: string purchaseOrderDestinationAddressContains: description: Include PurchaseOrders where destination_address contains this string in: query name: destination_address__contains required: false schema: type: string purchaseOrderId: description: The id of the purchase order in: path name: purchaseOrderId required: true schema: format: uuid type: string purchaseOrderInvoiceExternalIdContains: description: Include PurchaseOrders where invoice_external_id contains this string in: query name: invoice_external_id__contains required: false schema: type: string purchaseOrderLineItemId: description: The id of the purchase order line item in: path name: purchaseOrderLineItemId required: true schema: format: uuid type: string purchaseOrderName: description: Include PurchaseOrders where name is exactly this string in: query name: name required: false schema: type: string purchaseOrderNumber: description: Include shipments with these PO Numbers explode: true in: query name: purchase_order_number required: false schema: items: type: string type: array purchaseOrderNumberContains: description: Include shipments where the PO number contains this value in: query name: purchase_order_number__contains required: false schema: type: string purchaseOrderNumberExclude: description: Exclude shipments with these PO Numbers explode: true in: query name: purchase_order_number__exclude required: false schema: items: type: string type: array purchaseOrderOriginAddressContains: description: Include PurchaseOrders where origin_address contains this string in: query name: origin_address__contains required: false schema: type: string purchaseOrderOverallStatus: description: Return PurchaseOrders with an overall_status provided explode: true in: query name: overall_status required: false schema: items: enum: - ASSIGNED - UNASSIGNED - PICKED_UP - IN_TRANSIT - DELIVERED - EXCEPTIONS - CANCELLED type: string type: array purchaseOrderPONumberContains: description: Include PurchaseOrders where po_number contains this string in: query name: order_number__contains required: false schema: type: string purchaseOrderPlannedDeliveryEndDatetime: description: Include PurchaseOrders where planned_delivery_end_datetime is equal to this value in: query name: planned_delivery_end_datetime required: false schema: format: date-time type: string purchaseOrderPlannedDeliveryEndDatetimeGte: description: Include PurchaseOrders where planned_delivery_end_datetime is greater than or equal to this value in: query name: planned_delivery_end_datetime__gte required: false schema: format: date-time type: string purchaseOrderPlannedDeliveryEndDatetimeLte: description: Include PurchaseOrders where planned_delivery_end_datetime is less than or equal to this value in: query name: planned_delivery_end_datetime__lte required: false schema: format: date-time type: string purchaseOrderPlannedDeliveryStartDatetime: description: Include PurchaseOrders where planned_delivery_start_datetime is equal to this value in: query name: planned_delivery_start_datetime required: false schema: format: date-time type: string purchaseOrderPlannedDeliveryStartDatetimeGte: description: Include PurchaseOrders where planned_delivery_start_datetime is greater than or equal to this value in: query name: planned_delivery_start_datetime__gte required: false schema: format: date-time type: string purchaseOrderPlannedDeliveryStartDatetimeLte: description: Include PurchaseOrders where planned_delivery_start_datetime is less than or equal to this value in: query name: planned_delivery_start_datetime__lte required: false schema: format: date-time type: string purchaseOrderPlannedPickupEndDatetime: description: Include PurchaseOrders where planned_pickup_end_datetime is equal to this value in: query name: planned_pickup_end_datetime required: false schema: format: date-time type: string purchaseOrderPlannedPickupEndDatetimeGte: description: Include PurchaseOrders where planned_pickup_end_datetime is greater than or equal to this value in: query name: planned_pickup_end_datetime__gte required: false schema: format: date-time type: string purchaseOrderPlannedPickupEndDatetimeLte: description: Include PurchaseOrders where planned_pickup_end_datetime is less than or equal to this value in: query name: planned_pickup_end_datetime__lte required: false schema: format: date-time type: string purchaseOrderPlannedPickupStartDatetime: description: Include PurchaseOrders where planned_pickup_start_datetime is equal to this value in: query name: planned_pickup_start_datetime required: false schema: format: date-time type: string purchaseOrderPlannedPickupStartDatetimeGte: description: Include PurchaseOrders where planned_pickup_start_datetime__gte is greater than or equal to this value in: query name: planned_pickup_start_datetime__gte required: false schema: format: date-time type: string purchaseOrderPlannedPickupStartDatetimeLte: description: Include PurchaseOrders where planned_pickup_start_datetime__gte is less than or equal to this value in: query name: planned_pickup_start_datetime__lte required: false schema: format: date-time type: string purchaseOrderShipmentAssigned: description: Include PurchaseOrders that have/do not have a shipment assigned in: query name: shipment_assigned required: false schema: type: boolean purchaseOrderShipmentId: description: Include PurchaseOrders where shipment_id is exactly this string in: query name: shipment_id required: false schema: format: uuid type: string purchaseOrderShipmentReferenceId: description: Include PurchaseOrders where shipment_reference_id is exactly this string in: query name: shipment_reference_id required: false schema: format: uuid type: string purchaseOrderSource: description: Return PurchaseOrders created by sources in the array. explode: true in: query name: source required: false schema: items: enum: - MAGENTO - SHIPWELL_WEB - SHOPIFY - IMPORT - TENDER - SHIPWELL_WEB_UNAUTH type: string type: array purchaseOrderSourceSystemIdContains: description: Include PurchaseOrders where source_system_id contains this string in: query name: source_system_id__contains required: false schema: type: string purchaseOrderStatus: description: Include PurchaseOrders where status is exactly this string in: query name: status required: false schema: type: string purchaseOrderSupplierExternalIdContains: description: Include PurchaseOrders where vendor_external_id contains this string in: query name: supplier_external_id__contains required: false schema: type: string purchaseOrderSupplierNameContains: description: Include PurchaseOrders where vendor_name contains this string in: query name: supplier_name__contains required: false schema: type: string purchaseOrderTotalPriceGte: description: Include PurchaseOrders where total_price is greater than or equal to this amount in: query name: total_price__gte required: false schema: type: number purchaseOrderTotalPriceLte: description: Include PurchaseOrders where total_price is less than or equal to this amount in: query name: total_price__lte required: false schema: type: number q: description: search query in: query name: q schema: type: string quickbooksExpensesCategoryMappingId: description: The id of the QuickbooksExpenses to Category Mapping in: path name: quickbooksExpensesCategoryMappingId required: true schema: format: uuid type: string quickbooksItemCategoryMappingId: description: The id of the Quickbooks Item to Category Mapping in: path name: quickbooksItemCategoryMappingId required: true schema: format: uuid type: string quoteId: description: The id of the quote in: path name: quoteId required: true schema: format: uuid type: string rate: description: The rate in: query name: rate schema: format: float type: number read: description: filter on whether or not an object has been read in: query name: read schema: type: boolean recordedELDProviderId: description: The id of the recorded ELD provider in: path name: recordedELDProviderId required: true schema: format: uuid type: string recordedEquipmentTypeId: description: The id of the recorded equipment type in: path name: recordedEquipmentTypeId required: true schema: format: uuid type: string referenceId: description: Include shipments with these Reference IDs explode: true in: query name: reference_id required: false schema: items: type: string type: array referenceIdContains: description: Include shipments where the reference ID contains this value in: query name: reference_id__contains required: false schema: type: string referenceIdExclude: description: Exclude shipments with these Reference IDs explode: true in: query name: reference_id__exclude required: false schema: items: type: string type: array repId: description: The id of the rep in: path name: repId required: true schema: format: uuid type: string reps: description: Include shipments with these reps explode: true in: query name: reps required: false schema: items: format: uuid type: string type: array requestedEquipmentTypes: description: Return shipments where the load board offering company requests these equipment type machine readable codes explode: true in: query name: requested_equipment_types required: false schema: items: type: string type: array requestedEquipmentTypesContains: description: Return shipments where the load board offering company requests equipment types that partially match machine readable codes explode: true in: query name: requested_equipment_types__contains required: false schema: items: type: string type: array requestedShipmentModes: description: Return shipments where the load board offering company requests these shipment mode codes explode: true in: query name: requested_shipment_modes required: false schema: items: type: string type: array rfqId: description: The id of the rfq in: path name: rfqId required: true schema: format: uuid type: string rmisAPIAccountId: in: path name: rmisAPIAccountId required: true schema: format: uuid type: string rmisCarrierProfileId: description: The id of an rmis carrier profile in: path name: rmisCarrierProfileId required: true schema: format: uuid type: string rmisFTPAccountId: in: path name: rmisFTPAccountId required: true schema: format: uuid type: string role: description: Get results based on a specific perspective such as owner_operator in: query name: role required: false schema: enum: - owner_operator type: string saferWatchAccountId: in: path name: saferWatchAccountId required: true schema: format: uuid type: string saferWatchCarrierProfileId: description: The id of a saferwatch carrier profile in: path name: saferWatchCarrierProfileId required: true schema: format: uuid type: string salesRepsContains: description: Return RateShareConfigs where once of the sales reps names contains this string in: query name: sales_reps__contains required: false schema: type: string salesRepsIds: description: Return RateShareConfigs where these user IDs are listed as sales repss explode: true in: query name: sales_reps_ids required: false schema: items: type: string type: array scheduledDate: description: Date of a scheduled pickup in: query name: scheduled_date schema: format: date type: string scheduledDateGte: description: Return pickups with a scheduled date greater than or equal to this value in: query name: scheduled_date__gte schema: format: date type: string scheduledDateLte: description: Return pickups with a scheduled date less than or equal to this value in: query name: scheduled_date__lte schema: format: date type: string scheduledTimeWindowEndGte: description: Return pickups with a scheduled end time window date and time greater than or equal to this value in: query name: scheduled_time_window_end__gte schema: type: string scheduledTimeWindowEndLte: description: Return pickups with a scheduled end time window date and time less than or equal to this value in: query name: scheduled_time_window_end__lte schema: type: string scheduledTimeWindowStartGte: description: Return pickups with a scheduled start time window date and time greater than or equal to this value in: query name: scheduled_time_window_start__gte schema: type: string scheduledTimeWindowStartLte: description: Return pickups with a scheduled start time window date and time less than or equal to this value in: query name: scheduled_time_window_start__lte schema: type: string serviceLevel: description: Return shipments with this service level in: query name: service_level required: false schema: type: string serviceLevelAgreementAwardedLoadsPerDay: description: Include ServiceLevelAgreements where awarded loads per day is exactly this value in: query name: awarded_loads_per_day required: false schema: format: float type: number serviceLevelAgreementCapacityPerDay: description: Include ServiceLevelAgreements where capacity per day is exactly this value in: query name: capacity_per_day required: false schema: format: float type: number serviceLevelAgreementEndDateGte: description: Include ServiceLevelAgreements where end date is greater than or equal to this date in: query name: end_date__gte required: false schema: format: date type: string serviceLevelAgreementEndDateLte: description: Include ServiceLevelAgreements where end date is less than or equal to this date in: query name: end_date__lte required: false schema: format: date type: string serviceLevelAgreementId: description: The id of a service level agreement in: path name: serviceLevelAgreementId required: true schema: type: string serviceLevelAgreementName: description: Include ServiceLevelAgreements where name matches this string in: query name: name required: false schema: type: string serviceLevelAgreementPosition: description: Include ServiceLevelAgreements where position is exactly this string in: query name: position required: false schema: enum: - PRIMARY - SECONDARY - TERTIARY - BACKUP type: string serviceLevelAgreementStartDateGte: description: Include ServiceLevelAgreements where start date is greater than or equal to this date in: query name: start_date__gte required: false schema: format: date type: string serviceLevelAgreementStartDateLte: description: Include ServiceLevelAgreements where start date is less than or equal to this date in: query name: start_date__lte required: false schema: format: date type: string serviceLevelAgreementStatus: description: Include ServiceLevelAgreements where status is exactly this string in: query name: status required: false schema: enum: - ACTIVE - INACTIVE type: string settlementProcessingStatus: description: Filter invoices or bills by processing status in: query name: processing_status required: false schema: enum: - PROCESSING - ERROR - SUCCESS type: string shipmentAccessorials: description: Include only shipments with at least one matching ShipmentAccessorial explode: true in: query name: accessorials required: false schema: items: type: string type: array shipmentCaseId: description: The id of the shipment case in: path name: shipmentCaseId required: true schema: format: uuid type: string shipmentCreatedAtGte: description: Include shipments where created_at is greater than or equal to the time value in: query name: created_at__gte required: false schema: format: date-time type: string shipmentCreatedAtLte: description: Include shipments where created_at is less than or equal to this value in: query name: created_at__lte required: false schema: format: date-time type: string shipmentId: description: The id of the shipment in: path name: shipmentId required: true schema: format: uuid type: string shipmentLocationFilterDistance: description: Applies a distance filter and only returns points greater than filter_distance km apart. To return all, set this to -1 in: query name: filter_distance required: false schema: type: string shipmentMessageId: in: path name: shipmentMessageId required: true schema: format: uuid type: string shipmentNoteId: in: path name: shipmentNoteId required: true schema: format: uuid type: string shipmentPickupId: in: path name: shipmentPickupId required: true schema: format: uuid type: string shipmentStatus: description: Include shipments with these statuses explode: true in: query name: status required: false schema: items: enum: - appointment_pending - at_pickup - at_delivery - auction_running - cancelled - carrier_confirmed - delayed - delivered - dispatched - draft - in_transit - out_for_delivery - quote_accepted - quoting - reconciled - scheduled - tendered type: string type: array shipmentStatusContains: description: Include shipments where the status contains this string in: query name: status__contains required: false schema: type: string shipmentStatusExclude: description: Exclude shipments with these statuses explode: true in: query name: status__exclude required: false schema: items: enum: - appointment_pending - at_pickup - at_delivery - auction_running - cancelled - carrier_confirmed - delayed - delivered - dispatched - draft - in_transit - out_for_delivery - quote_accepted - quoting - reconciled - scheduled - tendered type: string type: array shipmentTagId: in: path name: shipmentTagId required: true schema: format: uuid type: string shipmentTags: description: Include only shipments with at least one matching ShipmentTag explode: true in: query name: tags required: false schema: items: format: uuid type: string type: array shipmentTimelineEventId: in: path name: shipmentTimelineEventId required: true schema: format: uuid type: string shipment_id: description: The id of the shipment in: query name: shipment_id required: false schema: format: uuid type: string shipperCarrierRelationshipId: description: The id of the shipper carrier relationship in: path name: shipperCarrierRelationshipId required: true schema: format: uuid type: string shipperId: description: The id of the shipper in: path name: shipperId required: true schema: format: uuid type: string shipperRelationshipId: description: The id of the shipper relationship in: path name: shipperRelationshipId required: true schema: format: uuid type: string since: description: filter on objects since a datetime in: query name: since schema: format: date-time type: string specialInstructions: description: Include pickups with these special instructions in: query name: special_instructions schema: type: string specialInstructionsContains: description: Include pickups where the special instructions includes this value in: query name: special_instructions__contains schema: type: string specialInstructionsExcludes: description: Exclude pickups where the special instructions includes this value in: query name: special_instructions__excludes schema: type: string spotNegotiationId: description: The id of the spot negotiation in: path name: spotNegotiationId required: true schema: format: uuid type: string spotNegotiationMessageId: description: The id of the spot negotiation message in: path name: spotNegotiationMessageId required: true schema: format: uuid type: string spotNegotiationQuoteId: description: The id of the spot negotiation quote in: path name: spotNegotiationQuoteId required: true schema: format: uuid type: string spotnegotiationClosedByCustomer: description: Restrict SpotNegotiations based on whether customer closed in: query name: closed_by_customer required: false schema: type: boolean spotnegotiationClosedByVendor: description: Restrict SpotNegotiations based on whether vendor closed in: query name: closed_by_vendor required: false schema: type: boolean spotnegotiationCustomerId: description: ID of customer company to which to restrict SpotNegotiations in: query name: customer_id required: false schema: format: uuid type: string spotnegotiationCustomerNameContains: description: Partial name of customer company to which to restrict SpotNegotiations in: query name: customer_name__contains required: false schema: type: string spotnegotiationInvolvedOnly: description: Restrict SpotNegotiations to those in which user is explicitly involved in: query name: involved_only required: false schema: type: boolean spotnegotiationInvolvedVendorUsers: description: Restrict SpotNegotiations to those with provided User IDs involved on the vendor side explode: true in: query name: involved_vendor_users required: false schema: items: format: uuid type: string type: array spotnegotiationIsMostRecentWinner: description: Restrict SpotNegotiations to those that are or are not the most recent winner in: query name: is_most_recent_winner required: false schema: type: boolean spotnegotiationIsOpen: description: Restrict SpotNegotiations based on both sides agreeing the negotiation is open in: query name: is_open required: false schema: type: boolean spotnegotiationShipment: description: Return SpotNegotiations where Shipment ID matches in: query name: shipment required: false schema: format: uuid type: string spotnegotiationShipmentBolNumber: description: Return SpotNegotiations where Shipment BOL number matches in: query name: shipment_bol_number required: false schema: type: string spotnegotiationShipmentBolNumberContains: description: Return SpotNegotiations where Shipment BOL number partially matches in: query name: shipment_bol_number__contains required: false schema: type: string spotnegotiationShipmentCapacityProviderCustomerReferenceNumber: description: Return SpotNegotiations where Shipment capacity provider customer reference number matches in: query name: shipment_capacity_provider_customer_reference_number required: false schema: type: string spotnegotiationShipmentCapacityProviderCustomerReferenceNumberContains: description: Return SpotNegotiations where Shipment capacity provider customer reference number partially matches in: query name: shipment_capacity_provider_customer_reference_number__contains required: false schema: type: string spotnegotiationShipmentCustomerReferenceNumber: description: Return SpotNegotiations where Shipment customer reference number matches in: query name: shipment_customer_reference_number required: false schema: type: string spotnegotiationShipmentCustomerReferenceNumberContains: description: Return SpotNegotiations where Shipment customer reference number partially matches in: query name: shipment_customer_reference_number__contains required: false schema: type: string spotnegotiationShipmentDelayed: description: Return SpotNegotiations where Shipment delayed matches in: query name: shipment_delayed required: false schema: type: string spotnegotiationShipmentDestinationContains: description: Return SpotNegotiations where Shipment destination partially matches in: query name: shipment_destination__contains required: false schema: type: string spotnegotiationShipmentDropoffGte: description: Return SpotNegotiations with a dropoff stop with a planned date greater than or equal to this value in: query name: shipment_dropoff__gte required: false schema: format: date type: string spotnegotiationShipmentDropoffLte: description: Return SpotNegotiations with a dropoff stop with a planned data less than or equal to this value in: query name: shipment_dropoff__lte required: false schema: format: date type: string spotnegotiationShipmentName: description: Return SpotNegotiations where Shipment name matches in: query name: shipment_name required: false schema: type: string spotnegotiationShipmentNameContains: description: Return SpotNegotiations where Shipment name partially matches in: query name: shipment_name__contains required: false schema: type: string spotnegotiationShipmentOriginContains: description: Return SpotNegotiations where Shipment origin partially matches in: query name: shipment_origin__contains required: false schema: type: string spotnegotiationShipmentPickupGte: description: Return SpotNegotiations with a pickup stop with a planned date greater than or equal to this value in: query name: shipment_pickup__gte required: false schema: format: date type: string spotnegotiationShipmentPickupLte: description: Return SpotNegotiations with a pickup stop with a planned date less than or equal to this value in: query name: shipment_pickup__lte required: false schema: format: date type: string spotnegotiationShipmentPickupNumber: description: Return SpotNegotiations where Shipment pickup number matches in: query name: shipment_pickup_number required: false schema: type: string spotnegotiationShipmentPickupNumberContains: description: Return SpotNegotiations where Shipment pickup number partially matches in: query name: shipment_pickup_number__contains required: false schema: type: string spotnegotiationShipmentProNumber: description: Return SpotNegotiations where Shipment PRO number matches in: query name: shipment_pro_number required: false schema: type: string spotnegotiationShipmentProNumberContains: description: Return SpotNegotiations where Shipment PRO number partially matches in: query name: shipment_pro_number__contains required: false schema: type: string spotnegotiationShipmentPurchaseOrderNumber: description: Return SpotNegotiations where Shipment purchase order number matches in: query name: shipment_purchase_order_number required: false schema: type: string spotnegotiationShipmentPurchaseOrderNumberContains: description: Return SpotNegotiations where Shipment purchase order number partially matches in: query name: shipment_purchase_order_number__contains required: false schema: type: string spotnegotiationShipmentReferenceId: description: Return SpotNegotiations where Shipment reference_id matches in: query name: shipment_reference_id required: false schema: type: string spotnegotiationShipmentReferenceIdContains: description: Return SpotNegotiations where Shipment reference_id partially matches in: query name: shipment_reference_id__contains required: false schema: type: string spotnegotiationShipmentState: description: Return SpotNegotiations where Shipment state matches in: query name: shipment_state required: false schema: type: string spotnegotiationShipmentStatus: description: Return SpotNegotiations with shipments that have provided statuses explode: true in: query name: shipment_status required: false schema: items: enum: - appointment_pending - at_pickup - at_delivery - auction_running - cancelled - carrier_confirmed - delayed - delivered - dispatched - draft - in_transit - out_for_delivery - quote_accepted - quoting - reconciled - scheduled - tendered type: string type: array spotnegotiationVendorId: description: ID of the vendor company to which to restrict SpotNegotiations in: query name: vendor_id required: false schema: format: uuid type: string spotnegotiationVendorNameContains: description: Partial name of the vendor company to which to restrict SpotNegotiations in: query name: vendor_name__contains required: false schema: type: string stopAlertId: description: The id of the stop alert in: path name: stopAlertId required: true schema: format: uuid type: string stopId: description: The id of the stop in: path name: stopId required: true schema: format: uuid type: string stopLocationCompanyName: description: Return stop locations whose company_name is equivalent to this value in: query name: company_name required: false schema: type: string stopLocationCompanyNameContains: description: Return stop locations with this value in the company_name in: query name: company_name__contains required: false schema: type: string stops: description: A slim version of the address of a stop. In the form country:US|zip:66021 explode: true in: query name: stops required: true schema: items: type: string type: array stopsCompanyNameContains: description: Return shipments with this value in one of its stops location company_name in: query name: stops_company_name__contains required: false schema: type: string stopsContains: description: Return shipments with this value in one of its stops in: query name: stops__contains required: false schema: type: string stopsStateProvince: description: Return shipments with this state province on one of its stops in: query name: stops_state_province required: false schema: type: string supplierInviteBookedAtGte: description: Include SupplierInvites where booked_at is greater than or equal to this value in: query name: booked_at__gte required: false schema: format: date type: string supplierInviteBookedAtLte: description: Include SupplierInvites where booked_at is less than or equal to this value in: query name: booked_at__lte required: false schema: format: date type: string supplierInviteCreatedAtGte: description: Include SupplierInvites where created_at is greater than or equal to this value in: query name: created_at__gte required: false schema: format: date type: string supplierInviteCreatedAtLte: description: Include SupplierInvites where created_at is less than or equal to this value in: query name: created_at__lte required: false schema: format: date type: string supplierInviteExpressDelivery: description: Return objects where express_delivery is this value in: query name: express_delivery required: false schema: type: boolean supplierInviteKey: description: The token key for the supplier invite in: path name: supplierInviteKey required: true schema: type: string supplierInviteMessageToSupplierContains: description: Return objects where the message_to_supplier contains this string in: query name: message_to_supplier__contains required: false schema: type: string supplierInvitePONumber: description: Return objects where the po_number is equal to this string in: query name: po_number required: false schema: type: string supplierInvitePONumberContains: description: Return objects where the po_number contains this string in: query name: po_number__contains required: false schema: type: string supplierInviteRevokedAtGte: description: Include SupplierInvites where revoked_at is greater than or equal to this value in: query name: revoked_at__gte required: false schema: format: date type: string supplierInviteRevokedAtLte: description: Include SupplierInvites where revoked_at is less than or equal to this value in: query name: revoked_at__lte required: false schema: format: date type: string supplierInviteSentByUserName: description: Return objects where the sent_by_user name is equal to this string in: query name: sent_by_user_name required: false schema: type: string supplierInviteSentByUserNameContains: description: Return objects where one of the sent_by_user name contains this string in: query name: sent_by_user_name__contains required: false schema: type: string supplierInviteShipmentCreatedAtGte: description: Include SupplierInvites where the Shipment created_at is greater than or equal to this value in: query name: shipment_created_at__gte required: false schema: format: date type: string supplierInviteShipmentCreatedAtLte: description: Include SupplierInvites where Shipment created_at is less than or equal to this value in: query name: shipment_created_at__lte required: false schema: format: date type: string supplierInviteShipmentReferenceId: description: Include SupplierInvites where the Shipment reference_id is this value in: query name: shipment_reference_id required: false schema: type: string supplierInviteShipmentReferenceIdContains: description: Return objects where one of the Shipment reference_id contains this string in: query name: shipment_reference_id__contains required: false schema: type: string supplierInviteStatus: description: Include Supplier Invite with these statuses explode: true in: query name: status required: false schema: items: enum: - BOOKED - CANCELLED - REQUESTED - UNABLE_TO_BOOK type: string type: array supplierInviteSupplierEmailAddress: description: Return objects where the supplier_email_address is equal to this string in: query name: supplier_email_address required: false schema: type: string supplierInviteSupplierEmailAddressContains: description: Return objects where one of the supplier_email_address contains this string in: query name: supplier_email_address__contains required: false schema: type: string supplierInviteUpdatedAtGte: description: Include SupplierInvites where updated_at is greater than or equal to this value in: query name: updated_at__gte required: false schema: format: date type: string supplierInviteUpdatedAtLte: description: Include SupplierInvites where updated_at is less than or equal to this value in: query name: updated_at__lte required: false schema: format: date type: string tableType: description: filter for dashboard config to return a specific table type in: query name: table_type schema: type: string tagId: description: The id of the tag in: path name: tagId required: true schema: format: uuid type: string tags: description: Return objects with these (exact) tags explode: true in: query name: tags required: false schema: items: type: string type: array tagsContains: description: Return objects where one of the tags contains this string in: query name: tags__contains required: false schema: type: string taskAssignee: description: ID of the user assigned to the task in: query name: assignee_id required: false schema: format: uuid type: string taskCaseId: description: ID of the case the task belongs to in: query name: case_id required: false schema: format: uuid type: string taskCreatedByUser: description: ID of the user who created the task in: query name: created_by_user_id required: false schema: format: uuid type: string taskDescriptionContains: description: Text search of the task description in: query name: description__contains required: false schema: format: uuid type: string taskDueDateGte: description: Search tasks with a due date greater than or equal to the value in: query name: due_date__gte required: false schema: format: date-time type: string taskDueDateLte: description: Search tasks with a due date less than or equal to the value in: query name: due_date__lte required: false schema: format: date-time type: string taskId: description: The id of the task in: path name: taskId required: true schema: format: uuid type: string taskIsOpen: description: Whether or not the task is open in: query name: is_open required: false schema: type: boolean taskShipmentId: description: ID of the shipment the task belongs to in: query name: shipment_id required: false schema: format: uuid type: string tenderCreatedByCompany: description: Restrict Tenders by created by customer ID in: query name: created_by_company__id required: false schema: format: uuid type: string tenderCustomerShipperReferenceNumber: description: Restrict Tenders by custoemr shipment reference number in: query name: shipment__customer_reference_number required: false schema: type: string tenderExternalSystemShipmentId: description: Restrict Tenders by the external EDI system shipment ID in: query name: external_edi_system_shipment_id required: false schema: type: string tenderId: in: path name: tenderId required: true schema: format: uuid type: string tenderShipmentId: description: Restrict Tenders by shipment ID in: query name: shipment_id required: false schema: format: uuid type: string tenderShipmentReferenceId: description: Restrict Tenders by the shipment reference_id on the platform in: query name: shipment__reference_id required: false schema: type: string tenderTenderToCompany: description: Restrict Tenders by company ID of carrier assigned to tender in: query name: tender_to_company_id required: false schema: format: uuid type: string timeFrame: description: Return shipments that are within the given time frame. active = current + upcoming in: query name: time_frame required: false schema: enum: - current - upcoming - active - past type: string timelineLastUpdatedAtGte: description: Return shipments where last timeline update was greater than or equal to the value or was never updated in: query name: timeline_last_updated_at__gte required: false schema: type: string timelineLastUpdatedAtLte: description: Return shipments where last timeline update was less than or equal to the value or was never updated in: query name: timeline_last_updated_at__lte required: false schema: type: string totalMilesGte: description: Return shipments with total miles greater than or equal to this value in: query name: total_miles__gte required: false schema: type: integer totalMilesLte: description: Return shipments with total miles less than or equal to this value in: query name: total_miles__lte required: false schema: type: integer totalWeightOverrideGte: description: Return shipments with weight greater than or equal to this value in: query name: total_weight_override__gte required: false schema: type: integer totalWeightOverrideLte: description: Return shipments with weight less than or equal to this value in: query name: total_weight_override__lte required: false schema: type: integer trailerId: description: The id of the trailer in: path name: trailerId required: true schema: format: uuid type: string triumphId: description: The id of the vendor triumph pay record in: path name: triumphId required: true schema: format: uuid type: string triumphPaymentTypeId: description: The id of the payment type synced to triumph pay in: path name: triumphPaymentTypeId required: true schema: format: uuid type: string triumphSettingsId: description: The id of the company's triumph pay settings in: path name: triumphSettingsId required: true schema: format: uuid type: string updatedAt: description: For requesting data updated at a certain datetime in: query name: updated_at required: false schema: format: date-time type: string upsAccount: description: Return pickups specific to this UPS account in: query name: ups_account required: false schema: type: string upsAccountId: in: path name: upsAccountId required: true schema: format: uuid type: string usdot: description: search by this (exact) usdot number in: query name: usdot schema: type: string usdotContains: description: Return companies where the usdot number contains this string in: query name: usdot__contains schema: type: string userDashboardConfigurationId: description: The id of the user dashboard configuration in: path name: userDashboardConfigurationId required: true schema: format: uuid type: string userEmail: description: Include users with this email in: query name: email required: false schema: type: string userFirstName: description: Include users with this first name in: query name: first_name required: false schema: type: string userId: description: The id of the user in: path name: userId required: true schema: format: uuid type: string userLastName: description: Include users with this last name in: query name: last_name required: false schema: type: string uspsAccountId: in: path name: uspsAccountId required: true schema: format: uuid type: string validateOnly: description: Whether imports should only validate the data or commit it to the database in: query name: validateOnly required: true schema: type: boolean vendor: description: Return shipments with this exact value as the vendor Carrier id in: query name: vendor_id required: false schema: type: string vendorContains: description: Return shipments where the vendor company name contains this value in: query name: vendor__contains required: false schema: type: string vendorEnabledForLoadBoard: description: Return vendor relationships that have at least one load board enabled point of contact in: query name: load_board_enabled schema: type: boolean vendorTagName: description: Return vendor tags that contain this name in: query name: name required: false schema: type: string requestBodies: AccessorialChargeTable: content: application/json: schema: $ref: '#/components/schemas/AccessorialChargeTable' required: true AddressBookEntry: content: application/json: schema: $ref: '#/components/schemas/AddressBookEntry' required: true AlertsDashboardConfiguration: content: application/json: schema: $ref: '#/components/schemas/AlertsDashBoardConfiguration' AutomationEvent: content: application/json: schema: $ref: '#/components/schemas/AutomationEvent' required: true AwardDeclineQuoteRequest: content: application/json: schema: $ref: '#/components/schemas/AwardDeclineQuoteRequest' required: true Body: content: application/json: schema: properties: company_id: format: uuid type: string required: - company_id type: object required: true BulkCreateSpotNegotiationRequest: content: application/json: schema: $ref: '#/components/schemas/BulkCreateSpotNegotiationRequest' required: true BuyItNowRequest: content: application/json: schema: $ref: '#/components/schemas/BuyItNow' required: true CarrierAssignment: content: application/json: schema: $ref: '#/components/schemas/CarrierAssignment' required: true CarrierBid: content: application/json: schema: $ref: '#/components/schemas/CarrierBid' required: true CarrierConfig: content: application/json: schema: $ref: '#/components/schemas/CarrierConfig' required: true CarrierPocTag: content: application/json: schema: $ref: '#/components/schemas/CarrierPocTag' required: true CarrierRelationship: content: application/json: schema: $ref: '#/components/schemas/CarrierRelationship' required: true CarrierTag: content: application/json: schema: $ref: '#/components/schemas/CarrierTag' required: true CaseNote: content: application/json: schema: $ref: '#/components/schemas/CaseNote' required: true Contract: content: application/json: schema: $ref: '#/components/schemas/Contract' required: true CreateQuote: content: application/json: schema: $ref: '#/components/schemas/CreateQuote' required: true CreateShipmentTimelineEvent: content: application/json: schema: $ref: '#/components/schemas/CreateShipmentTimelineEvent' required: true CreateSpotNegotiationQuote: content: application/json: schema: $ref: '#/components/schemas/CreateSpotNegotiationQuote' required: true CustomField: content: application/json: schema: $ref: '#/components/schemas/CustomField' required: true Driver: content: application/json: schema: $ref: '#/components/schemas/Driver' required: true DriverPinRequest: content: application/json: schema: $ref: '#/components/schemas/DriverPinRequest' required: true FuelSurchargeTable: content: application/json: schema: $ref: '#/components/schemas/FuelSurchargeTable' required: true LinkDriver: content: application/json: schema: $ref: '#/components/schemas/LinkDriver' required: true PostBrokeragesBrokerageidShipperRelationshipsShipperrelationshipidDocuments: content: multipart/form-data: schema: $ref: '#/components/schemas/PostBrokeragesBrokerageidShipperRelationshipsShipperrelationshipidDocuments' PostCompaniesCompanyidUsers: content: multipart/form-data: schema: $ref: '#/components/schemas/PostCompaniesCompanyidUsers' PostProducts: content: multipart/form-data: schema: $ref: '#/components/schemas/PostProducts' PowerUnit: content: application/json: schema: $ref: '#/components/schemas/PowerUnit' required: true PurchaseOrder: content: application/json: schema: $ref: '#/components/schemas/PurchaseOrder' required: true PurchaseOrderAlert: content: application/json: schema: $ref: '#/components/schemas/PurchaseOrderAlert' required: true PurchaseOrderLineItem: content: application/json: schema: $ref: '#/components/schemas/PurchaseOrderLineItem' required: true Quote: content: application/json: schema: $ref: '#/components/schemas/Quote' required: true RFQ: content: application/json: schema: $ref: '#/components/schemas/RFQ' required: true RecordedELDProvider: content: application/json: schema: $ref: '#/components/schemas/RecordedELDProvider' required: true RecordedEquipmentType: content: application/json: schema: $ref: '#/components/schemas/RecordedEquipmentType' required: true ServiceLevelAgreement: content: application/json: schema: $ref: '#/components/schemas/ServiceLevelAgreement' required: true Shipment: content: application/json: schema: $ref: '#/components/schemas/Shipment' required: true ShipmentCase: content: application/json: schema: $ref: '#/components/schemas/ShipmentCase' required: true ShipmentDocumentMetadata: content: application/json: schema: $ref: '#/components/schemas/ShipmentDocumentMetadata' required: true ShipmentMessage: content: application/json: schema: $ref: '#/components/schemas/ShipmentMessage' required: true ShipmentNote: content: application/json: schema: $ref: '#/components/schemas/ShipmentNote' required: true ShipmentTag: content: application/json: schema: $ref: '#/components/schemas/ShipmentTag' required: true SpotNegotiation: content: application/json: schema: $ref: '#/components/schemas/SpotNegotiation' required: true SpotNegotiationMessage: content: application/json: schema: $ref: '#/components/schemas/SpotNegotiationMessage' required: true Stop: content: application/json: schema: $ref: '#/components/schemas/Stop' required: true StopAlert: content: application/json: schema: $ref: '#/components/schemas/StopAlert' required: true SupplierInvite: content: application/json: schema: $ref: '#/components/schemas/SupplierInvite' required: true Task: content: application/json: schema: $ref: '#/components/schemas/Task' required: true TenderAcceptReject: content: application/json: schema: $ref: '#/components/schemas/TenderAcceptReject' required: true TenderEventRequest: content: application/json: schema: $ref: '#/components/schemas/TenderEventRequest' required: true TenderRequest: content: application/json: schema: $ref: '#/components/schemas/TenderRequest' required: true Trailer: content: application/json: schema: $ref: '#/components/schemas/Trailer' required: true TriumphPayDocumentsSubmissionEmail: content: application/json: schema: $ref: '#/components/schemas/TriumphPayDocumentsSubmissionEmail' required: true UserDashboardConfiguration: content: application/json: schema: $ref: '#/components/schemas/UserDashboardConfiguration' required: true UserPreferences: content: application/json: schema: $ref: '#/components/schemas/UserPreferences' required: true responses: defaultError: content: application/json: schema: $ref: '#/components/schemas/ShipwellError' description: Default error response noContent: content: application/json: schema: properties: message: type: string title: NoContentResponse type: object description: Successfully carried out the operation. No content returned schemas: AbstractChargeLineItem: properties: amount: description: 'Total amount of the line item, or unit_amount times unit_quantity ' format: float type: number category: $ref: '#/components/schemas/ChargeCategory' charge_code: $ref: '#/components/schemas/ChargeCode' created_at: format: date-time type: string id: format: uuid type: string unit_amount: description: Cost of one unit of the line item format: float type: number unit_amount_currency: default: USD enum: - CAD - USD type: string unit_name: description: Descriptor for one unit of the line item type: string unit_quantity: default: 1 format: float type: number updated_at: format: date-time type: string required: - category - unit_amount - unit_quantity type: object Accessorial: description: Accessorial code, price, and description properties: code: type: string currency_unit: type: string description: type: string id: format: int32 type: integer is_charge_code: type: boolean long_description: type: string price: format: float type: number type: type: string required: - id - code - description - long_description - type - is_charge_code - price - currency_unit type: object AccessorialChargeTable: description: Rate table for calculating accessorial prices properties: additional_instructions: type: string calculation_rows: items: $ref: '#/components/schemas/AccessorialChargeTableCalculationRow' type: array carrier_relationships: items: format: uuid type: string type: array company: format: uuid type: string created_by_user: format: uuid type: string destinations: items: $ref: '#/components/schemas/Address' type: array end_date: format: date type: string equipment_types: items: type: string type: array external_reference: description: Unique identifier for the rate table within an external system type: string modes: items: type: string type: array name: type: string origins: items: $ref: '#/components/schemas/Address' type: array start_date: format: date type: string status: enum: - ACTIVE - INACTIVE type: string required: - calculation_rows - name - status type: object AccessorialChargeTableCalculationRow: description: Specification for how a price for a certain accessorial should be determined properties: accessorial: type: string calculation_description: type: string required: - accessorial - calculation_description type: object Address: properties: address_1: type: string address_2: type: string city: type: string country: type: string created_at: format: date-time type: string formatted_address: type: string id: format: uuid type: string latitude: format: float type: number longitude: format: float type: number phone_number: type: string postal_code: type: string state_province: type: string timezone: type: string updated_at: format: date-time type: string type: object AddressBookEntry: properties: accessorials: items: $ref: '#/components/schemas/Accessorial' type: array address: $ref: '#/components/schemas/Address' company_name: type: string created_at: format: date-time type: string custom_data: $ref: '#/components/schemas/LocationCustomData' default_appointment_type: $ref: '#/components/schemas/AppointmentType' dock_external_id: type: string dock_hours_end: format: time type: string dock_hours_start: format: time type: string external_reference: type: string id: format: uuid type: string is_default_origin: type: boolean location_name: type: string location_type: $ref: '#/components/schemas/LocationType' notes: type: string point_of_contacts: items: $ref: '#/components/schemas/PointOfContact' type: array updated_at: format: date-time type: string required: - address - is_default_origin - location_name type: object AlertDashboardSlimShipment: properties: additional_bol_recipients: description: Additional email address to send the BOL to upon booking items: type: string type: array alert_types: items: enum: - LATE_PICKUP - LATE_DELIVERY - RUNNING_LATE - CARRIER_NOT_ASSIGNED - NOT_TRACKING - INACTIVE_CARRIER - TAGGED_SHIPMENT - WATCHED_SHIPMENT type: string type: array current_address: $ref: '#/components/schemas/CurrentShipmentAddress' customer: $ref: '#/components/schemas/SlimCompany' documents_count: type: integer id: format: uuid type: string is_watched: type: boolean line_items: items: $ref: '#/components/schemas/SlimShipmentLineItem' type: array messages_count: type: integer metadata: $ref: '#/components/schemas/ShipmentMetadata' next_planned_stop_id: format: uuid type: string notes_count: type: integer reference_id: format: uuid type: string relationship_to_vendor: $ref: '#/components/schemas/CarrierStatusCarrierAssignment' state: enum: - appointment_pending - at_pickup - at_delivery - auction_running - cancelled - carrier_confirmed - delayed - delivered - dispatched - draft - in_transit - out_for_delivery - quote_accepted - quoting - reconciled - scheduled - tendered type: string stops: items: $ref: '#/components/schemas/Stop' type: array tracking_type: type: string updated_at: format: date-time type: string type: object AlertsDashBoardConfiguration: properties: company: format: uuid type: string created_at: format: date-time type: string enabled: type: boolean id: format: uuid type: string manual_resolve: type: boolean name: type: string threshold: additionalProperties: {} type: object type: enum: - LATE_PICKUP - LATE_DELIVERY - RUNNING_LATE - CARRIER_NOT_ASSIGNED - NOT_TRACKING - INACTIVE_CARRIER - TAGGED_SHIPMENT - WATCHED_SHIPMENT type: string updated_at: format: date-time type: string required: - type - name - threshold - enabled - manual_resolve type: object AlertsDashBoardConfigurationOptions: properties: description: type: string resolve_description: type: string short_description: type: string threshold_definition: properties: description: type: string max: type: integer min: type: integer type: enum: - COUNTER - TAG type: string type: object title: type: string type: enum: - LATE_PICKUP - LATE_DELIVERY - RUNNING_LATE - CARRIER_NOT_ASSIGNED - NOT_TRACKING - INACTIVE_CARRIER - TAGGED_SHIPMENT - WATCHED_SHIPMENT type: string unique: type: boolean type: object ApiKey: properties: company: type: string created_at: format: date-time type: string expires_at: format: date-time type: string is_active: type: boolean key: type: string name: type: string shipments_delete: type: boolean shipments_dispatching: type: boolean shipments_quoting: type: boolean shipments_read: type: boolean shipments_tracking: type: boolean shipments_write: type: boolean type: object AppointmentType: properties: code: type: string id: format: int32 type: integer name: type: string required: - id - code - name type: object AssetsAccessBody: properties: eld_selection: type: string required: - eld_selection type: object AutomatedVendorProfile: description: Summary of a vendor that has some sort of automation enabled properties: company: $ref: '#/components/schemas/Company' has_dispatch: type: boolean has_imaging: type: boolean has_rating: type: boolean has_tracking: type: boolean has_vltl_specific_dispatch: type: boolean has_volume_rating: type: boolean required: - has_rating - has_dispatch - has_tracking - has_imaging - has_volume_rating - has_vltl_specific_dispatch - company type: object AutomationEvent: description: Event which was automatically done by the shipwell system properties: answered_by_machine: type: boolean completed_at: format: date-time type: string conversation_status: enum: - busy - canceled - completed - failed - in-progress - no-answer - queued - ringing type: string created_at: format: date-time type: string estimated_eta: format: date-time type: string estimated_location_name: type: string id: format: uuid type: string parsed_message: type: string recorded_audio: description: URL to an mp3 file holding recorded audio of the conversation of the event, if exists type: string response_message: type: string resulting_alert_level: enum: - HIGH - MEDIUM - LOW type: string scheduled_by_user: $ref: '#/components/schemas/User' scheduled_for: format: date-time type: string shipment: format: uuid type: string source: enum: - CALL - TEXT - EMAIL type: string sub_type: enum: - LOCATION_CHECK_IN - PRE_PICKUP type: string timeline_ordering_timestamp: description: 'Timestamp used in the default ordering of events. Will use completed_at if it is not null, otherwise will fall back on scheduled_for. ' format: date-time type: string type: enum: - CALL - TEXT - EMAIL type: string updated_at: format: date-time type: string required: - scheduled_for - source - type - sub_type type: object AutomationEventSubType: enum: - LOCATION_CHECK_IN - PRE_PICKUP type: string AwardDeclineQuoteRequest: properties: award: type: boolean required: - award type: object BaseCarrierRelationship: properties: bill_to_vendor_by_default: description: 'Whether or not the vendor requests that they be assigned as the bill-to party when they get tendered loads. Setting is read-only, and will not be present when this object is part of a list. ' type: boolean carrier_direct_integration_profile: properties: company: format: uuid type: string provider_code: type: string type: object carrier_owner: $ref: '#/components/schemas/User' carrier_reference_codes: items: $ref: '#/components/schemas/CarrierReferenceCode' type: array carrier_status: enum: - ACTIVE - INACTIVE - DO_NOT_USE type: string carrier_status_last_updated: format: date-time type: string carrier_status_updated_by: $ref: '#/components/schemas/SlimUser' created_at: format: date-time type: string exclude_from_automated_carrier_status: type: boolean external_payment_processor_id: format: uuid type: string external_payment_processor_sync_status: enum: - CURRENT - SYNC_ERROR type: string fmcsa_census_data: $ref: '#/components/schemas/FmcsaCensusData' fmcsa_vendor: $ref: '#/components/schemas/Company' id: format: uuid type: string is_editable: type: boolean notes: type: string point_of_contacts: items: $ref: '#/components/schemas/CarrierPointOfContact' type: array shipwell_vendor: $ref: '#/components/schemas/Company' tags: items: $ref: '#/components/schemas/CarrierTag' type: array updated_at: format: date-time type: string vendor_factoring_company: $ref: '#/components/schemas/VendorFactoringCompany' required: - vendor type: object BasePointOfContact: properties: created_at: format: date-time type: string email: type: string first_name: type: string id: format: uuid type: string job_title: type: string last_name: type: string phone_number: type: string updated_at: format: date-time type: string required: - first_name type: object BaseProductDescription: properties: country_of_manufacture: example: US type: string description: type: string freight_class: enum: - '50' - '55' - '60' - '65' - '70' - '77.5' - '85' - '92.5' - '100' - '110' - '125' - '150' - '175' - '200' - '250' - '300' - '400' - '500' type: string hazmat_hazard_class: type: string hazmat_identification_number: type: string hazmat_packing_group: enum: - I - II - III type: string hazmat_proper_shipping_name: type: string height: format: float type: number id: format: uuid type: string length: format: float type: number length_unit: enum: - CM - IN type: string nmfc_item_code: type: string nmfc_sub_code: type: string package_type: enum: - BAG - BALE - BOX - BUCKET - BUNDLE - CAN - CARTON - CASE - COIL - CRATE - CYLINDER - DRUM - FLOOR_LOADED - PAIL - PACKAGE - PIECES - PKG - PLT - REEL - ROLL - SKID - TUBE type: string package_weight: format: float type: number piece_type: enum: - BAG - BALE - BOX - BUCKET - BUNDLE - CAN - CARTON - CASE - COIL - CRATE - CYLINDER - DRUM - PAIL - PACKAGE - PIECES - REEL - ROLL - SKID - TUBE type: string product_ref: type: string provider_specific_packaging: description: Provider-specific type of packaging used for the product type: string refrigeration_max_temp: format: float type: number refrigeration_min_temp: format: float type: number refrigeration_required: type: boolean stackable: type: boolean temp_unit: enum: - F - C type: string value_per_piece: format: float type: number value_per_piece_currency: enum: - CAD - USD type: string weight_unit: enum: - KG - LB type: string width: format: float type: number type: object BaseShipment: properties: accessorials: items: $ref: '#/components/schemas/Accessorial' type: array additional_bol_recipients: description: Additional email address to send the BOL to upon booking items: type: string type: array auction_stats: properties: declined_quotes: type: integer lowest_bid: format: float type: number messages: type: integer most_recent_quote_created_at: format: date-time type: string negotiations: type: integer quotes: type: integer visible_companies: type: integer title: AuctionStats type: object bol_number: type: string cancellation_reason: type: string capacity_provider_customer_reference_number: description: Customer reference number that came back from the capacity provider type: string created_at: format: date-time type: string created_by_source: enum: - MAGENTO - SHIPWELL_WEB - SHOPIFY - IMPORT - TENDER - SHIPWELL_WEB_UNAUTH type: string created_by_user: $ref: '#/components/schemas/SlimUser' current_address: $ref: '#/components/schemas/CurrentShipmentAddress' custom_data: $ref: '#/components/schemas/ShipmentCustomData' customer: $ref: '#/components/schemas/SlimCompany' customer_reference_number: type: string delayed: type: boolean description: type: string documents_count: type: integer drayage_booking_number: type: string drayage_chassis_number: type: string drayage_container_number: type: string drayage_container_return_date: type: string drayage_estimated_arrival_date: type: string drayage_last_free_date: type: string drayage_release_date: type: string drayage_seal_number: type: string equipment_config: $ref: '#/components/schemas/EquipmentConfig' equipment_type: $ref: '#/components/schemas/EquipmentType' est_trip_miles: format: float type: number external_tracking_link: type: string final_trip_miles: format: float type: number group_id: type: string id: format: uuid type: string is_watched: type: boolean line_items: items: $ref: '#/components/schemas/ShipmentLineItem' type: array marked_as_paid_by_user: format: uuid type: string markup: format: float type: number messages_count: type: integer metadata: $ref: '#/components/schemas/ShipmentMetadata' mode: $ref: '#/components/schemas/ShipmentMode' name: type: string next_planned_stop_id: format: uuid type: string notes_count: type: integer notes_for_carrier: type: string parcel_pickup_status: enum: - CANCELLED - DELAYED - DELIVERED - IN_TRANSIT - NOT_SCHEDULED - SCHEDULED type: string pickup_number: type: string preferred_currency: type: string pro_number: type: string purchase_order_number: type: string reference_id: type: string relationship_to_customer: $ref: '#/components/schemas/CarrierAssignment' relationship_to_vendor: $ref: '#/components/schemas/CarrierStatusCarrierAssignment' reps: description: 'Representatives for the Shipment from within the requesting user''s own company ' items: $ref: '#/components/schemas/ShipmentRep' type: array rfqs: description: 'All RFQs this Shipment has run, slimmed down to exclude their quotes ' items: $ref: '#/components/schemas/SlimRFQ' type: array service_level: $ref: '#/components/schemas/ServiceLevel' shipment_pickup: format: uuid type: string significantly_modified_at: description: Not implemented format: date-time type: string state: enum: - appointment_pending - at_pickup - at_delivery - auction_running - cancelled - carrier_confirmed - delayed - delivered - dispatched - draft - in_transit - out_for_delivery - quote_accepted - quoting - reconciled - scheduled - tendered type: string stops: items: $ref: '#/components/schemas/Stop' type: array temperature_lower_limit: format: float type: number temperature_upper_limit: format: float type: number timeline_events: items: $ref: '#/components/schemas/ShipmentTimelineEvent' type: array timeline_last_updated_at: format: date-time type: string total_declared_value: format: float type: number total_declared_value_currency: enum: - CAD - USD type: string total_linear_feet: format: int32 type: integer total_miles: format: float type: number total_weight_override: $ref: '#/components/schemas/TotalWeightOverride' tracking_number: type: string trailer_name: type: string updated_at: format: date-time type: string version: enum: - 1 - 2 type: integer required: - id type: object Bill: properties: balance: description: Current balance of the bill format: float type: number bill_number: description: Reference to the bill in the external FMS, defaults to the Shipment reference number if left blank type: string created_at: format: date-time readOnly: true type: string custom_data: additionalProperties: {} description: Custom data for a bill title: BillCustomData type: object x-is-free-form: false documents: items: properties: content_object: $ref: '#/components/schemas/ShipmentDocumentMetadata' content_type: enum: - shipment document type: string type: object readOnly: true type: array due_date: description: When this bill is due format: date type: string error_description: description: If an error occurred during processing, this field will be set type: string id: readOnly: true type: string line_items: items: $ref: '#/components/schemas/BillLineItem' minItems: 1 type: array payment_status: description: Readable description of a non-zero balance enum: - Due in {Number of days} days - Overdue by {Number of days} days - Paid processing_status: description: The status of the processing the bill with the third party system enum: - PROCESSING - SUCCESS - ERROR readOnly: true remit_to: $ref: '#/components/schemas/BillRemitTo' shipment: properties: bol_number: type: string id: format: uuid type: string name: type: string pro_number: type: string purchase_order_number: type: string reference_id: type: string readOnly: true type: object total_amount: description: How much the bill is worth, the summation of all of the line items format: float type: number transaction_date: description: When the transaction occurred that generated the bill format: date type: string transaction_number: description: Always a generated field of the transaction field from the financial management system type: string updated_at: format: date-time readOnly: true type: string type: object BillLineItem: properties: amount: description: 'Effective amount of the line item, or unit_amount times quantity minus prepaid_amount ' format: float type: number category: description: Categorization of the item, e.g. LH for Line Haul type: string custom_data: additionalProperties: {} description: Custom data for a bill line item title: BillLineItemCustomData type: object x-is-free-form: false description: description: If not specified, defaults to the shipment reference id type: string id: readOnly: true type: string prepaid_amount: format: float type: number unit_amount: format: float type: number unit_quantity: format: float type: number required: - unit_amount - unit_quantity - category type: object BillRemitTo: description: Where the bill needs to be paid to properties: created_at: format: date-time readOnly: true type: string id: format: uuid readOnly: true type: string relationship: description: 'If SELF, carrier will be remit_to person. If FACTOR_COMPANY and remit_to_info has id of existing carrier factoring, the factoring company will be the remit_to. If FACTOR_COMPANY and remit_to_info does not have an id of an existing carrier factoring company, a new factor company will be created and added as remit_to. If FACTOR_COMPANY and no remit_to_info, the vendor_factoring_company on carrier relationship will be the remit_to. Otherwise carrier will be set as remit_to. ' enum: - SELF - FACTOR_COMPANY type: string remit_to_info: properties: address: $ref: '#/components/schemas/Address' company_name: type: string created_at: format: date-time readOnly: true type: string email: format: email type: string id: format: uuid readOnly: true type: string updated_at: format: date-time readOnly: true type: string type: object updated_at: format: date-time readOnly: true type: string type: object BillToOverride: description: 'Collection of bill-to information that will render on Shipment documents ' properties: company_address: type: string company_name: type: string contact_email: type: string contact_phone: type: string created_at: format: date-time type: string direction: enum: - PREPAID - COLLECT - 3RD_PARTY type: string id: format: uuid type: string updated_at: format: date-time type: string required: - company_address - company_name - contact_email - contact_phone - direction type: object Brokerage: properties: billing_address: $ref: '#/components/schemas/Address' created_at: format: date-time type: string dba_name: type: string id: format: uuid type: string is_3pl: description: 'True if the Brokerage is actually a 3PL ' type: boolean mailing_address: $ref: '#/components/schemas/Address' primary_email: type: string primary_phone_number: type: string updated_at: format: date-time type: string type: object BulkCreateSpotNegotiationRequest: properties: additional_customer_users: items: format: uuid type: string type: array message: type: string solicited_users: items: format: uuid type: string type: array special_instructions: type: string required: - additional_customer_users - solicited_users type: object BulkPrintLabelsRequest: items: properties: shipment: format: uuid type: string required: - shipment type: object type: array BulkPrintLabelsResponse: properties: batch_document: type: string labels: items: properties: id: format: uuid type: string label: $ref: '#/components/schemas/ShipmentDocumentMetadata' required: - id type: object type: array type: object BuyItNow: properties: equipment_type: type: integer mode: type: integer type: object CHRobinsonAccountRequest: properties: customer_code: type: string required: - customer_code type: object CHRobinsonAccountResponse: properties: customer_code: type: string id: format: uuid type: string required: - customer_code type: object CallLogRead: allOf: - $ref: '#/components/schemas/CallLogWrite' - properties: created_at: format: date-time type: string id: format: uuid type: string updated_at: format: date-time type: string user: $ref: '#/components/schemas/SlimUser' required: - recommendation_id - shipment - quote_amount - notes - created_at - updated_at - user - id type: object CallLogShipmentSummary: properties: highest_bid_logged: format: float type: number lowest_bid_logged: format: float type: number most_recent_bid_amount_logged: format: float type: number most_recent_time_logged: format: date-time type: string most_recent_user_logged: format: uuid type: string number_of_calls_logged: format: float type: number recommendation_id: format: uuid type: string required: - recommendation_id - lowest_bid_logged - highest_bid_logged - number_of_calls_logged type: object CallLogWrite: properties: notes: type: string quote_amount: maximum: 1000000000 minimum: 0 type: number recommendation_id: format: uuid type: string shipment: format: uuid type: string required: - recommendation_id - shipment - notes type: object Carrier: properties: accounts_receivable_email: type: string approved_at: format: date-time type: string billing_address: $ref: '#/components/schemas/Address' created_at: format: date-time type: string custom_data: $ref: '#/components/schemas/CarrierCustomData' dba_name: type: string display_name: description: 'Read-only name of the Carrier which will be its dba_name if one exists, else the Carrier''s Company''s name ' type: string display_primary_email: description: 'Read-only email of the Carrier which will be its email if one exists, else the Carrier''s Company''s email ' type: string display_primary_phone_number: description: 'Read-only phone number of the Carrier which will be its phone number if one exists, else the Carrier''s Company''s phone number ' type: string eld_providers: items: $ref: '#/components/schemas/CarrierELDProvider' type: array id: format: uuid type: string mailing_address: $ref: '#/components/schemas/Address' pickup_request_email: type: string primary_email: type: string primary_phone_number: type: string service_center_lookup_url: type: string updated_at: format: date-time type: string usdot_number: type: string type: object CarrierAssignment: properties: carrier_reference_code: type: string created_at: format: date-time type: string customer: $ref: '#/components/schemas/Company' customer_charge_line_items: description: 'Costs owed to vendor as the customer records them, readable by both customer and vendor but writable only by the customer ' items: $ref: '#/components/schemas/ShipmentChargeLineItem' type: array id: format: uuid type: string is_assigned_carrier: type: boolean updated_at: format: date-time type: string vendor: $ref: '#/components/schemas/Company' vendor_charge_line_items: description: 'Costs owed to vendor as the vendor records them, readable by both customer and vendor but writable only by the vendor ' items: $ref: '#/components/schemas/ShipmentChargeLineItem' type: array vendor_point_of_contact: format: uuid type: string required: - vendor - charge_line_items type: object CarrierBid: properties: available_date: format: date type: string available_time: format: time type: string bid_amount: format: float type: number bid_amount_currency: type: string carrier_name: type: string carrier_relationship: format: uuid type: string contact_email: type: string contact_first_name: type: string contact_last_name: type: string contact_phone_number: type: string created_at: format: date-time type: string created_by_company: format: uuid type: string created_by_user: format: uuid type: string created_by_user_full_name: type: string current_location: $ref: '#/components/schemas/Address' distance_from_pickup_miles: type: integer equipment_type: type: integer id: format: uuid type: string mc_number: type: string notes: type: string shipment: format: uuid type: string updated_at: format: date-time type: string usdot_number: type: string type: object CarrierBiddingSummaryShipment: properties: customer_name: type: string customer_rate: format: float type: number dropoff_address: $ref: '#/components/schemas/Address' dropoff_city_state: type: string dropoff_datetime: format: date-time type: string estimated_revenue: format: float type: number load_board_id: type: string lowest_bid: format: float type: number max_buy_amount: format: float type: number number_of_bids: type: integer pickup_address: $ref: '#/components/schemas/Address' pickup_city_state: type: string pickup_datetime: format: date-time type: string reference_id: type: string shipment_id: format: uuid type: string type: object CarrierConfig: properties: driver: $ref: '#/components/schemas/Driver' equipment_type: $ref: '#/components/schemas/EquipmentType' mode: $ref: '#/components/schemas/ShipmentMode' notes_for_carrier: type: string power_unit_name: type: string service_level: $ref: '#/components/schemas/ServiceLevel' temperature_lower_limit: format: float type: number temperature_upper_limit: format: float type: number total_miles: format: float type: number trailer_name: type: string vendor: $ref: '#/components/schemas/Company' vendor_point_of_contact: $ref: '#/components/schemas/CarrierPointOfContact' type: object CarrierCustomData: additionalProperties: {} description: Custom data for CarrierCustomData type: object x-is-free-form: false CarrierELDProvider: properties: id: format: uuid type: string name: type: string status: enum: - Active - Inactive type: string type: object CarrierPocTag: properties: created_at: format: date-time type: string id: format: uuid type: string name: type: string updated_at: format: date-time type: string required: - name type: object CarrierPointOfContact: allOf: - $ref: '#/components/schemas/PointOfContact' - properties: job_title: enum: - ADMIN - BILLING - OWNER_OPERATOR - DRIVER - DISPATCHER - OTHER type: string should_send_email: type: boolean required: - job_title type: object CarrierPrioritizationRecommendation: properties: area_code_matched_dest: description: True if carrier phone area code has overlap with pickup location type: boolean area_code_matched_origin: description: True if carrier phone area code has overlap with pickup location type: boolean carrier_city: description: Carrier HQ city type: string carrier_name: description: Name of carrier type: string carrier_phone: description: Contact phone information of carrier type: string carrier_state: description: Carrier HQ state type: string closest_driver_dist: description: Distance of closest asset of carrier from pickup (miles) type: number count_SW_lane_shipments: description: Number of times carrier covered this lane for SW type: number count_SW_shipments: description: Number of times carrier covered ANY lane for SW type: number dest_carrier_latlong_dist: description: Distance of carrier HQ from dropoff (miles) type: number num_drivers_close: description: Number of assets of carrier within a specified radius of pickup type: number num_trucks: description: Total number of assets carrier owns type: integer orig_carrier_latlong_dist: description: Distance of carrier HQ from pickup (miles) type: number required: - carrier_name - carrier_phone type: object CarrierReferenceCode: properties: is_default: type: boolean value: type: string required: - value type: object CarrierRelationship: allOf: - $ref: '#/components/schemas/BaseCarrierRelationship' - properties: rmis_carrier_profiles: items: $ref: '#/components/schemas/SlimRMISCarrier' type: array saferwatch_carrier_profiles: items: $ref: '#/components/schemas/SlimSaferWatchCarrier' type: array type: object CarrierSpecificShipperRelationship: properties: company: $ref: '#/components/schemas/Company' created_at: format: date-time type: string id: format: uuid type: string is_hidden: type: boolean is_modified: type: boolean markup: $ref: '#/components/schemas/Markup' shipper_relationship: format: uuid type: string updated_at: format: date-time type: string type: object CarrierStatus: enum: - ACTIVE - INACTIVE - DO_NOT_USE type: string CarrierStatusCarrierAssignment: allOf: - $ref: '#/components/schemas/CarrierAssignment' - properties: carrier_status: enum: - ACTIVE - INACTIVE - DO_NOT_USE type: string freight_authority_vendor_relationship: format: uuid type: string type: object CarrierTag: properties: created_at: format: date-time type: string id: format: uuid type: string name: type: string updated_at: format: date-time type: string required: - name type: object CaseNote: properties: case: format: uuid type: string created_at: format: date-time type: string created_by_user: $ref: '#/components/schemas/User' id: format: uuid type: string note: type: string updated_at: format: date-time type: string required: - note type: object ChargeCategory: enum: - ACC - ADJUSTMENT - DETENTION - FSC - FUEL - INSURANCE - LAYOVER - LH - OTHER - SF - TAX - TEAMDRIVERS - TONU - VARIANCE type: string ChargeCode: description: Standardized code for a type of line item charge properties: code: type: string description: type: string id: format: int32 type: integer type: object ChargeLineItemCategory: description: Categorization option for charge line items properties: id: type: string name: type: string required: - id - name type: object Company: allOf: - $ref: '#/components/schemas/SlimCompany' - properties: billing_address: $ref: '#/components/schemas/Address' brokerage: $ref: '#/components/schemas/Brokerage' carrier: $ref: '#/components/schemas/Carrier' custom_data: $ref: '#/components/schemas/CompanyCustomData' feature_flags: $ref: '#/components/schemas/FeatureFlags' identifying_codes: items: $ref: '#/components/schemas/IdentifyingCode' type: array insurance_expires_at: format: date-time type: string insurance_policy_number: type: string insurance_provider_name: type: string insurance_provider_phone: type: string insurance_validated_at: format: date-time type: string mailing_address: $ref: '#/components/schemas/Address' primary_phone_number: type: string shipper: $ref: '#/components/schemas/Shipper' subdomain: type: string type: object required: - primary_phone_number - primary_email type: object CompanyCustomData: additionalProperties: {} description: Custom data for CompanyCustomData type: object x-is-free-form: false CompanyLogo: description: The set of logos associated with a company. Use the image_type param to filter by type properties: company_name: type: string id: format: uuid type: string image_type: enum: - LOGO_COLOR - LOGO_WHITE - INLINE_COLOR - INLINE_WHITE type: string logo: type: string required: - logo type: object CompanyPreferences: description: Preferences associated with a company properties: auto_archive_shipment_days: format: int32 type: integer auto_archive_shipment_states: enum: - appointment_pending - at_pickup - at_delivery - auction_running - cancelled - carrier_confirmed - delayed - delivered - dispatched - draft - in_transit - out_for_delivery - quote_accepted - quoting - reconciled - scheduled - tendered type: string automated_check_calling_enabled: type: boolean billing_instructions: type: string country: enum: - US - CA type: string custom_carrier_invoicing_instructions: type: string default_carrier_status: enum: - ACTIVE - INACTIVE - DO_NOT_USE type: string rate_confirmation_terms: type: string send_bol_to_vendor: type: boolean send_rate_confirmation_to_vendor: type: boolean use_custom_carrier_invoicing_instructions: type: boolean type: object CompanyWithOptionalUsers: allOf: - $ref: '#/components/schemas/Company' - properties: users: description: 'List of slim users at the company. Only present if expandUsers parameter is allowed in the API route and set to True. ' items: $ref: '#/components/schemas/User' type: array type: object type: object Contract: properties: additional_stop_charge_flat_fee: format: float type: number additional_stop_charge_flat_fee_currency: default: USD enum: - CAD - USD type: string additional_stop_charge_per_mile: format: float type: number additional_stop_charge_per_mile_currency: default: USD enum: - CAD - USD type: string carrier_name: type: string carrier_relationship: format: uuid type: string created_at: format: date-time type: string destinations: items: $ref: '#/components/schemas/Address' type: array distance_estimation_system: type: string distance_miles: type: integer documents: items: $ref: '#/components/schemas/DocumentMetadata' type: array end_date: format: date type: string equipment_types: items: $ref: '#/components/schemas/EquipmentType' type: array external_id: type: string fuel_included: type: boolean id: format: uuid type: string minimum_rate: format: float type: number minimum_rate_currency: default: USD enum: - CAD - USD type: string modes: items: $ref: '#/components/schemas/ShipmentMode' type: array name: type: string notes: type: string origins: items: $ref: '#/components/schemas/Address' type: array rate: format: float type: number rate_currency: default: USD enum: - CAD - USD type: string rate_type: enum: - PER_MILE - FLAT_RATE type: string service_level_agreement: format: uuid type: string service_level_agreement_name: type: string start_date: format: date type: string status: enum: - ACTIVE - PAUSED - SUSPENDED - EXPIRED type: string updated_at: format: date-time type: string required: - name type: object ContractRateTypes: enum: - PER_MILE - FLAT_RATE type: string ContractStatuses: enum: - ACTIVE - PAUSED - SUSPENDED - EXPIRED type: string CrFeedback: allOf: - $ref: '#/components/schemas/CrFeedbackCreate' - properties: id: format: uuid type: string user_id: format: uuid type: string type: object CrFeedbackCreate: properties: comments: type: string recommendation_id: format: uuid type: string type: enum: - good - bad_for_shipment - should_never_recommend type: string type: object CrFieldErrorsResponse: properties: field_errors: additionalProperties: items: type: string type: array type: object non_field_errors: items: type: string type: array type: object CrRecommendationResponse: properties: carrier_city: description: Carrier HQ city type: string carrier_name: description: Name of carrier type: string carrier_phone: description: Contact phone information of carrier type: string carrier_state: description: Carrier HQ state type: string closest_driver_distance: description: Distance of closest asset of carrier from pickup (miles) type: number destination_area_code_matched: description: True if carrier phone area code has overlap with pickup location type: boolean destination_carrier_distance: description: Distance of carrier HQ from dropoff (miles) type: number external_shipment_id: description: External id of shipment assocaited with. format: uuid type: string id: description: id of this recommendation format: uuid type: string number_of_drivers_close: description: Number of assets of carrier within a specified radius of pickup type: number number_of_trucks: description: Total number of assets carrier owns type: integer origin_area_code_matched: description: True if carrier phone area code has overlap with pickup location type: boolean origin_carrier_distance: description: Distance of carrier HQ from pickup (miles) type: number recommendation_score: description: rating of this recommendation. On a scale of 0-5 type: number shipwell_lane_shipments_count: description: Number of times carrier covered this lane for SW type: number shipwell_shipments_count: description: Number of times carrier covered ANY lane for SW type: number required: - external_shipment_id - carrier_name - carrier_phone type: object CrRecommendationShipment: properties: dropoff_city: type: string dropoff_lat: maximum: 90 minimum: -90 type: number dropoff_long: maximum: 180 minimum: -180 type: number dropoff_state: description: Two letter abreviation of dropoff state maxLength: 2 minLength: 2 type: string equipment_type: description: Type of equipment required. enum: - AUTO_CARRIER - AUTOHAULER - B_TRAIN - BULK - CONESTOGA - CONTAINER - CONTAINER_BREAK_BULK - CONTAINER_STANDARD_20_FOOT - CONTAINER_STANDARD_40_FOOT - CONTAINER_FLAT_TRACK_20_FOOT - CONTAINER_FLAT_TRACK_40_FOOT - CONTAINER_HEAVY_TESTED_20_FOOT - CONTAINER_HIGH_CUBE_40_FOOT - CONTAINER_HIGH_CUBE_45_FOOT - CONTAINER_INSULATED - CONTAINER_ISO_TANK_20_FOOT - CONTAINER_ISO_TANK_24_FOOT - CONTAINER_ISO_TANK_40_FOOT - CONTAINER_OPEN_TOP_20_FOOT - CONTAINER_OPEN_TOP_40_FOOT - CONTAINER_REEFER_20_FOOT - CONTAINER_REEFER_40_FOOT - CONTAINER_REFRIGERATED - CONVEYOR - CURTAIN_SIDE - DOUBLE_DROP - DROP_DECK - DROP_DECK_LANDOLL - DRY_VAN - DUMP_TRAILER - FLATBED - FLATBED_53_FOOT - FLATBED_AIR_RIDE - FLATBED_CONESTOGA - FLATBED_DOUBLE - FLATBED_HOTSHOT - FLATBED_MAXI - FLATBED_OVERDIMENSION - HOPPER - HOPPER_BOTTOM - INSULATED_VAN - LOWBOY - LOWBOY_OVERDIMENSION - MOVING_VAN - OTHER - PNEUMATIC - POWER_ONLY - REEFER - REEFER_AIR_RIDE - REEFER_DOUBLE - REEFER_INTERMODAL - REMOVABLE_GOOSENECK - STEP_DECK - STEPDECK_CONESTOGA - STRAIGHT_BOX_TRUCK - STRETCH_TRAILER - TANKER - TANKER_ALUMINUM - TANKER_INTERMODAL - TANKER_STEEL - TILT - TRUCK_AND_TRAILER - VAN_AIR_RIDE - VAN_DOUBLE - VAN_INSULATED - VAN_INTERMODAL - VAN_OPEN_TOP - VAN_ROLLER_BED - VAN_SPRINTER - VAN_TRIPLE - VAN_VENTED - VAN_WITH_CURTAINS type: string external_shipment_id: description: Shipment id in external system. format: uuid type: string pickup_city: type: string pickup_lat: maximum: 90 minimum: -90 type: number pickup_long: maximum: 180 minimum: -180 type: number pickup_state: description: Two letter abreviation of pickup state maxLength: 2 minLength: 2 type: string pickup_time: description: Pickup time in ISO-8601 (yyyy-mm-ddThh:mm:ss.sssss+tz.info) type: string required: - external_shipment_id - equipment_type - dropoff_city - dropoff_state - dropoff_lat - dropoff_long - pickup_city - pickup_state - pickup_lat - pickup_long - pickup_time type: object CrRecommendationShipmentResponse: allOf: - $ref: '#/components/schemas/CrRecommendationShipment' - properties: id: description: id of RecommendationShipment created on server. format: uuid type: string recommendations: items: $ref: '#/components/schemas/CrRecommendationResponse' type: array required: - id - recommendations type: object CreateCompanyRequestBody: properties: company: $ref: '#/components/schemas/Company' driver: $ref: '#/components/schemas/DriverLogin' signup_brokerage_subdomain: description: If signing up a new shipper, set the brokers subdomain here to automatically create an inactive broker-shipper relationship type: string user: $ref: '#/components/schemas/User' required: - company - user type: object CreateEquipmentConfig: properties: carrier: format: uuid type: string created_at: format: date-time type: string driver: $ref: '#/components/schemas/Driver' driver_pin: format: int32 type: integer id: format: uuid type: string power_unit: format: uuid type: string power_unit_name: type: string trailer: format: uuid type: string trailer_name: type: string updated_at: type: string type: object CreateQuote: allOf: - $ref: '#/components/schemas/Quote' - properties: carrier: description: 'Id of the carrier for this quote. A carrier should always be provided when the requester''s company would in fact be the carrier for the shipment. ' format: uuid type: string equipment_type: description: Id of the EquipmentType for this quote format: int32 type: integer mode: description: Id of the ShipmentMode for this quote format: int32 type: integer service_level: description: Id of the ServiceLevel for this quote format: int32 type: integer description: Request body used to create a Quote type: object CreateShipmentTimelineEvent: allOf: - $ref: '#/components/schemas/ShipmentTimelineEvent' - properties: actor: description: 'ID of the User who took the action described in the event ' format: uuid type: string type: object type: object CreateShipperRelationship: allOf: - $ref: '#/components/schemas/ShipperRelationship' - properties: user: $ref: '#/components/schemas/User' type: object required: - user type: object CreateSpotNegotiationQuote: allOf: - $ref: '#/components/schemas/CreateQuote' - properties: message: description: Message to include in quote created email type: string description: Request body used to create a quote type: object CurrencyCode: enum: - CAD - USD type: string CurrentShipmentAddress: allOf: - $ref: '#/components/schemas/Address' - properties: reported_at: description: Time when the shipment was at the address format: date-time type: string type: object type: object CustomField: description: Custom Field configuration properties: allowed_values: items: $ref: '#/components/schemas/CustomFieldAllowedValue' type: array company: format: uuid type: string created_at: format: date-time type: string default_value: type: string display_order: format: int32 type: integer entity_types: items: enum: - purchase_order - purchase_order_line_item - purchase_order_stop - shipment - shipment_line_item - shipment_stop type: string type: array field_type: enum: - STRING - BOOLEAN - DATETIME - SELECTION type: string id: format: uuid type: string label: type: string name: type: string required: type: boolean updated_at: format: date-time type: string required: - entity_type - name - label - field_type - display_order type: object CustomFieldAllowedValue: description: Allowed values for the Custom Field Selection field type properties: created_at: format: date-time type: string id: format: uuid type: string label: type: string updated_at: format: date-time type: string value: type: string required: - label - value type: object CustomerCustomData: additionalProperties: {} description: Custom data for ShipperRelationship type: object x-is-free-form: false Dashboard: description: Statistics for the dashboard page properties: delayed: format: int32 type: integer delivery: format: int32 type: integer scheduled: format: int32 type: integer transit: format: int32 type: integer type: object DataDocksAppointment: description: Appointment info coming from DataDocks properties: appointment_number: format: int32 type: integer booking_information: $ref: '#/components/schemas/DataDocksBookingInformation' has_scheduled_times: description: If true, this appointment has all in/out times scheduled type: boolean purchase_orders: items: type: string type: array status: enum: - booked - cancelled - drop - late - needs_time - no_show - pending - unscheduled type: string type_of_shipment: enum: - inbound - other - outbound type: string type: object DataDocksBookingInformation: description: Booking window for a DataDocks event properties: time_in: format: date-time type: string time_out: format: date-time type: string type: object DataDocksStopAppointment: properties: appointment: $ref: '#/components/schemas/DataDocksAppointment' stop: description: Id of the stop that may have an appointment type: string type: object DataImport: description: Imports created by a company properties: created_at: format: date-time type: string csv_file: type: string error: type: string google_sheet_id: type: string google_sheet_tab: type: string id: format: uuid type: string is_complete: type: boolean name: type: string total_rows: format: int32 type: integer type: type: string updated_at: format: date-time type: string required: - type type: object DataImportError: description: Errors for a given import row or value properties: errors: type: string row: format: uuid type: string value: $ref: '#/components/schemas/ImportValue' type: object Device: properties: id: format: uuid type: string platform: enum: - iOS - ANDROID type: string token: type: string type: object DocumentAuditlog: description: Auditlog for documents sent on a shipment items: properties: emails: items: properties: replyto_email: type: string status: type: string to_email: type: string updated_at: format: date-time type: string type: object type: array file: type: string filename: type: string id: format: uuid type: string type: object type: array DocumentMetadata: description: Metadata about a document properties: created_at: format: date-time type: string created_by_id: format: uuid type: string created_by_name: type: string description: type: string file: type: string filename: type: string id: format: uuid type: string updated_at: format: date-time type: string type: object DocumentType: description: Enumeration of the currently supported document types properties: id: type: string name: type: string required: - id - name type: object Driver: properties: app_last_opened_at: format: date-time type: string cdl_number: type: string cdl_state: type: string company_id: format: uuid type: string created_at: format: date-time type: string email: type: string first_name: type: string hos: $ref: '#/components/schemas/DriverHOS' id: format: uuid type: string last_name: type: string phone_number: type: string pin: format: int32 type: integer platform: enum: - iOS - ANDROID type: string provider: type: string status: type: string updated_at: format: date-time type: string user: $ref: '#/components/schemas/User' type: object DriverHOS: properties: break: type: number cycle: type: number drive: type: number shift: type: number type: object DriverLog: properties: created_at: format: date-time type: string log: type: string type: object DriverLogin: properties: phone_number: type: string pin: format: int32 type: integer type: object DriverPinRequest: properties: phone_number: description: phone number to send pin to type: string type: object DriverPushNotificationTypesEnum: enum: - new_message - upcoming_pickup - stop_completion - tracking_request type: string ELDAddress: properties: city: type: string country: type: string postal_code: type: string state: type: string type: object ELDCredentials: description: Ideally, we would use oneOf (FleetupCredentials, KeepTruckinCredentials, TeletracCredentials) but Swagger 2 does not support this. This is a catch-all for all the Credential types properties: acctId: type: string api_key: type: string provider: type: string secret: type: string type: object ELDDeviceLocation: description: Location Data for device properties: address: $ref: '#/components/schemas/ELDAddress' device_id: type: string event_description: type: string lat: format: float type: number location_name: description: Friendly name if available e.g. Austin, TX type: string lon: format: float type: number odometer: format: int32 type: integer speed: description: GPS speed in Km/h format: int32 type: integer update_time: format: date-time type: string required: - update_time type: object ELDDriverStatus: enum: - driving - off_duty_not_driving - off_duty - sleeper type: string ELDDriversCreated: properties: drivers: items: $ref: '#/components/schemas/Driver' type: array errors: items: additionalProperties: type: string type: object type: array skipped_drivers: items: properties: driver_id: type: string email: type: string first_name: type: string last_name: type: string phone: type: string type: object type: array type: object ELDLocation: properties: address: $ref: '#/components/schemas/ELDAddress' event_description: type: string lat: format: float type: number location_name: description: Friendly name if available e.g. Austin, TX type: string lon: format: float type: number odometer: format: int32 type: integer speed: description: GPS speed in Km/h format: int32 type: integer update_time: format: date-time type: string required: - update_time type: object ELDLocationUpdateRequest: properties: locations: items: $ref: '#/components/schemas/ELDDeviceLocation' type: array type: object ELDProvider: enum: - eroad - fleetmatics - fleetup - geotab - ise - jjkeller - keep_truckin - omnitracs_vlv - peoplenet - samsara - teletrac - zonar type: string ETAWindow: properties: created_at: format: date-time type: string initial_window_end: description: End of the initial estimate of ETA window format: date-time type: string initial_window_start: description: Start of the initial estimate of ETA window format: date-time type: string running_window_end: description: Start of the most recent estimate of ETA window format: date-time type: string running_window_start: description: Start of the most recent estimate of ETA window format: date-time type: string updated_at: format: date-time type: string type: object EmbedUrlResponse: properties: embed_url: type: string required: - embed_url type: object EquipmentConfig: properties: carrier: $ref: '#/components/schemas/Carrier' created_at: format: date-time type: string driver: $ref: '#/components/schemas/Driver' driver_pin: format: int32 type: integer id: format: uuid type: string power_unit: $ref: '#/components/schemas/PowerUnit' trailer: $ref: '#/components/schemas/Trailer' updated_at: format: date-time type: string type: object EquipmentType: description: Equipment type properties: id: format: int32 type: integer machine_readable: enum: - AUTO_CARRIER - AUTOHAULER - B_TRAIN - BULK - CONESTOGA - CONTAINER - CONTAINER_BREAK_BULK - CONTAINER_STANDARD_20_FOOT - CONTAINER_STANDARD_40_FOOT - CONTAINER_FLAT_TRACK_20_FOOT - CONTAINER_FLAT_TRACK_40_FOOT - CONTAINER_HEAVY_TESTED_20_FOOT - CONTAINER_HIGH_CUBE_40_FOOT - CONTAINER_HIGH_CUBE_45_FOOT - CONTAINER_INSULATED - CONTAINER_ISO_TANK_20_FOOT - CONTAINER_ISO_TANK_24_FOOT - CONTAINER_ISO_TANK_40_FOOT - CONTAINER_OPEN_TOP_20_FOOT - CONTAINER_OPEN_TOP_40_FOOT - CONTAINER_REEFER_20_FOOT - CONTAINER_REEFER_40_FOOT - CONTAINER_REFRIGERATED - CONVEYOR - CURTAIN_SIDE - DOUBLE_DROP - DROP_DECK - DROP_DECK_LANDOLL - DRY_VAN - DUMP_TRAILER - FLATBED - FLATBED_53_FOOT - FLATBED_AIR_RIDE - FLATBED_CONESTOGA - FLATBED_DOUBLE - FLATBED_HOTSHOT - FLATBED_MAXI - FLATBED_OVERDIMENSION - HOPPER - HOPPER_BOTTOM - INSULATED_VAN - LOWBOY - LOWBOY_OVERDIMENSION - MOVING_VAN - OTHER - PNEUMATIC - POWER_ONLY - REEFER - REEFER_AIR_RIDE - REEFER_DOUBLE - REEFER_INTERMODAL - REMOVABLE_GOOSENECK - STEP_DECK - STEPDECK_CONESTOGA - STRAIGHT_BOX_TRUCK - STRETCH_TRAILER - TANKER - TANKER_ALUMINUM - TANKER_INTERMODAL - TANKER_STEEL - TILT - TRUCK_AND_TRAILER - VAN_AIR_RIDE - VAN_DOUBLE - VAN_INSULATED - VAN_INTERMODAL - VAN_OPEN_TOP - VAN_ROLLER_BED - VAN_SPRINTER - VAN_TRIPLE - VAN_VENTED - VAN_WITH_CURTAINS type: string name: type: string required: - id - name - machine_readable type: object EquipmentTypes: enum: - AUTO_CARRIER - AUTOHAULER - B_TRAIN - BULK - CONESTOGA - CONTAINER - CONTAINER_BREAK_BULK - CONTAINER_STANDARD_20_FOOT - CONTAINER_STANDARD_40_FOOT - CONTAINER_FLAT_TRACK_20_FOOT - CONTAINER_FLAT_TRACK_40_FOOT - CONTAINER_HEAVY_TESTED_20_FOOT - CONTAINER_HIGH_CUBE_40_FOOT - CONTAINER_HIGH_CUBE_45_FOOT - CONTAINER_INSULATED - CONTAINER_ISO_TANK_20_FOOT - CONTAINER_ISO_TANK_24_FOOT - CONTAINER_ISO_TANK_40_FOOT - CONTAINER_OPEN_TOP_20_FOOT - CONTAINER_OPEN_TOP_40_FOOT - CONTAINER_REEFER_20_FOOT - CONTAINER_REEFER_40_FOOT - CONTAINER_REFRIGERATED - CONVEYOR - CURTAIN_SIDE - DOUBLE_DROP - DROP_DECK - DROP_DECK_LANDOLL - DRY_VAN - DUMP_TRAILER - FLATBED - FLATBED_53_FOOT - FLATBED_AIR_RIDE - FLATBED_CONESTOGA - FLATBED_DOUBLE - FLATBED_HOTSHOT - FLATBED_MAXI - FLATBED_OVERDIMENSION - HOPPER - HOPPER_BOTTOM - INSULATED_VAN - LOWBOY - LOWBOY_OVERDIMENSION - MOVING_VAN - OTHER - PNEUMATIC - POWER_ONLY - REEFER - REEFER_AIR_RIDE - REEFER_DOUBLE - REEFER_INTERMODAL - REMOVABLE_GOOSENECK - STEP_DECK - STEPDECK_CONESTOGA - STRAIGHT_BOX_TRUCK - STRETCH_TRAILER - TANKER - TANKER_ALUMINUM - TANKER_INTERMODAL - TANKER_STEEL - TILT - TRUCK_AND_TRAILER - VAN_AIR_RIDE - VAN_DOUBLE - VAN_INSULATED - VAN_INTERMODAL - VAN_OPEN_TOP - VAN_ROLLER_BED - VAN_SPRINTER - VAN_TRIPLE - VAN_VENTED - VAN_WITH_CURTAINS type: string ExtendedELDProvider: enum: - eroad - fleetmatics - fleetup - geotab - ise - jjkeller - keep_truckin - omnitracs_vlv - peoplenet - samsara - teletrac - zonar - other type: string FMCSACarrierPolicy: description: FMCSA carrier policy settings. properties: company_id: type: string operating_authority_status_active: $ref: '#/components/schemas/CarrierStatus' operating_authority_status_inactive: $ref: '#/components/schemas/CarrierStatus' operating_authority_status_none: $ref: '#/components/schemas/CarrierStatus' operating_authority_status_pending: $ref: '#/components/schemas/CarrierStatus' safety_rating_date_policy: $ref: '#/components/schemas/CarrierStatus' safety_rating_date_threshold: format: int32 type: integer safety_rating_status_conditional: $ref: '#/components/schemas/CarrierStatus' safety_rating_status_satisfactory: $ref: '#/components/schemas/CarrierStatus' safety_rating_status_unrated: $ref: '#/components/schemas/CarrierStatus' safety_rating_status_unsatisfactory: $ref: '#/components/schemas/CarrierStatus' required: - operating_authority_status_active - operating_authority_status_inactive - operating_authority_status_pending - operating_authority_status_none - safety_rating_status_satisfactory - safety_rating_status_unsatisfactory - safety_rating_status_conditional - safety_rating_status_unrated - safety_rating_date_threshold - safety_rating_date_policy type: object FeatureFlags: description: 'Read-only set of boolean flags that describe what features a Company has enabled ' properties: alerts_dashboard_enabled: description: Flag that allows a company to use alerts dashboard type: boolean analytics_enabled: description: Flag that enables analytics capability type: boolean automatic_carrier_policy_enabled: description: Flag that allows for automatic carrier policy feature to be enabled type: boolean bid_manager_enabled: description: Flag that allows users to use the bid manager feature type: boolean can_book_manual_shipments: description: 'Flag that notifies the frontend whether or not it should display manual shipment booking pages ' type: boolean can_initiate_mobile_ping_tracking: description: 'Flag that allows a company to initiate cell phone ping tracking requests ' type: boolean can_override_bill_to_for_automated_ltl: description: 'Flag that notifies the frontend whether or not to render bill-to override dialog for autobook LTL shipments ' type: boolean carrier_prioritization_enabled: description: Flag that allows users of the company to access the carrier prioritization features. type: boolean ch_robinson_enabled: description: Flag that allows shipments created by Company to create and delete CHR Orders if CHR customer code is also set type: boolean company: format: uuid type: string contracts_enabled: description: Flag that allows user to use contracts and SLAs type: boolean datadocks_enabled: description: 'Flag that enables DataDocks integration ' type: boolean edi_invoicing_enabled: description: Flag that allows a company to dispatch invoices via EDI type: boolean fedex_enabled: description: Flag that enables Fedex capabilities type: boolean freightwaves_driver_texts_enabled: description: Temp flag that allows user to see the freightwaves demo functionality type: boolean ftl_instant_rates_enabled: description: Flag that enables a companies usage of FTL Instant Rates type: boolean genesis_ltl_enabled: description: Flag that allows a company to access Genesis LTL type: boolean historical_pricing_enabled: description: Flag that allows user to view historical pricing data visualization type: boolean integrations_enabled: description: Flag that enables third party applications supported on the platform capability type: boolean invoicing_enabled: description: Flag that allows users of the company to access invoicing features. type: boolean load_board_enabled: description: Flag that allows users of the company to post shipments to the load board type: boolean netsuite_enabled: description: Flag that allows a company to use Netsuite type: boolean new_dashboard_enabled: description: Flag that allows user to see the new dashboard views type: boolean order_consolidation_workflows_enabled: description: Flag that allows a company to use order consolidation workflows type: boolean policies_enabled: description: Flag that allows user to use policies type: boolean purchase_orders_enabled: description: Flag that enables purchase order capability type: boolean rate_tables_enabled: description: Flag that allows fuel and accessorial rate tables to be rendered type: boolean rmis_enabled: description: Flag that enables syncing carrier profile data from RMIS type: boolean saferwatch_enabled: description: Flag that enables syncing carrier profile data from SaferWatch type: boolean send_shipwell_network_enabled: description: Flag that allows users to send quotes to the shipwell network type: boolean shipment_details_redesign_enabled: description: Flag that allows for enabling usage of newly redesigned shipment detail type: boolean show_load_board: description: Flag that notifies the frontend whether or not to display the load board type: boolean stop_status_enabled: description: Flag that allows stop statuses to be enabled type: boolean supplier_invites_enabled: description: Flag that enables a company from sending supplier invite links type: boolean triumph_pay_enabled: description: Flag that enables company to use the Triumph Pay integration type: boolean ups_enabled: description: Flag that enables UPS capabilities type: boolean uses_3pl_quoting_flow: description: Flag that instructs frontend to render the 3PL-specific quoting flow type: boolean usps_enabled: description: Flag that enables USPS capabilities type: boolean type: object FedexAccount: properties: account_nickname: type: string account_number: type: string company: format: uuid type: string freight_account: $ref: '#/components/schemas/FedexFreightAccount' id: format: uuid type: string key: type: string meter_number: type: string password: type: string smart_post_hub_id: type: integer type: object FedexAccountResponse: allOf: - $ref: '#/components/schemas/FedexAccount' - properties: is_connected: properties: error: type: string freight: type: boolean parcel: type: boolean type: object type: object type: object FedexDirectQuote: allOf: - $ref: '#/components/schemas/GenesisQuote' FedexFreightAccount: allOf: - $ref: '#/components/schemas/GenesisAddress' - properties: freight_account_number: type: string type: object type: object FedexPackaging: properties: description: description: All possible dimensional sub-types of the package type items: type: string type: array id: description: Fedex machine-readable identifier for the package type type: string label: description: Human-readable short description of the package type type: string type: object FedexShipmentOptions: allOf: - $ref: '#/components/schemas/GenesisShipmentOptions' - properties: account: description: Id of the FedexAccount to dispatch or rate with, if using FedEx direct rating or dispatch format: uuid type: string alcohol_recipient_type: enum: - CONSUMER - LICENSEE type: string battery_material_type: enum: - LITHIUM_ION - LITHIUM_METAL type: string battery_packaging_type: enum: - CONTAINED_IN_EQUIPMENT - PACKED_WITH_EQUIPMENT type: string dropoff_type: enum: - REGULAR_PICKUP - STATION - REQUEST_COURIER - BUSINESS_SERVICE_CENTER - DROP_BOX type: string home_delivery_date: format: date-'date-time' type: string home_delivery_phone_number: type: string home_delivery_type: enum: - APPOINTMENT - DATE_CERTAIN - EVENING type: string packaging: type: string service_code: enum: - FEDEX_1_DAY_FREIGHT - FEDEX_2_DAY - FEDEX_2_DAY_AM - FEDEX_2_DAY_FREIGHT - FEDEX_3_DAY_FREIGHT - FEDEX_EXPRESS_SAVER - FEDEX_FIRST_FREIGHT - FEDEX_FREIGHT_ECONOMY - FEDEX_FREIGHT_PRIORITY - FEDEX_GROUND - FIRST_OVERNIGHT - GROUND_HOME_DELIVERY - INTERNATIONAL_ECONOMY - INTERNATIONAL_ECONOMY_FREIGHT - INTERNATIONAL_FIRST - INTERNATIONAL_PRIORITY - INTERNATIONAL_PRIORITY_EXPRESS - INTERNATIONAL_PRIORITY_FREIGHT - PRIORITY_OVERNIGHT - SMART_POST - STANDARD_OVERNIGHT - EUROPE_FIRST_INTERNATIONAL_PRIORITY - FEDEX_DISTANCE_DEFERRED - FEDEX_NEXT_DAY_AFTERNOON - FEDEX_NEXT_DAY_EARLY_MORNING - FEDEX_NEXT_DAY_END_OF_DAY - FEDEX_NEXT_DAY_FREIGHT - FEDEX_NEXT_DAY_MID_MORNING - SAME_DAY - SAME_DAY_CITY type: string shipment_services: items: type: string type: array smart_post_indicia_type: enum: - MEDIA_MAIL - PARCEL_SELECT - PRESORTED_BOUND_PRINTED_MATTER - PRESORTED_STANDARD - PARCEL_RETURN type: string use_preferred_rates: default: false type: boolean type: object description: Shipment rating and dispatch options specific to FedEx FleetupCredentials: description: Credentials for connecting to Fleetup properties: acctId: type: string owner_id: type: string secret: type: string required: - acctId - secret type: object FmcsaCarrier: description: FMCSA carrier data properties: active: type: string dba_name: type: string mc_number: type: string name: type: string physical_city: type: string physical_country: type: string physical_postal_code: type: string physical_state: type: string physical_street: type: string usdot: type: string type: object FmcsaCensusData: description: FMCSA census vendor data properties: active: type: boolean cdl_drivers: format: int32 type: integer hazmat_indicator: type: boolean identification_codes: items: $ref: '#/components/schemas/IdentifyingCodeType' type: array operating_authority: items: $ref: '#/components/schemas/OperatingAuthority' type: array revoked: type: boolean safety_rating: type: string safety_rating_date: type: string total_buses: format: int32 type: integer total_drivers: format: int32 type: integer total_power_units: format: int32 type: integer total_trucks: format: int32 type: integer usdot: type: string type: object FormattedAddress: properties: formatted_address: type: string required: - formatted_address type: object FuelSurchargeTable: description: Rate table for calculating fuel surcharge based on market fuel prices properties: additional_instructions: type: string base_fuel_price: type: number calculation_rows: items: $ref: '#/components/schemas/FuelSurchargeTableCalculationRow' type: array carrier_relationships: items: format: uuid type: string type: array company: format: uuid type: string created_by_user: format: uuid type: string current_us_dept_of_energy_per_gallon_rate: type: number destinations: items: $ref: '#/components/schemas/Address' type: array end_date: format: date type: string equipment_types: items: type: string type: array external_reference: description: Unique identifier for the rate table within an external system type: string miles_per_gallon: type: integer modes: items: type: string type: array name: type: string origins: items: $ref: '#/components/schemas/Address' type: array rates_updated_day_of_week: enum: - MONDAY - TUESDAY - WEDNESDAY - THURSDAY - FRIDAY - SATURDAY - SUNDAY type: string rates_updated_interval: enum: - MONTH - WEEK type: string rates_updated_time_of_day: format: time type: string start_date: format: date type: string status: enum: - ACTIVE - INACTIVE type: string required: - calculation_rows - name - rates_updated_interval - status type: object FuelSurchargeTableCalculationRow: description: Specification for how much fuel surcharge should cost for a given range of fuel cost properties: fuel_price_lower_bound: type: number fuel_surcharge: type: number table: format: uuid type: string required: - fuel_price_lower_bound - fuel_surcharge type: object GenesisAddress: properties: city: type: string country_code: type: string line_1: type: string line_2: type: string postal_code: type: string state_or_province: type: string required: - line_1 - city - state_or_province - postal_code - country_code type: object GenesisQuote: properties: carrier_code: type: string service_code: type: string type: object GenesisShipmentOptions: properties: bill_to_account_number: type: string bill_to_country_code: type: string bill_to_payment_type: enum: - COLLECT - RECIPIENT - SENDER - THIRD_PARTY type: string bill_to_postal_code: type: string cod_collection_amount: format: float type: number cod_collection_currency: default: USD enum: - CAD - USD type: string cod_collection_type: enum: - ANY - COMPANY_CHECK - GUARANTEED_FUNDS - PERSONAL_CHECK type: string customer_transaction_id: type: string signature_option_release_number: type: string signature_option_signature_type: enum: - ADULT_SIGNATURE - DIRECT_SIGNATURE - NO_SIGNATURE - INDIRECT_SIGNATURE - SERVICE_DEFAULT type: string type: object GroupedEnum: properties: groups: items: $ref: '#/components/schemas/GroupedEnumGroup' type: array values: items: $ref: '#/components/schemas/GroupedEnumValue' type: array type: object GroupedEnumGroup: properties: code: description: Machine-readable code for the group that enum values belong to type: string description: description: Human-readable code for the group that enum values belong to type: string required: - code - description type: object GroupedEnumValue: properties: group: description: Reference to the machine-readable group identifer to which the enum value belongs type: string name: description: Unique identifier for an enum member type: string required: - group - name type: object Hazmat: description: Hazmat code properties: hazard_class: type: string id: format: int32 type: integer identification_number: type: string packing_group: type: string proper_shipping_name: type: string required: - id - identification_number - proper_shipping_name - hazard_class - packing_group type: object HistoricalPriceSources: enum: - chainalytics_spot - dat_spot - shipwell_internal type: string HoursOfService: description: Hours of Service Record properties: break: description: Number of minutes spent on break i.e. Off duty or in the sleeper berth (minutes) type: number cycle: description: On Duty and Driving Time available in this cycle (minutes) type: number drive: description: Driving time available in this shift (minutes) type: number shift: description: On Duty time available in this shift (minutes) type: number required: - cycle - shift - drive - break type: object HoursOfServiceResponse: properties: driver_id: type: string hos: $ref: '#/components/schemas/HoursOfService' status: enum: - driving - off_duty_not_driving - off_duty - sleeper type: string type: object IdentifyingCode: properties: created_at: format: date-time type: string id: format: uuid type: string type: type: string updated_at: format: date-time type: string value: type: string required: - type - value type: object IdentifyingCodeType: description: Enum of special reserved IdentyfingCode types properties: id: type: string name: type: string required: - id - name type: object ImportColumnMapping: description: Imports columns for a given import properties: column_index: format: int32 type: integer created_at: format: date-time type: string data_import: format: uuid type: string id: format: uuid type: string sheet_column_name: type: string shipwell_column_name: type: string updated_at: format: date-time type: string required: - id - column_index - data_import - sheet_column_name type: object ImportJob: description: Imports rows for a given import properties: error_rows: format: int32 type: integer errors: type: string id: format: uuid type: string is_complete: type: boolean success_rows: format: int32 type: integer type: object ImportRow: description: Imports rows for a given import properties: created_at: format: date-time type: string data_import: format: uuid type: string id: format: uuid type: string import_values: items: $ref: '#/components/schemas/ImportValue' type: array row_index: format: int32 type: integer updated_at: format: date-time type: string required: - id - data_import type: object ImportValue: description: Imports values for a given import properties: column_mapping: format: uuid type: string created_at: format: date-time type: string data_import: format: uuid type: string id: format: uuid type: string row: format: uuid type: string updated_at: format: date-time type: string value: type: string required: - id - data_import type: object InaccurateCarrier: description: Data about the inaccurate carrier properties: notes: type: string usdot: type: string required: - inaccurate_vendor - notes type: object InboxMessage: description: Inbox Message properties: created_at: format: date-time type: string id: format: uuid type: string level: type: string message: type: string read: type: boolean url: type: string required: - id - read - message - created_at type: object InitiateCheckCallRequest: description: Request body to initiate a check call on a shipment properties: automation_event_sub_type: description: What type of check call to make enum: - LOCATION_CHECK_IN - PRE_PICKUP type: string phone_number: description: Phone number to call type: string required: - automation_event_sub_type - phone_number type: object Invoice: description: Data about a shipment invoice properties: balance: format: float type: number created_at: format: date-time readOnly: true type: string custom_data: $ref: '#/components/schemas/InvoiceCustomData' customer_memo: type: string documents: items: $ref: '#/components/schemas/ShipmentDocumentMetadata' readOnly: true type: array due_date: format: date type: string error_description: description: If an error occurred during processing, this field will be set type: string id: format: uuid readOnly: true type: string invoice_number: type: string line_items: items: properties: amount: format: float type: number category: $ref: '#/components/schemas/ChargeCategory' custom_data: additionalProperties: {} title: InvoiceLineItemCustomData type: object x-is-free-form: false description: type: string id: type: string name: type: string prepaid_amount: format: float type: number service_date: format: date type: string unit_amount: format: float type: number unit_quantity: format: float type: number type: object type: array payment_status: default: Not paid enum: - Fully paid - Partially paid - Not paid readOnly: true type: string processing_status: description: The status of the processing the invoice with the third party system enum: - PROCESSING - SUCCESS - ERROR service_date: description: When the service took place, defaults to the `due_date` of the related Shipment format: date type: string shipment: properties: bol_number: type: string id: format: uuid type: string name: type: string pro_number: type: string purchase_order_number: type: string reference_id: type: string readOnly: true type: object total_amount: format: float readOnly: true type: number updated_at: format: date-time readOnly: true type: string voided: readOnly: true type: boolean type: object InvoiceCustomData: additionalProperties: {} description: Custom data for Invoice type: object x-is-free-form: false InvoiceEmailResponse: properties: invoice: description: Invoice that was emailed properties: id: format: uuid readOnly: true type: string resource_type: enum: - invoice type: string self_link: format: uri type: string type: object message: description: What happened with the email request type: string recipients: items: type: string type: array type: object InvoiceLineItemCustomData: additionalProperties: {} description: Custom data for an InvoiceLineItem type: object x-is-free-form: false InvoiceUpdateRequest: allOf: - $ref: '#/components/schemas/Invoice' - required: - invoice_number - due_date - processing_status - balance - total_amount JobRole: properties: db_name: type: string human_readable_name: type: string type: object KeepTruckinCredentials: description: Credentials for connecting to KeepTruckin properties: api_key: type: string required: - api_key type: object LinearFeetEstimate: properties: estimated_linear_feet: description: Read-only result of linear feet calculation format: int32 type: integer line_items: items: $ref: '#/components/schemas/ShipmentLineItem' type: array type: object LinkDriver: description: Either a driver's auth token or a driver's phone number and pin properties: phone_number: description: Optional phone number of the driver to link type: string pin: description: Optional pin number of the driver to link format: int32 type: integer token: description: Optional authentication token of the driver to link type: string type: object LoadBoardBiddingStatuses: enum: - bidding - closed - open - won - tendered - accepted - rejected - expired type: string LoadBoardShipment: properties: accessorials: items: $ref: '#/components/schemas/Accessorial' type: array bid_count: format: int32 type: integer bidding_status: enum: - bidding - closed - open - won - tendered - accepted - rejected - expired type: string buy_it_now_amount: format: float type: number buy_it_now_amount_currency: enum: - CAD - USD type: string created_at: format: date-time type: string customer: $ref: '#/components/schemas/SlimCompany' customer_reference_number: type: string drayage_booking_number: type: string drayage_chassis_number: type: string drayage_container_number: type: string drayage_container_return_date: type: string drayage_estimated_arrival_date: type: string drayage_last_free_date: type: string drayage_release_date: type: string drayage_seal_number: type: string equipment_types: items: $ref: '#/components/schemas/EquipmentType' type: array expires_at: format: date-time type: string id: format: uuid type: string is_tendered: type: boolean line_items: items: $ref: '#/components/schemas/ShipmentLineItem' type: array load_board_id: type: string lowest_bid_amount: format: float type: number lowest_bids: items: format: float type: number type: array modes: items: $ref: '#/components/schemas/ShipmentMode' type: array notes_for_carrier: type: string preferred_currency: type: string spot_negotiation: format: uuid type: string spot_negotiation_carrier_status: enum: - ACTIVE - INACTIVE - DO_NOT_USE type: string state: enum: - appointment_pending - at_pickup - at_delivery - auction_running - cancelled - carrier_confirmed - delayed - delivered - dispatched - draft - in_transit - out_for_delivery - quote_accepted - quoting - reconciled - scheduled - tendered type: string stops: items: $ref: '#/components/schemas/Stop' type: array temperature_lower_limit: format: float type: number temperature_upper_limit: format: float type: number tenders: items: $ref: '#/components/schemas/TenderGet' type: array total_declared_value: format: float type: number total_declared_value_currency: enum: - USD - CAD type: string total_miles: format: float type: number total_weight_override: $ref: '#/components/schemas/TotalWeightOverride' updated_at: format: date-time type: string required: - accessorials - bidding_status - customer - id - line_items - load_board_id - state - stops type: object LoadBoardTenderStatuses: enum: - open - accepted - rejected - revoked - expired type: string LocationCustomData: additionalProperties: true description: Custom data for Location type: object x-is-free-form: false LocationRating: properties: driver: format: uuid type: string message: type: string rating: format: int32 type: integer stop: format: uuid type: string required: - rating type: object LocationType: properties: id: format: int32 type: integer name: type: string required: - name type: object Login: properties: email: type: string password: type: string required: - email - password type: object LoginResponse: properties: api_key: type: string company: $ref: '#/components/schemas/Company' driver: $ref: '#/components/schemas/Driver' driver_token: type: string is_owner_operator: type: boolean token: type: string user: $ref: '#/components/schemas/User' type: object Markup: properties: created_at: format: date-time type: string ftl_markup_flat_fee: type: number ftl_markup_percentage: description: percentage is in decimal form from 0 to 1 where 1 is 100% type: number ftl_markup_type: enum: - flat_fee - percentage type: string id: format: uuid type: string ltl_markup_flat_fee: type: number ltl_markup_minimum: description: 'Optional minimum LTL markup value that will override percentage-based calculations when it exceeds their outputs ' type: number ltl_markup_percentage: description: percentage is in decimal form from 0 to 1 where 1 is 100% type: number ltl_markup_type: enum: - flat_fee - percentage type: string updated_at: format: date-time type: string type: object MessageListShipmentMessage: description: Message about a Shipment, includes information about the shipment as well properties: first_stop_city: type: string first_stop_state: type: string id: format: uuid type: string is_current_shipment: type: boolean last_stop_city: type: string last_stop_state: type: string most_recent_message: type: string most_recent_message_created_at: format: date-time type: string reference_id: type: string required: - id - is_current_shipment - reference_id type: object NMFC: description: NMFCCode description properties: code: type: string description: type: string freight_class: type: string id: format: int32 type: integer long_description: type: string sub_code: type: string required: - id - code - description - long_description - freight_class - sub_code type: object NetsuiteCategory: description: Item category in Netsuite properties: display_name: description: Human-readable name of the category type: string id: description: Internal Netsuite ID type: string type: object NetsuiteCategoryOptions: description: All available mapping options from Netsuite. Categories come from the 'Items' section in Netsuite properties: billing: description: Valid categories for billing items: $ref: '#/components/schemas/NetsuiteCategory' type: array invoicing: description: Valid categories for invoicing items: $ref: '#/components/schemas/NetsuiteCategory' type: array type: object NetsuiteCompanyOptions: description: Data source of various company options that can be configured properties: accounts_payable: description: All possible accounts payable that can be used for default_ns_vendor_payment_terms items: $ref: '#/components/schemas/NetsuiteFieldOption' type: array file_cabinet_folders: description: All possible folders that can be used for default_ns_filecabinet_folder_id items: $ref: '#/components/schemas/NetsuiteFieldOption' type: array sales_reps: description: All possible sales reps that that can be used for default_ns_sales_rep items: $ref: '#/components/schemas/NetsuiteFieldOption' type: array subsidiaries: description: All possible subsidaries that can be used for default_ns_subsidiary_customer items: $ref: '#/components/schemas/NetsuiteFieldOption' type: array vendor_terms: description: All possible vendor terms that can be used for default_ns_vendor_payment_terms items: $ref: '#/components/schemas/NetsuiteFieldOption' type: array type: object NetsuiteConfig: properties: account_id: description: Owning Netsuite account identifier type: string consumer_key: description: Also known as 'Client ID' in the 'Client Credentials' settings for the Netsuite integration type: string consumer_secret: description: Also known as 'Client Secret' in the 'Client Credentials' settings for the Netsuite integration type: string default_ns_subsidiary_customer: type: string id: description: Identifier for the config readOnly: true type: string token_id: description: Token ID for the Netsuite access token type: string token_secret: description: Token secret for the Netsuite access token type: string required: - account_id - consumer_key - consumer_secret - token_id - token_secret type: object NetsuiteConfigCategoryMapping: properties: charge_category: allOf: - $ref: '#/components/schemas/ChargeCategory' description: Shipwell category for the mapping netsuite_id: description: Netsuite category id for the mapping type: string shipment_mode: description: Shipment mode this mapping is relevant for. If null, this is apart of the default mappings type: string required: - charge_category - netsuite_id type: object NetsuiteConfigCategoryMappings: description: Mappings for invoicing and billing between a Shipwell category and a Netsuite category properties: billing: items: $ref: '#/components/schemas/NetsuiteConfigCategoryMapping' type: array invoicing: items: $ref: '#/components/schemas/NetsuiteConfigCategoryMapping' type: array type: object NetsuiteConfigFieldMappings: properties: default_ns_accounts_payable: description: Which account a bill should be paid from type: string default_ns_filecabinet_folder_id: description: Which folder invoice and bill attachments are saved into within a Netsuite file cabinet type: string default_ns_sales_rep: description: Which sales rep should be associated with an invoice when it is first created type: string default_ns_subsidiary_customer: description: The subsidiary customer that all customers should be created under type: string default_ns_vendor_payment_terms: description: When creating a Vendor, what payment terms that vendor should be associated with type: string dot_number_ns_field_id: description: Netsuite custom field ID for a Vendor's DOT Number type: string locked_ns_field_id: description: Netsuite custom field ID for locking a vendor or customer during an update from Shipwell type: string mc_number_ns_field_id: description: Netsuite custom field ID for a Vendor's MC Number type: string service_date_ns_field_id: description: Netsuite custom field ID on a bill or invoice to hold when the original service date occurred type: string shipment_id_ns_field_id: description: Netsuite custom field ID for the Shipment reference number for a bill or invoice type: string type: object NetsuiteCustomField: description: Custom field from Netsuite properties: field_name: description: Human-readable field name type: string id: description: Internal Netsuite ID type: string type: description: Where this custom field can appear within Netsuite. `entityCustomField` can display anywhere (like for customers vendors) whereas `transactionBodyCustomField` displays on an Invoice or Bill enum: - entityCustomField - transactionBodyCustomField type: string type: object NetsuiteCustomFieldOptions: description: All available custom fields from Netsuite properties: fields: description: All valid Netsuite custom fields items: $ref: '#/components/schemas/NetsuiteCustomField' type: array type: object NetsuiteFieldOption: properties: id: type: string name: type: string type: object NotificationPreference: properties: enabled: type: boolean id: format: uuid type: string medium: enum: - email - sms - push - inbox type: string notification_type: type: string type: object NotifyShipmentsNotTracking: properties: tracking: items: type: string type: array tracking_stopped: items: type: string type: array type: object OperatingAuthority: description: Operating authority details for a carrier or broker properties: broker_status: type: string common_status: type: string contract_status: type: string id_code_type: type: string id_code_value: type: string required: - id_code_type - id_code_value - common_status - contract_status - broker_status type: object OrderConsolidationPolicyCustomer: properties: customer_external_id: type: string customer_name: type: string id: format: uuid type: string policy: format: uuid type: string required: - customer_external_id type: object OrderConsolidationPolicyProduct: properties: id: format: uuid type: string policy: format: uuid type: string product: format: uuid type: string product_ref: type: string required: - product_ref type: object OrderConsolidationPolicySupplier: properties: id: format: uuid type: string policy: format: uuid type: string supplier_external_id: type: string supplier_name: type: string required: - supplier_external_id type: object PackageType: description: Package type code properties: code: type: string description: type: string id: format: int32 type: integer long_description: type: string required: - id - code - description - long_description type: object ParcelPickupStatus: enum: - CANCELLED - DELAYED - DELIVERED - IN_TRANSIT - NOT_SCHEDULED - SCHEDULED type: string PhoneNumberLookup: properties: caller_name: type: string caller_type: type: string carrier_name: type: string phone_number: type: string type: enum: - landline - mobile - unverified - voip type: string updated_at: format: date-time type: string required: - phone_number type: object PieceType: description: Piece type code properties: code: type: string description: type: string id: type: string long_description: type: string required: - id - code - description - long_description type: object PointOfContact: allOf: - $ref: '#/components/schemas/BasePointOfContact' - properties: load_board_enabled: type: boolean load_board_invite_last_sent_at: format: date-time type: string preferences: $ref: '#/components/schemas/PointOfContactNotificationPreferences' user: description: Id of the user that this PointOfContact refers format: uuid type: string required: - preferences type: object PointOfContactNotificationPreferences: properties: cancellation: type: boolean delayed: type: boolean delivered: type: boolean eta_changed: type: boolean picked_up: type: boolean receive_bol_on_shipment_booked: type: boolean shipment_booked: type: boolean required: - cancellation - delayed - delivered - eta_changed - picked_up - receive_bol_on_shipment_booked - shipment_booked type: object Policy: properties: created_at: format: date-time type: string customers: items: $ref: '#/components/schemas/OrderConsolidationPolicyCustomer' type: array destinations: items: $ref: '#/components/schemas/Address' type: array end_date: format: date type: string equipment_types: items: $ref: '#/components/schemas/EquipmentType' type: array id: format: uuid type: string modes: items: $ref: '#/components/schemas/ShipmentMode' type: array name: type: string origins: items: $ref: '#/components/schemas/Address' type: array policy_type: enum: - ROUTING_GUIDE - ORDER_CONSOLIDATION type: string products: items: $ref: '#/components/schemas/OrderConsolidationPolicyProduct' type: array reference: type: string start_date: format: date type: string status: enum: - ACTIVE - INACTIVE type: string suppliers: items: $ref: '#/components/schemas/OrderConsolidationPolicySupplier' type: array updated_at: format: date-time type: string workflow_id: type: string required: - name - policy_type type: object PolicyAsWorkflowTriggerConditional: properties: conditional: $ref: '#/components/schemas/WorkflowAutomationStructuredConditional' type: object PostBrokeragesBrokerageidShipperRelationshipsShipperrelationshipidDocuments: properties: description: type: string file: format: binary type: string required: - file - description type: object PostCompaniesCompanyidUsers: properties: avatar: format: binary type: string company_id: format: uuid type: string completed_onboarding: type: boolean created_at: type: string default_shipment_tags: description: List of ShipmentTag ids items: format: uuid type: string type: array email: type: string first_name: type: string is_quoting_limited_user: type: boolean last_login: type: string last_name: type: string password: type: string permissions: items: type: string type: array phone_number: type: string timezone: type: string updated_at: type: string required: - avatar - email - first_name - last_name type: object PostProducts: properties: description: type: string external_pickup_address: format: uuid type: string freight_class: type: string hazmat_hazard_class: type: string hazmat_identification_number: type: string hazmat_packing_group: type: string hazmat_proper_shipping_name: type: string height: format: float type: number image: format: binary type: string length: format: float type: number length_unit: type: string nmfc_item_code: type: string nmfc_sub_code: type: string package_type: type: string package_weight: format: float type: number piece_type: type: string product_ref: type: string provider_specific_packaging: type: string refrigeration_max_temp: format: float type: number refrigeration_min_temp: format: float type: number refrigeration_required: type: boolean stackable: type: boolean temp_unit: type: string value_per_piece: format: float type: number weight_unit: type: string width: format: float type: number required: - description - product_ref type: object PowerUnit: properties: created_at: format: date-time type: string description: type: string distance_traveled_miles: format: float type: number from_eld_provider: type: boolean id: format: uuid type: string last_data_report: format: date-time type: string license_plate_number: type: string license_plate_state_province: type: string make: type: string model: type: string name: type: string provider: type: string status: enum: - Active - Inactive type: string updated_at: format: date-time type: string vin: type: string required: - name type: object Product: allOf: - $ref: '#/components/schemas/BaseProductDescription' - properties: external_can_quote: type: boolean external_id: type: string external_pickup_address: $ref: '#/components/schemas/AddressBookEntry' filename: type: string image: type: string max_pieces_per_package: format: int32 type: integer source: type: string type: object required: - id - product_ref - description type: object PurchaseOrder: properties: actual_delivery_datetime: format: date-time type: string actual_pickup_datetime: format: date-time type: string company: format: uuid type: string created_at: format: date-time type: string created_by_user: $ref: '#/components/schemas/SlimUser' custom_data: $ref: '#/components/schemas/PurchaseOrderCustomData' customer_external_id: type: string customer_name: type: string description: type: string destination_address: $ref: '#/components/schemas/Address' destination_address_book_entry: format: uuid type: string destination_dock_external_id: description: Destination dock id of the purchase order from the company's external system type: string destination_stop: format: uuid type: string destination_stop_alerts: items: $ref: '#/components/schemas/StopAlert' type: array id: format: uuid type: string invoice_external_id: type: string line_items: items: $ref: '#/components/schemas/PurchaseOrderLineItem' type: array name: type: string order_number: type: string origin_address: $ref: '#/components/schemas/Address' origin_address_book_entry: format: uuid type: string origin_dock_external_id: description: Origin dock id of the purchase order from the company's external system type: string origin_stop: format: uuid type: string origin_stop_alerts: items: $ref: '#/components/schemas/StopAlert' type: array overall_status: description: Read-only status of a purchase order that, if no transit_status exists, will describe shipment assignment enum: - ASSIGNED - UNASSIGNED - PICKED_UP - IN_TRANSIT - DELIVERED - EXCEPTIONS - CANCELLED type: string planned_delivery_end_datetime: format: date-time type: string planned_delivery_start_datetime: format: date-time type: string planned_pickup_end_datetime: format: date-time type: string planned_pickup_start_datetime: format: date-time type: string shipment: format: uuid type: string source: enum: - MAGENTO - SHIPWELL_WEB - SHOPIFY - IMPORT - TENDER - SHIPWELL_WEB_UNAUTH type: string source_system_id: type: string status: type: string subtotal_amount: type: number subtotal_amount_currency: default: USD enum: - CAD - USD type: string supplier_external_id: type: string supplier_name: type: string tax_amount: type: number tax_amount_currency: default: USD enum: - CAD - USD type: string transit_status: enum: - PICKED_UP - IN_TRANSIT - DELIVERED - EXCEPTIONS - CANCELLED type: string transit_status_reason_code: enum: - ACCIDENT - ALTERNATE_CARRIER_DELIVERED - ALTERNATE_CARRIER_PICKED_UP - AWAITING_IMPORT - BORDER_CLEARANCE - CARRIER_KEYING_ERROR - CARRIER_RELATED - CASH_NOT_AVAILABLE_FROM_CONSIGNEE - CIVIL_EVENT - COLLECT_ON_DELIVERY_REQUIRED - CONSIGNEE_CLOSED - CONSIGNEE_RELATED - CONTAMINATED - CREDIT_HOLD - CUSTOMER_REQUESTED_DIFFERENT_DELIVERY_WINDOW - CUSTOMS_DOCUMENTATION_PROBLEM - CUSTOMS_DOCUMENTATION_PROBLEMS - DAMAGED - DELIVERY_SHORTAGE - DRIVER_NOT_AVAILABLE - DRIVER_RELATED - EQUIPMENT_SHORTAGE - EQUIPMENT_VOLUME_NOT_AVAILABLE - EXCEEDS_SERVICE_LIMITATIONS - FAILED_TO_RELEASE_BILLING - HELD_FOR_FULL_CARRIER_LOAD - HELD_FOR_PAYMENT - HELD_FOR_PROTECTIVE_SERVICE - HELD_PENDING_APPOINTMENT - HOLIDAY_CLOSED - IMPROPER_FACILITY_OR_EQUIPMENT - IMPROPER_TEMPERATURE - INCONSISTENT_WEIGHT - INCORRECT_ADDRESS - INSUFFICIENT_DELIVERY_TIME - INSUFFICIENT_PICKUP_TIME - INSUFFICIENT_TRAVEL_TIME_DETECTED - INTERNATIONAL_NON_CARRIER_DELAY - MECHANICAL_BREAKDOWN - MISSING_DOCUMENTS - MIS_SORT - NON_EXPRESS_CLEARANCE_DELAY - NORMAL_APPOINTMENT - NORMAL_STATUS - NO_APPOINTMENT_SCHEDULED - NO_REQUESTED_ARRIVAL_DATE_OR_TIME - OTHER - PAST_CUT_OFF_TIME - PROCESSING_DELAY - RAILROAD_FAILED_TO_MEET_SCHEDULE - RECIPIENT_UNAVAILABLE - RECONSIGNED - RESTRICTED_ARTICLES_UNACCEPTABLE - RETURNED_TO_SHIPPER - ROAD_CONDITIONS - SHIPMENT_OVERWEIGHT - SHIPPER_RELATED - TRACKING_EVENT_AUTOMATED_CALL - TRACKING_EVENT_EDI_UPDATE - TRACKING_EVENT_ELD_UPDATE - TRACKING_EVENT_GEOFENCE_BREACH - TRACKING_EVENT_MANUAL_LOCATION_UPDATED - TRACKING_EVENT_MOBILE_APP - TRACKING_EVENT_MOBILE_APP_UPDATED_BY_DRIVER - TRAIN_DERAILMENT - UNABLE_TO_CONTACT_RECIPIENT - UNABLE_TO_LOCATE - UNKNOWN - WAITING_FOR_CUSTOMER_PICKUP - WAITING_INSPECTION - WAITING_SHIPPING_INSTRUCTIONS - WEATHER_OR_NATURAL_DISASTER type: string updated_at: format: date-time type: string required: - order_number - destination_address - origin_address - source type: object PurchaseOrderAlert: properties: alert_type: enum: - AT_RISK - DELAYED - EARLY - LATE - OTHER - WAITING type: string created_at: format: date-time type: string id: format: uuid type: string occurred_at: format: date-time type: string purchase_order: format: uuid type: string reason_code: enum: - ACCIDENT - ALTERNATE_CARRIER_DELIVERED - ALTERNATE_CARRIER_PICKED_UP - AWAITING_IMPORT - BORDER_CLEARANCE - CARRIER_KEYING_ERROR - CARRIER_RELATED - CASH_NOT_AVAILABLE_FROM_CONSIGNEE - CIVIL_EVENT - COLLECT_ON_DELIVERY_REQUIRED - CONSIGNEE_CLOSED - CONSIGNEE_RELATED - CONTAMINATED - CREDIT_HOLD - CUSTOMER_REQUESTED_DIFFERENT_DELIVERY_WINDOW - CUSTOMS_DOCUMENTATION_PROBLEM - CUSTOMS_DOCUMENTATION_PROBLEMS - DAMAGED - DELIVERY_SHORTAGE - DRIVER_NOT_AVAILABLE - DRIVER_RELATED - EQUIPMENT_SHORTAGE - EQUIPMENT_VOLUME_NOT_AVAILABLE - EXCEEDS_SERVICE_LIMITATIONS - FAILED_TO_RELEASE_BILLING - HELD_FOR_FULL_CARRIER_LOAD - HELD_FOR_PAYMENT - HELD_FOR_PROTECTIVE_SERVICE - HELD_PENDING_APPOINTMENT - HOLIDAY_CLOSED - IMPROPER_FACILITY_OR_EQUIPMENT - IMPROPER_TEMPERATURE - INCONSISTENT_WEIGHT - INCORRECT_ADDRESS - INSUFFICIENT_DELIVERY_TIME - INSUFFICIENT_PICKUP_TIME - INSUFFICIENT_TRAVEL_TIME_DETECTED - INTERNATIONAL_NON_CARRIER_DELAY - MECHANICAL_BREAKDOWN - MISSING_DOCUMENTS - MIS_SORT - NON_EXPRESS_CLEARANCE_DELAY - NORMAL_APPOINTMENT - NORMAL_STATUS - NO_APPOINTMENT_SCHEDULED - NO_REQUESTED_ARRIVAL_DATE_OR_TIME - OTHER - PAST_CUT_OFF_TIME - PROCESSING_DELAY - RAILROAD_FAILED_TO_MEET_SCHEDULE - RECIPIENT_UNAVAILABLE - RECONSIGNED - RESTRICTED_ARTICLES_UNACCEPTABLE - RETURNED_TO_SHIPPER - ROAD_CONDITIONS - SHIPMENT_OVERWEIGHT - SHIPPER_RELATED - TRACKING_EVENT_AUTOMATED_CALL - TRACKING_EVENT_EDI_UPDATE - TRACKING_EVENT_ELD_UPDATE - TRACKING_EVENT_GEOFENCE_BREACH - TRACKING_EVENT_MANUAL_LOCATION_UPDATED - TRACKING_EVENT_MOBILE_APP - TRACKING_EVENT_MOBILE_APP_UPDATED_BY_DRIVER - TRAIN_DERAILMENT - UNABLE_TO_CONTACT_RECIPIENT - UNABLE_TO_LOCATE - UNKNOWN - WAITING_FOR_CUSTOMER_PICKUP - WAITING_INSPECTION - WAITING_SHIPPING_INSTRUCTIONS - WEATHER_OR_NATURAL_DISASTER type: string updated_at: format: date-time type: string required: - alert_type - reason_code type: object PurchaseOrderCustomData: additionalProperties: {} description: Custom data for PurchaseOrder type: object x-is-free-form: false PurchaseOrderLineItem: allOf: - $ref: '#/components/schemas/BaseProductDescription' - properties: custom_data: $ref: '#/components/schemas/PurchaseOrderLineItemCustomData' description: type: string product_ref: type: string purchase_order: format: uuid type: string total_line_item_weight: description: Read-only weight of the PurchaseOrderLineItem format: float type: number total_packages: format: int32 type: integer total_pieces: format: int32 type: integer type: object required: - id type: object PurchaseOrderLineItemCustomData: additionalProperties: {} description: Custom data for PurchaseOrderLineItem type: object x-is-free-form: false PurchaseOrderResponse: allOf: - $ref: '#/components/schemas/PurchaseOrder' - properties: shipment: $ref: '#/components/schemas/Shipment' type: object type: object QuickbooksAuthDetails: description: Quickbooks authorization details for a given company properties: authorized_by_user: format: uuid type: string company: format: uuid type: string created_at: format: date-time type: string id: format: uuid type: string re_authorized_by_user: format: uuid type: string realm_id: type: string updated_at: format: date-time type: string type: object QuickbooksExpenseClass: properties: id: format: uuid type: string name: type: string quickbooks_id: type: string type: object QuickbooksExpensesCategoryMapping: properties: category: type: string expense_account: properties: id: format: uuid type: string name: type: string quickbooks_id: type: string type: object expense_class: properties: id: format: uuid type: string name: type: string quickbooks_id: type: string type: object id: format: uuid type: string type: object QuickbooksGLAccount: properties: account_subtype: type: string account_type: type: string id: format: uuid type: string name: type: string quickbooks_id: type: string type: object QuickbooksItem: properties: description: type: string fully_qualified_name: type: string id: format: uuid type: string name: type: string quickbooks_id: type: string type: object QuickbooksItemCategoryMapping: properties: category: type: string id: format: uuid type: string quickbooks_item: $ref: '#/components/schemas/QuickbooksItem' shipment_mode: $ref: '#/components/schemas/ShipmentMode' type: object Quote: properties: accepted_at: format: date-time type: string approved_by_rfq_at: description: Not implemented format: date-time type: string can_dispatch: type: boolean carrier: $ref: '#/components/schemas/Carrier' charge_line_items: items: $ref: '#/components/schemas/QuoteChargeLineItem' type: array created_at: format: date-time type: string created_by_company: $ref: '#/components/schemas/SlimCompany' created_by_user: format: uuid type: string currency: default: USD description: Read-only currency code describing the currency of line items on the quote enum: - CAD - USD type: string customer_markup: description: 'Markup charge to the end customer, obfuscated so only authorized users can read/write its true value ' format: float type: number delivery_date: description: Planned delivery date of the shipment, in string of the form YYYY-MM-DD type: string display_earliest_pickup: description: Human-readable date/time of earliest pickup, if one exists type: string earliest_pickup_date: description: Earliest date the shipment could be run, in string of the form YYYY-MM-DD type: string earliest_pickup_time: description: Earliest time the shipment could be run format: time type: string equipment_type: $ref: '#/components/schemas/EquipmentType' error_message: description: Error that happened during quoting type: string expires_at: format: date-time type: string fedex_direct_quote: $ref: '#/components/schemas/FedexDirectQuote' id: format: uuid type: string info_message: description: Description of caveats about the quote type: string is_csp_rate: description: 'True iff Quote originated from a rate that a Brokerage negotiated on behalf of one of their FreightAuthorities ' type: boolean is_failure: description: 'if true, this Quote does not represent an actual price but instead a failure to provide a Quote to an RFQ ' type: boolean lane_type: default: UNSPECIFIED enum: - DIRECT - INTERLINE - UNSPECIFIED type: string mode: $ref: '#/components/schemas/ShipmentMode' provider_logo_url: description: URL for the logo of the quote provider type: string quoted_non_dispatchable_accessorials: items: $ref: '#/components/schemas/Accessorial' type: array reference_number: type: string revoked_at: description: Not implemented format: date-time type: string rfq: description: Id of the RFQ to which this quote is related format: uuid type: string service_level: $ref: '#/components/schemas/ServiceLevel' source_type: enum: - INSTANT - MANUAL - PRIVATE_MARKETPLACE type: string spot_negotiation_quote: $ref: '#/components/schemas/SpotNegotiationQuoteInfo' total: description: Sum of all the charge line items of this quote format: float type: number transit_days: format: int32 type: integer updated_at: format: date-time type: string ups_direct_quote: $ref: '#/components/schemas/UPSDirectQuote' usps_direct_quote: $ref: '#/components/schemas/USPSDirectQuote' type: object QuoteChargeLineItem: allOf: - $ref: '#/components/schemas/AbstractChargeLineItem' - properties: is_provider_markup: type: boolean quote: description: Id of the Quote to which this line item is related format: uuid type: string type: object type: object RFQ: allOf: - $ref: '#/components/schemas/SlimRFQ' - properties: fedex_specific_options: $ref: '#/components/schemas/FedexShipmentOptions' parent_rfq: $ref: '#/components/schemas/SlimRFQ' quotes: description: All Quotes extended to this RFQ items: $ref: '#/components/schemas/Quote' type: array spot_negotiations: description: All the active SpotNegotiations of the RFQ items: $ref: '#/components/schemas/SpotNegotiation' type: array ups_specific_options: $ref: '#/components/schemas/UPSShipmentOptions' usps_specific_options: $ref: '#/components/schemas/USPSShipmentOptions' type: object type: object RMISAPIAccountRequest: properties: password: type: string username: type: string required: - username - password type: object RMISAPIAccountResponse: properties: company: format: uuid type: string id: format: uuid type: string job_status: $ref: '#/components/schemas/SlimRMISJobStatus' username: type: string required: - username type: object RMISAgreement: properties: agree: type: boolean contact: type: string date: format: date-time type: string title: type: string required: - date - contact - agree type: object RMISCarrier: properties: address_1: type: string address_2: type: string agreement: $ref: '#/components/schemas/RMISAgreement' certified_status_date: format: date-time type: string city: type: string client_carrier_agreement_rule_overrides: items: $ref: '#/components/schemas/RMISClientCarrierAgreementRuleOverride' type: array client_carrier_agreements: items: $ref: '#/components/schemas/RMISClientCarrierAgreement' type: array clients_carrier_id: type: string contact: type: string contacts: items: $ref: '#/components/schemas/RMISContact' type: array coverages: items: $ref: '#/components/schemas/RMISCoverage' type: array documents: items: $ref: '#/components/schemas/RMISDocument' type: array dot: $ref: '#/components/schemas/RMISDot' dot_number: type: string dot_sms_safety: $ref: '#/components/schemas/RMISDotSmsSafety' dot_testing_info: $ref: '#/components/schemas/RMISDotTestingInfo' duns: type: string email: type: string equipment_types: items: $ref: '#/components/schemas/RMISEquipmentType' type: array insd_intra_state_number: type: string insd_intra_state_state: type: string is_certified: type: boolean mc_number: type: string name: type: string non_certified_reasons: items: $ref: '#/components/schemas/RMISNonCertifiedReason' type: array overrides: items: $ref: '#/components/schemas/RMISOverride' type: array pay_to: type: string pay_to_address: type: string pay_to_address_2: type: string pay_to_city: type: string pay_to_country: type: string pay_to_email: type: string pay_to_state: type: string pay_to_zip: type: string phone: type: string profile: $ref: '#/components/schemas/RMISCarrierProfile' rmis_carrier_id: type: integer state: type: string title: type: string w9: $ref: '#/components/schemas/RMISW9' zip: type: string required: - name - rmis_carrier_id type: object RMISCarrierProfile: properties: bulk_trailer_count: type: integer cargo_vans: type: integer company_drivers: type: integer company_rep: type: string diversity_cert_agency: type: string double_drops: type: integer dry_vans: type: integer dump: type: integer email_received: type: boolean expected_first_move_time: type: string flat_bed_48_foot: type: integer flat_bed_53_foot: type: integer flat_beds: type: integer garment_trailer: type: integer has_can_auth: type: boolean has_carb_cert: type: boolean has_ctpat_cert: type: boolean has_fast_cert: type: boolean has_mex_interchange: type: boolean has_safety_permit_hm_32: type: boolean has_smartway_cert: type: boolean has_twice_cert: type: boolean hazmat_cert_verified_by_rmis: type: boolean hazmat_certified: type: boolean heated_vans: type: integer hopper: type: integer intermodal_trailer_count: type: integer is_factoring: type: boolean is_special_contract: type: boolean maxi: type: integer minority_women_owned: type: string no_w9: type: boolean open_top: type: integer other_trailer_count: type: integer owner_operators: type: integer pad_wrap: type: boolean payee_type: type: string payment_type: type: string primary_equipment_type: type: string reefer_48_foot: type: integer reefer_53_foot: type: integer refrigerated_vans: type: integer rgn: type: integer scac: type: string small_business_type: type: string step_decks: type: integer straight_trucks: type: integer straps: type: boolean super_van: type: integer tanker_trailer_count: type: integer teams: type: integer tractor_count: type: integer tri_axle_vans: type: boolean vans_48_foot: type: integer vans_53_foot: type: integer vented_vans: type: boolean walking_floor: type: integer wc_waiver_contact: type: string wc_waiver_date: format: date-time type: string years_in_business: type: integer required: - hazmat_cert_verified_by_rmis type: object RMISClientCarrierAgreement: properties: agree: type: boolean agreement_id: type: number contact: type: string contact_title: type: string date: format: date-time type: string title: type: string required: - title - date - contact - contact_title - agree type: object RMISClientCarrierAgreementRuleOverride: properties: agreement_title: type: string client_agreement_id: type: integer expiration_date: format: date-time type: string note: type: string override_date: format: date-time type: string override_edit_by: type: string required: - client_agreement_id - agreement_title - expiration_date - override_date - override_edit_by type: object RMISContact: properties: cell: type: string company_name: type: string contact_type: type: string email: type: string fax: type: string name: type: string phone: type: string title: type: string required: - contact_type type: object RMISCoverage: properties: am_best_company_number: type: string cancel_date: format: date type: string confidence: type: string confidence_msg: type: string description: type: string effective_date: format: date type: string expiration_date: format: date type: string is_renewal: type: boolean last_cert_update: format: date-time type: string limits: items: $ref: '#/components/schemas/RMISCoverageLimits' type: array naic_company_number: type: string policy_number: type: string producer: type: string producer_address: type: string producer_city: type: string producer_email: type: string producer_fax: type: string producer_phone: type: string producer_state: type: string producer_zip: type: string renewal_on_file_cert_id: type: integer renewal_on_file_effective_date: format: date type: string renewal_on_file_expiration_date: format: date type: string renewal_on_file_image_id: type: integer rmis_cert_id: type: string rmis_covg_id: type: string rmis_image_id: type: integer status: type: string underwriter: type: string underwriting_rating: type: string required: - description - is_renewal type: object RMISCoverageDetails: properties: description: type: string required: - description type: object RMISCoverageLimits: properties: amount: type: number currency: type: string description: type: string details: items: $ref: '#/components/schemas/RMISCoverageDetails' type: array is_auto_synonym: type: boolean is_cargo_synonym: type: boolean required: - description - amount - is_cargo_synonym - is_auto_synonym type: object RMISDocument: properties: create_date_pst: format: date-time type: string description: type: string document_id: type: integer file_size: type: string file_type: type: string upload_by: type: string upload_mode: type: string required: - document_id - description - create_date_pst - file_type - file_size - upload_by - upload_mode type: object RMISDot: properties: address_status: type: boolean bipd_on_file: type: string bipd_required: type: string bond_surety_on_file: type: boolean bond_surety_required: type: boolean broker_authority: type: boolean broker_authority_revocation: type: boolean business_address: type: string business_city: type: string business_country: type: string business_fax: type: string business_phone: type: string business_state: type: string business_zip: type: string cargo_on_file: type: boolean cargo_required: type: boolean common_authority: type: boolean common_authority_revocation: type: boolean contract_authority: type: boolean contract_authority_revocation: type: boolean dba_name: type: string docket_number: type: string household_goods: type: boolean last_updated: format: date-time type: string legal_name: type: string mailing_address: type: string mailing_city: type: string mailing_country: type: string mailing_fax: type: string mailing_phone: type: string mailing_state: type: string mailing_zip: type: string passenger: type: boolean pending_broker_authority: type: boolean pending_common_authority: type: boolean pending_contract_authority: type: boolean us_dot_number: type: string required: - docket_number - us_dot_number - common_authority - contract_authority - broker_authority - pending_common_authority - pending_contract_authority - pending_broker_authority - common_authority_revocation - contract_authority_revocation - broker_authority_revocation type: object RMISDotSmsSafety: properties: controlled_substance_basic_alert: type: boolean controlled_substance_percentile: type: number controlled_substance_roadside_alert: type: boolean controlled_substance_serious_violation: type: boolean driver_fitness_basic_alert: type: boolean driver_fitness_percentile: type: number driver_fitness_roadside_alert: type: boolean driver_fitness_serious_violation: type: boolean driver_insp_total: type: number driver_oos_insp_total: type: number fatigued_driver_percentile: type: number fatigued_driving_basic_alert: type: boolean fatigued_driving_serious_violation: type: boolean fatigued_unsafe_driving_roadside_alert: type: boolean insp_total: type: number unsafe_driving_basic_alert: type: boolean unsafe_driving_percentile: type: number unsafe_driving_roadside_alert: type: boolean unsafe_driving_serious_violation: type: boolean update_date: format: date-time type: string us_dot_number: type: string vehicle_insp_total: type: number vehicle_maint_basic_alert: type: boolean vehicle_maint_percentile: type: number vehicle_maint_roadside_alert: type: boolean vehicle_maint_serious_violation: type: boolean vehicle_oos_insp_total: type: number required: - us_dot_number type: object RMISDotTestingInfo: properties: latest_authority_grant_date: format: date type: string latest_authority_reinstated_date: format: date type: string operating_status: enum: - ACTIVE - AUTHORIZED_FOR_HHG - AUTHORIZED_FOR_PASSENGER - AUTHORIZED_FOR_PROPERTY - INACTIVE_USDOT_NUMBER - NOT_AUTHORIZED - OUT_OF_SERVICE type: string original_authority_grant_date: format: date type: string out_of_service_date: format: date-time type: string safer_active: type: boolean safer_active_last_check_date: format: date-time type: string safety_rating: type: string safety_rating_date: format: date-time type: string safety_review_date: format: date-time type: string safety_review_type: type: string tot_pwr: type: number tot_trucks: type: number required: - safer_active type: object RMISEquipmentType: properties: code: type: string date_added: format: date-time type: string description: type: string required: - description - code - date_added type: object RMISFTPAccountRequest: properties: password: type: string username: type: string required: - username - password type: object RMISFTPAccountResponse: properties: company: format: uuid type: string id: format: uuid type: string job_status: $ref: '#/components/schemas/SlimRMISJobStatus' username: type: string required: - username type: object RMISJobStatus: properties: error_message: type: string id: format: uuid type: string profiles_created: type: integer profiles_deleted: type: integer profiles_not_matched: type: integer profiles_updated: type: integer type: enum: - FTP - API type: string required: - id - type - profiles_updated type: object RMISNonCertifiedReason: properties: reason: type: string required: - reason type: object RMISOverride: properties: authorized_by: type: string create_date: format: date-time type: string created_by: type: string expiration_date: format: date-time type: string type: type: string required: - type - create_date - expiration_date - authorized_by - created_by type: object RMISW9: properties: address: type: string business_name: type: string city: type: string co_name: type: string company_type: type: string contact_name: type: string exempt_fata_code: type: string exempt_payee_code: type: string is_exempt_payee: type: boolean is_limited_liab_co: type: boolean limited_liab_tax_class: type: string state: type: string tax_id: type: string tax_id_ein: type: string tax_id_ssn: type: string timestamp: format: date-time type: string tin_checked_by: type: string tin_checked_date: format: date-time type: string tin_class_other: type: string tin_is_valid: type: boolean tin_validation_reason: type: string w9_id: type: integer zip: type: string required: - timestamp - tax_id - co_name type: object RecordedELDProvider: description: Recorded eld provider for a carrier relationship properties: created_at: format: date-time type: string freight_authority_vendor_relationship: format: uuid type: string id: format: uuid type: string label: type: string supported_provider_name: enum: - eroad - fleetmatics - fleetup - geotab - ise - jjkeller - keep_truckin - omnitracs_vlv - peoplenet - samsara - teletrac - zonar - other type: string type: object RecordedEquipmentType: description: Recorded equipment type for a carrier relationship properties: created_at: format: date-time type: string eld_provider: enum: - eroad - fleetmatics - fleetup - geotab - ise - jjkeller - keep_truckin - omnitracs_vlv - peoplenet - samsara - teletrac - zonar type: string equipment_metadata: description: Accepted values - Air Rides, High Cube (110"), Logistic Padded, Alchohol, EDI Capable, Step-Decks, Hot Shots, Double Drops, RGN items: type: string type: array freight_authority_vendor_relationship: format: uuid type: string id: format: uuid type: string quantity: format: int32 type: integer type: object RegisterFedex: properties: account_number: type: string billing_address: $ref: '#/components/schemas/GenesisAddress' contact: properties: company_name: type: string email_address: type: string first_name: type: string last_name: type: string phone_number: type: string required: - first_name - last_name - company_name - phone_number - email_address type: object freight_account: $ref: '#/components/schemas/FedexFreightAccount' secondary_email: type: string shipping_address: $ref: '#/components/schemas/GenesisAddress' smart_post_hub_id: type: integer required: - account_number - shipping_address - contact - billing_address type: object RegisterFedexResponse: allOf: - $ref: '#/components/schemas/RegisterFedex' - properties: messages: items: type: string type: array RegisterUPS: properties: account_number: type: string address: $ref: '#/components/schemas/GenesisAddress' company: type: string email: type: string invoice_amount: format: float type: number invoice_control_id: type: string invoice_currency: type: string invoice_date: format: date type: string invoice_number: type: string name: type: string phone: type: string required: - account_number - company - email - name - phone - address type: object RegisterUPSResponse: properties: account_number: type: string required: - account_number type: object SaferWatchAccountRequest: properties: customer_key: type: string required: - customer_key type: object SaferWatchAccountResponse: properties: company: format: uuid type: string id: format: uuid type: string job_status: $ref: '#/components/schemas/SaferWatchJobStatus' type: object SaferWatchAuthority: properties: auth_grant_date: type: string broker_authority: type: boolean broker_authority_pending: type: boolean broker_authority_revocation: type: boolean common_authority: type: string common_authority_pending: type: boolean common_authority_revocation: type: boolean contract_authority: type: string contract_authority_pending: type: boolean contract_authority_revocation: type: boolean enterprise: type: boolean freight: type: boolean household_goods: type: boolean passenger: type: boolean private: type: boolean type: object SaferWatchCargo: properties: cargo_beverages: type: boolean cargo_bldg_material: type: boolean cargo_chemicals: type: boolean cargo_coalcoke: type: boolean cargo_construction: type: boolean cargo_drive_tow: type: boolean cargo_dry_bulk: type: boolean cargo_farm_supplies: type: boolean cargo_garbage: type: boolean cargo_gen_freight: type: boolean cargo_grainfeed: type: boolean cargo_household: type: boolean cargo_intermodal: type: boolean cargo_liq_gas: type: boolean cargo_livestock: type: boolean cargo_log_pole: type: boolean cargo_mach_large: type: boolean cargo_meat: type: boolean cargo_metal: type: boolean cargo_mobile_home: type: boolean cargo_motor_veh: type: boolean cargo_oilfield: type: boolean cargo_other: type: boolean cargo_other_desc: type: boolean cargo_paper_prod: type: boolean cargo_passengers: type: boolean cargo_produce: type: boolean cargo_refrigerated: type: boolean cargo_us_mail: type: boolean cargo_utilities: type: boolean cargo_waterwell: type: boolean hazmat_indicator: type: boolean type: object SaferWatchCarrier: properties: authority: $ref: '#/components/schemas/SaferWatchAuthority' cargo: $ref: '#/components/schemas/SaferWatchCargo' carrier_type: type: string cert_data: $ref: '#/components/schemas/SaferWatchCertData' crash: $ref: '#/components/schemas/SaferWatchCrash' docket_number: type: string dot_number: format: int32 type: number drivers: $ref: '#/components/schemas/SaferWatchDrivers' equipment: $ref: '#/components/schemas/SaferWatchEquipment' fmcsa_insurance: $ref: '#/components/schemas/SaferWatchFmcsaInsurance' identity: $ref: '#/components/schemas/SaferWatchIdentity' inspection: $ref: '#/components/schemas/SaferWatchInspection' operation: $ref: '#/components/schemas/SaferWatchOperation' other: $ref: '#/components/schemas/SaferWatchOther' review: $ref: '#/components/schemas/SaferWatchReview' risk_assessment: $ref: '#/components/schemas/SaferWatchRiskAssessment' safety: $ref: '#/components/schemas/SaferWatchSafety' type: object SaferWatchCarrierPolicy: description: SaferWatch carrier policy settings. properties: cargo_insurance_amount_policy: $ref: '#/components/schemas/CarrierStatus' cargo_insurance_amount_threshold: format: int32 type: integer cargo_insurance_expiration_policy: $ref: '#/components/schemas/CarrierStatus' cargo_insurance_expiration_threshold: format: int32 type: integer certification_status_acceptable: $ref: '#/components/schemas/CarrierStatus' certification_status_moderate: $ref: '#/components/schemas/CarrierStatus' certification_status_unacceptable: $ref: '#/components/schemas/CarrierStatus' company_id: type: string insurance_rating_policy: $ref: '#/components/schemas/CarrierStatus' insurance_rating_threshold: type: string insurance_status_active: $ref: '#/components/schemas/CarrierStatus' insurance_status_inactive: $ref: '#/components/schemas/CarrierStatus' operating_authority_status_active: $ref: '#/components/schemas/CarrierStatus' operating_authority_status_authorized: $ref: '#/components/schemas/CarrierStatus' operating_authority_status_inactive: $ref: '#/components/schemas/CarrierStatus' operating_authority_status_not_authorized: $ref: '#/components/schemas/CarrierStatus' operating_authority_status_out_of_service: $ref: '#/components/schemas/CarrierStatus' safety_rating_date_policy: $ref: '#/components/schemas/CarrierStatus' safety_rating_date_threshold: format: int32 type: integer safety_rating_status_conditional: $ref: '#/components/schemas/CarrierStatus' safety_rating_status_non_satisfactory: $ref: '#/components/schemas/CarrierStatus' safety_rating_status_satisfactory: $ref: '#/components/schemas/CarrierStatus' safety_rating_status_unrated: $ref: '#/components/schemas/CarrierStatus' required: - operating_authority_status_active - operating_authority_status_authorized - operating_authority_status_inactive - operating_authority_status_not_authorized - operating_authority_status_out_of_service - safety_rating_status_satisfactory - safety_rating_status_non_satisfactory - safety_rating_status_conditional - safety_rating_status_unrated - safety_rating_date_threshold - safety_rating_date_policy - insurance_status_active - insurance_status_inactive - insurance_rating_threshold - insurance_rating_policy - cargo_insurance_expiration_threshold - cargo_insurance_expiration_policy - cargo_insurance_amount_threshold - cargo_insurance_amount_policy - certification_status_acceptable - certification_status_moderate - certification_status_unacceptable type: object SaferWatchCertData: properties: certificates: items: $ref: '#/components/schemas/SaferWatchCertificate' type: array non_coop_reason: type: string status: type: string type: object SaferWatchCertificate: properties: certificate_id: type: string coverages: items: $ref: '#/components/schemas/SaferWatchCoverage' type: array paid_for: type: boolean producer_address: type: string producer_city: type: string producer_email: type: string producer_fax: type: string producer_name: type: string producer_phone: type: string producer_state: type: string producer_zip: type: string type: object SaferWatchCoverage: properties: am_best_rating: type: string coverage_limit: type: string coverage_type: type: string deductable: type: string expiration_date: type: string insurer_name: type: string policy_number: type: string refer_break_deduct: type: string refer_breakdown: type: boolean type: object SaferWatchCrash: properties: crash_fatal_can: format: int32 type: integer crash_fatal_us: format: int32 type: integer crash_injury_can: format: int32 type: integer crash_injury_us: format: int32 type: integer crash_total_can: format: int32 type: integer crash_total_us: format: int32 type: number crash_tow_can: format: int32 type: integer crash_tow_us: format: int32 type: integer type: object SaferWatchDrivers: properties: drivers_avg_leased: format: int32 type: integer drivers_cdl: format: int32 type: integer drivers_inter: format: int32 type: integer drivers_inter_gt_100: format: int32 type: integer drivers_inter_lt_100: format: int32 type: integer drivers_intra: format: int32 type: integer drivers_intra_gt_100: format: int32 type: integer drivers_intra_lt_100: format: int32 type: integer drivers_total: format: int32 type: integer type: object SaferWatchEquipment: properties: fleetsize: format: int32 type: integer total_power: format: int32 type: integer tractors_owned: format: int32 type: integer tractors_term: format: int32 type: integer tractors_trip: format: int32 type: integer trailers_owned: format: int32 type: integer trailers_term: format: int32 type: integer trailers_trip: format: int32 type: integer trucks_owned: format: int32 type: integer trucks_term: format: int32 type: integer trucks_total: format: int32 type: integer trucks_trip: format: int32 type: integer type: object SaferWatchFmcsaInsurance: properties: bipd_on_file: type: string bipd_required: type: string bond_surety_on_file: type: boolean bond_surety_required: type: boolean cargo_on_file: type: boolean cargo_required: type: boolean policy_items: items: $ref: '#/components/schemas/SaferWatchPolicyItem' type: array type: object SaferWatchIdentity: properties: business_city: type: string business_colonia: type: string business_country: type: string business_fax: type: string business_phone: type: string business_state: type: string business_street: type: string business_zip_code: type: string cell_phone: type: string company_rep_1: type: string company_rep_2: type: string dba_name: type: string dun_bradstreet_num: type: string email_address: type: string legal_name: type: string mailing_city: type: string mailing_colonia: type: string mailing_country: type: string mailing_fax: type: string mailing_phone: type: string mailing_state: type: string mailing_street: type: string mailing_zip_code: type: string organization: type: string undeliverable_mail: type: boolean type: object SaferWatchInspection: properties: inspect_drv_can: format: int32 type: integer inspect_drv_oos_can: format: int32 type: integer inspect_drv_oos_pct_can: format: float type: number inspect_drv_oos_pct_us: format: float type: number inspect_drv_oos_us: format: int32 type: integer inspect_drv_us: format: int32 type: integer inspect_haz_oos_pct_us: format: float type: number inspect_haz_oos_us: format: int32 type: integer inspect_haz_us: format: int32 type: integer inspect_iep_oos_pct_us: format: float type: number inspect_iep_oos_us: format: int32 type: integer inspect_iep_us: format: int32 type: integer inspect_total_can: format: int32 type: integer inspect_total_iep_us: format: int32 type: integer inspect_total_us: format: int32 type: integer inspect_veh_can: format: int32 type: integer inspect_veh_oos_can: format: int32 type: integer inspect_veh_oos_pct_can: format: int32 type: integer inspect_veh_oos_pct_us: format: float type: number inspect_veh_oos_us: format: int32 type: integer inspect_veh_us: format: int32 type: integer type: object SaferWatchJobStatus: properties: is_running: type: boolean last_updated_at: format: date-time type: string type: object SaferWatchOperation: properties: carrier_operation: type: string class_auth_for_hire: type: boolean class_exempt_for_hire: type: boolean class_federal_government: type: boolean class_indian_nation: type: boolean class_local_government: type: boolean class_migrant: type: boolean class_other: type: string class_priv_pass_business: type: boolean class_priv_pass_non_business: type: boolean class_private_property: type: boolean class_state_government: type: boolean class_us_mail: type: boolean dot_add_date: type: string entity_broker: type: boolean entity_cargo_tank: type: boolean entity_carrier: type: boolean entity_freight_fowarder: type: boolean entity_shipper: type: boolean mx_operation_type: type: string mx_rfc_number: type: string operating_status: type: string out_of_service: type: boolean out_of_service_date: type: string out_of_service_reason: type: string shipper_operation: type: string type: object SaferWatchOther: properties: carb_tru: format: int32 type: integer smartway: format: int32 type: integer watchdog_reports: type: string type: object SaferWatchPolicyItem: properties: address: type: string am_best_rating: type: string attn_to_name: type: string cancellation_date: type: string city: type: string company_name: type: string country_code: type: string coverage_from: type: string coverage_to: type: string effective_date: type: string fax: type: string insurance_type: type: string phone: type: string policy_number: type: string postal_code: type: string posted_date: type: string state_code: type: string type: object SaferWatchReview: properties: accident_rate: format: float type: number accident_rate_prevent: format: float type: number mcs_150_date: type: string mcs_150_mile_year: type: string mcs_150_miles: format: float type: number review_date: type: string review_doc_num: type: string review_miles: format: float type: number review_type: type: string type: object SaferWatchRiskAssessment: properties: authority: type: string insurance: type: string operation: type: string other: type: string overall: type: string safety: type: string type: object SaferWatchSafety: properties: control_sub_alert: type: boolean control_sub_ot: type: boolean control_sub_pct: format: float type: number control_sub_sv: type: boolean control_sub_trend: type: string drv_fit_alert: type: boolean drv_fit_ot: type: boolean drv_fit_pct: format: float type: number drv_fit_sv: type: boolean drv_fit_trend: type: string hos_alert: type: boolean hos_ot: type: boolean hos_pct: format: float type: number hos_sv: type: boolean hos_trend: type: string rating: type: string rating_date: type: string unsafe_drv_alert: type: string unsafe_drv_ot: type: boolean unsafe_drv_pct: format: float type: number unsafe_drv_sv: type: boolean unsafe_drv_trend: type: string veh_maint_alert: type: boolean veh_maint_ot: type: boolean veh_maint_pct: format: float type: number veh_maint_sv: type: boolean veh_maint_trend: type: string type: object ScheduleShipmentPickupRequest: description: Details of a Shipment pickup properties: address: $ref: '#/components/schemas/Address' fedex_account: format: uuid type: string is_regularly_scheduled: type: boolean point_of_contact: $ref: '#/components/schemas/BasePointOfContact' provider_carrier_code: type: string provider_code: type: string scheduled_date: format: date type: string shipments: items: format: uuid type: string type: array special_instructions: type: string time_window_end: format: time type: string time_window_start: format: time type: string ups_account: format: uuid type: string usps_account: format: uuid type: string required: - scheduled_date - time_window_start - time_window_end - point_of_contact - provider_code - address type: object SendDocument: description: Send documents to recipient list via email properties: documents: description: List of document ids to attach to email items: format: uuid type: string type: array message: type: string recipient_emails: description: List of email addresses of recipients items: type: string type: array subject: type: string required: - documents - message - recipient_emails - subject type: object ServiceLevel: description: Standardized code for a shipment service level properties: code: type: string description: type: string id: format: int32 type: integer type: object ServiceLevelAgreement: properties: awarded_loads: format: int32 type: integer awarded_loads_interval: enum: - DAY - WEEK - MONTH type: string capacity: format: int32 type: integer capacity_interval: enum: - DAY - WEEK - MONTH - YEAR type: string committed_loads: format: int32 type: integer committed_loads_interval: enum: - DAY - WEEK - MONTH - YEAR type: string company: format: uuid type: string created_at: format: date-time type: string documents: items: $ref: '#/components/schemas/DocumentMetadata' type: array end_date: format: date type: string external_id: type: string id: format: int32 type: integer minimum_acceptance_interval: enum: - DAY - WEEK - MONTH - YEAR type: string minimum_acceptance_percent: format: float type: number minimum_on_time_delivery_interval: enum: - DAY - WEEK - MONTH type: string minimum_on_time_delivery_percent: format: float type: number minimum_on_time_pickup_interval: enum: - DAY - WEEK - MONTH type: string minimum_on_time_pickup_percent: format: float type: number name: type: string notes: type: string position: enum: - PRIMARY - SECONDARY - TERTIARY - BACKUP type: string start_date: format: date type: string status: enum: - ACTIVE - INACTIVE type: string updated_at: format: date-time type: string type: object ServiceLevelAgreementIntervals: enum: - DAY - WEEK - MONTH - YEAR type: string ServiceLevelAgreementStatuses: enum: - ACTIVE - INACTIVE type: string ShareShipment: description: Request/response body for sharing a Shipment properties: external_link: description: Read-only link to a share Shipment page type: string recipient_emails: description: Emails that should receive a link to the Shipment items: format: email type: string type: array type: object Shipment: allOf: - $ref: '#/components/schemas/BaseShipment' - properties: carrier_reference_code: type: string current_carrier: $ref: '#/components/schemas/Company' fedex_specific_options: $ref: '#/components/schemas/FedexShipmentOptions' most_recently_awarded_quote: $ref: '#/components/schemas/Quote' most_recently_awarded_quote_id: format: uuid type: string most_recently_awarded_tender: $ref: '#/components/schemas/TenderGet' most_recently_awarded_tender_id: format: uuid type: string ups_specific_options: $ref: '#/components/schemas/UPSShipmentOptions' usps_specific_options: $ref: '#/components/schemas/USPSShipmentOptions' type: object type: object ShipmentAlertLevel: enum: - HIGH - MEDIUM - LOW type: string ShipmentCase: description: A case which is assigned to a shipment properties: assignee: $ref: '#/components/schemas/User' created_at: format: date-time type: string created_by_user: $ref: '#/components/schemas/User' description: type: string id: format: uuid type: string is_open: type: boolean title: type: string updated_at: format: date-time type: string type: object ShipmentChargeLineItem: allOf: - $ref: '#/components/schemas/AbstractChargeLineItem' - properties: created_at: format: date-time type: string prepaid_amount: description: Amount on the charge line item that is prepaid. Assumed to always be in the currency of the unit amount format: float type: number updated_at: format: date-time type: string vendor_assignment: description: Id of the VendorAssignment to which this line item is related format: uuid type: string type: object description: 'Line item recording a charge that some vendor is charging their customer for a shipment ' type: object ShipmentCustomData: additionalProperties: {} description: Custom data for Shipment type: object x-is-free-form: false ShipmentDocumentMetadata: allOf: - $ref: '#/components/schemas/DocumentMetadata' - properties: company: type: string driver: description: Id of the driver who created the document, if one exists format: uuid type: string is_carrier_document: type: boolean shipment: format: uuid type: string type: enum: - BOL - FUEL - LUMPER - HOS - SIGNATURE - RATE_CONFIRMATION - CUSTOMER_TENDER - DELIVERY_RECEIPT - WEIGHT_CERTIFICATE - OVERAGES_SHORTAGES_AND_DAMAGES - INVOICE - INSURANCE - SHIPPING_LABEL - CUSTOMS_PAPERWORK - PACKING_SLIPS - OTHER type: string type: object description: Metadata about a document type: object ShipmentLineItem: allOf: - $ref: '#/components/schemas/BaseProductDescription' - properties: custom_data: $ref: '#/components/schemas/ShipmentLineItemCustomData' dry_ice_unit: default: LB type: string dry_ice_weight: format: float type: number insured_value: type: number insured_value_currency: default: USD enum: - CAD - USD type: string purchase_order: description: Optional id of PurchaseOrder to which line item is associated format: uuid type: string purchase_order_line_item_id: description: Optional id of PurchaseOrderLineItem to which shipment line item is associated format: uuid type: string total_line_item_weight: description: Read-only weight of the ShipmentLineItem format: float type: number total_packages: format: int32 type: integer total_pieces: format: int32 type: integer type: object required: - id type: object ShipmentLineItemCustomData: additionalProperties: {} description: Custom data for ShipmentLineItem type: object x-is-free-form: false ShipmentMessage: description: Message about a shipment properties: created_at: format: date-time type: string id: format: uuid type: string message: type: string sender_avatar: type: string sender_id: format: uuid type: string sender_name: type: string shipment: format: uuid type: string updated_at: format: date-time type: string required: - message - shipment type: object ShipmentMetadata: description: Contextual metadata about a shipment properties: alert_level: enum: - HIGH - MEDIUM - LOW type: string alert_message: type: string archived: type: boolean automation_enabled: type: boolean bill_to_override: $ref: '#/components/schemas/BillToOverride' buy_it_now_amount: format: float type: number buy_it_now_amount_currency: enum: - CAD - USD type: string custom_data: $ref: '#/components/schemas/ShipmentMetadataCustomData' customer_side_accessorial_charge_table: description: Link to the AccessorialChargeTable used to access charges on the shipment customer format: uuid type: string customer_side_fuel_surcharge_table: description: Link to the FuelSurchargeTable used to access charges on the shipment customer format: uuid type: string has_open_auction: type: boolean load_board_enabled: type: boolean load_board_id: type: string max_buy_amount: type: number max_buy_amount_currency: enum: - CAD - USD type: string open: type: boolean pending_tender_acceptance: type: boolean tags: description: List of ShipmentTag ids items: format: uuid type: string type: array vendor_side_accessorial_charge_table: description: Link to the AccessorialChargeTable used to access charges on the shipment vendor format: uuid type: string vendor_side_fuel_surcharge_table: description: Link to the FuelSurchargeTable used to access charges on the shipment vendor format: uuid type: string required: - open - tags type: object ShipmentMetadataCustomData: additionalProperties: {} description: Custom data for ShipmentMetadata type: object x-is-free-form: false ShipmentMode: description: Standardized code for a shipment mode properties: code: type: string description: type: string id: format: int32 type: integer type: object ShipmentModeStatus: description: Shipment modes and their associated shipment statuses as a list properties: drayage: items: type: string type: array ftl: items: type: string type: array ltl: items: type: string type: array parcel: items: type: string type: array vltl: items: type: string type: array type: object ShipmentNote: description: Note about a shipment or shipment quote properties: company: format: uuid type: string created_at: format: date-time type: string creator_avatar: type: string creator_full_name: type: string creator_id: format: uuid type: string id: format: uuid type: string is_pinned: type: boolean message: type: string shipment: format: uuid type: string updated_at: format: date-time type: string type: object ShipmentPickup: allOf: - $ref: '#/components/schemas/ScheduleShipmentPickupRequest' - description: Details of a Shipment pickup properties: cancelled_at: format: date-time type: string created_at: format: date-time type: string fedex_account: format: uuid type: string id: format: uuid type: string pickup_number: type: string provider_location_id: type: string shipments: items: $ref: '#/components/schemas/SlimShipment' type: array updated_at: format: date-time type: string ups_account: format: uuid type: string usps_account: format: uuid type: string required: - id - created_at - updated_at type: object ShipmentPosition: description: Latitude and longitude of a shipment. properties: id: format: uuid type: string latitude: format: float type: number longitude: format: float type: number type: object ShipmentRep: description: User serving as a responsible party for a Shipment properties: id: format: uuid type: string role: $ref: '#/components/schemas/ShipmentRepRole' user: $ref: '#/components/schemas/User' type: object ShipmentRepRole: description: Role a ShipmentRep has on a Shipment properties: id: type: integer name: type: string required: - id - name type: object ShipmentRoute: description: Relevant data from the Here API route. properties: distance: format: float type: number id: format: uuid type: string route_legs: items: $ref: '#/components/schemas/ShipmentRouteLeg' type: array traffic_time: format: float type: number type: object ShipmentRouteLeg: description: Details of maneuvers between waypoints. properties: distance: format: float type: number id: format: uuid type: string positions: items: $ref: '#/components/schemas/ShipmentPosition' type: array traffic_time: format: float type: number type: object ShipmentSpotNegotiation: allOf: - $ref: '#/components/schemas/SpotNegotiation' - properties: shipment: $ref: '#/components/schemas/Shipment' type: object description: SpotNegotiation with extra details about its Shipment ShipmentState: properties: id: type: string label: type: string type: object ShipmentStatusEnum: enum: - appointment_pending - at_pickup - at_delivery - auction_running - cancelled - carrier_confirmed - delayed - delivered - dispatched - draft - in_transit - out_for_delivery - quote_accepted - quoting - reconciled - scheduled - tendered type: string ShipmentTag: description: Tag that can be applied to shipments properties: color: enum: - cherry_bomb - electric_trees - faded_white - lake_travis - ricky_fowler - rock_bottom - sky_ship - so_cirrus - the_hotness - well_water type: string company: format: uuid type: string id: format: uuid type: string name: type: string type: object ShipmentTimelineEvent: description: An event that took place during the life of the shipment properties: actor: $ref: '#/components/schemas/User' created_at: format: date-time type: string custom_data: $ref: '#/components/schemas/ShipmentTimelineEventCustomData' description: type: string event_sub_type: enum: - AT_DELIVERY - AT_LOCATION - AT_PICKUP - AT_STOP - CANCELED - DELAYED - DELIVERED - DELIVERED_EXCEPTION - DELIVERY - DELIVERY_APPOINTMENT - DELIVERY_MISSED - DEPARTED - DEPARTED_STOP - DEPARTURE - DEPARTURE_MISSED - DISPATCHED - EN_ROUTE - EXCEPTION - HELD - IN_TRANSIT - INFO - INTERLINE - INTERLINE_DELIVERED - INTERLINE_MISSED - OUT_FOR_DELIVERY - PICKED_UP - PICKUP - PICKUP_MISSED - STOP_CANCELLED - STOP_COMPLETED type: string event_type: enum: - AT_DELIVERY - AT_PICKUP - BOOKED - CANCELLED - CARRIER_MATCHED - DELIVERED - DETAILS_CHANGED - DISPATCHED - DRIVER_ASSIGNED - ETA_CHANGED - INFO - LOCATION_UPDATED - PICKED_UP - TRACK_RECEIVED - STOP_COMPLETED - STOP_EVENT type: string id: format: uuid type: string occurred_at: format: date-time type: string source: type: string updated_at: format: date-time type: string required: - description - event_type type: object ShipmentTimelineEventCustomData: additionalProperties: {} description: Custom data for ShipmentTimelineEvents type: object x-is-free-form: false Shipper: properties: billing_address: $ref: '#/components/schemas/Address' created_at: format: date-time type: string dba_name: type: string id: format: uuid type: string mailing_address: $ref: '#/components/schemas/Address' primary_email: type: string primary_phone_number: type: string updated_at: format: date-time type: string type: object ShipperRelationship: properties: account_reps: items: format: uuid type: string type: array bill_to_brokerage_by_default: description: 'Whether or not the brokerage requests that they be assigned as the bill-to party when they get tendered loads ' type: boolean broker_imposed_credit_limit: type: number can_book_with_rates: type: boolean can_quote_with_rates: type: boolean company: $ref: '#/components/schemas/CompanyWithOptionalUsers' created_at: format: date-time type: string custom_data: $ref: '#/components/schemas/CustomerCustomData' id: format: uuid type: string is_own_brokerage: type: boolean markup: $ref: '#/components/schemas/Markup' sales_reps: items: format: uuid type: string type: array updated_at: format: date-time type: string required: - markup - company - broker_imposed_credit_limit type: object ShipwellError: properties: error: type: string error_description: type: string field_errors: additionalProperties: items: type: string type: array type: object field_errors_condensed: items: properties: field_errors: items: type: string type: array field_name: type: string type: object type: array non_field_errors: items: type: string type: array required: - error - error_description type: object ShipwellHistoricalPricingSinglePrice: properties: carrier_cost: type: number carrier_email: type: string carrier_lane_run_count: type: number carrier_name: type: string carrier_phone_number: type: string do_date: description: Date string in of the form YYYY-MM-DD type: string freight_authority_vendor_relationship_id: type: string is_contract: type: boolean mc_number: type: string pu_date: description: Date string in of the form YYYY-MM-DD type: string reference_id: type: string shipment_id: type: string type: object ShopifyLogin: allOf: - $ref: '#/components/schemas/Login' - properties: shop: type: string type: object description: Shipwell login which ties account to Shopify ShopifySettings: properties: auto_apply_residential_accessorials: type: boolean can_book: type: boolean default_freight_class: type: number default_height: type: number default_length: type: number default_weight: type: number default_width: type: number dropoff_accessorials: items: $ref: '#/components/schemas/Accessorial' type: array enabled_carriers: items: $ref: '#/components/schemas/Company' type: array type: object SlimCarrierAssignment: allOf: - $ref: '#/components/schemas/CarrierAssignment' - properties: customer: $ref: '#/components/schemas/SlimCompany' vendor: $ref: '#/components/schemas/SlimCompany' type: object SlimCarrierRelationship: allOf: - $ref: '#/components/schemas/BaseCarrierRelationship' - properties: rmis_carrier_statuses: items: $ref: '#/components/schemas/SlimRMISCarrierStatus' type: array saferwatch_carrier_statuses: items: $ref: '#/components/schemas/SlimSaferWatchCarrierStatus' type: array type: object SlimCarrierStatusCarrierAssignment: allOf: - $ref: '#/components/schemas/SlimCarrierAssignment' - properties: carrier_status: enum: - ACTIVE - INACTIVE - DO_NOT_USE type: string type: object SlimCompany: properties: billing_emails: items: type: string type: array brokerage: format: uuid type: string carrier: format: uuid type: string created_at: format: date-time type: string dba_name: type: string id: format: uuid type: string is_shipwell: type: boolean name: type: string primary_email: type: string shipper: format: uuid type: string updated_at: format: date-time type: string required: - name type: object SlimPurchaseOrder: properties: id: format: uuid type: string order_number: type: string type: object SlimRFQ: properties: autoquote: description: 'Whether or not this RFQ should perform an autoquoting process ' type: boolean company_owner_id: format: uuid type: string created_at: format: date-time type: string creator: $ref: '#/components/schemas/User' did_finish_autoquote: description: Whether or not this RFQ completed an autoquoting process type: boolean equipment_types: items: $ref: '#/components/schemas/EquipmentType' type: array has_parent_rfq: type: boolean id: format: uuid type: string restrict_autoquote_to_companies: description: 'Array of Companies that, if provided, the autoquoting process will restrict its quote results to only rates that come from those vendor companies ' items: $ref: '#/components/schemas/SlimCompany' type: array shipment: description: Id of the Shipment for which this RFQ was created format: uuid type: string shipment_modes: items: $ref: '#/components/schemas/ShipmentMode' type: array spot_negotiations: description: All SpotNegotiation ids of the RFQ items: format: uuid type: string type: array updated_at: format: date-time type: string required: - autoquote - shipment type: object SlimRMISCarrier: properties: coverages: items: $ref: '#/components/schemas/SlimRMISCoverage' type: array dot: $ref: '#/components/schemas/SlimRMISDot' dot_testing_info: $ref: '#/components/schemas/SlimRMISDotTestingInfo' non_certified_reasons: items: type: string type: array status: enum: - CERTIFIED - NOT_CERTIFIED - UNKNOWN type: string status_date: format: date-time type: string updated_at: format: date-time type: string type: object SlimRMISCarrierStatus: properties: mc_number: type: string status: enum: - CERTIFIED - NOT_CERTIFIED - NOT_ON_RMIS - UNKNOWN type: string type: object SlimRMISCoverage: properties: description: type: string effective_date: format: date type: string expiration_date: format: date type: string limit: $ref: '#/components/schemas/SlimRMISCoverageLimit' policy_number: type: string status: type: string underwriter: type: string underwriting_rating: type: string type: object SlimRMISCoverageLimit: properties: amount: type: number currency: type: string type: object SlimRMISDot: properties: broker_authority: type: boolean broker_authority_revocation: type: boolean common_authority: type: boolean common_authority_revocation: type: boolean contract_authority: type: boolean contract_authority_revocation: type: boolean pending_broker_authority: type: boolean pending_common_authority: type: boolean pending_contract_authority: type: boolean type: object SlimRMISDotTestingInfo: properties: latest_authority_grant_date: format: date type: string operating_status: enum: - ACTIVE - AUTHORIZED_FOR_HHG - AUTHORIZED_FOR_PASSENGER - AUTHORIZED_FOR_PROPERTY - INACTIVE_USDOT_NUMBER - NOT_AUTHORIZED - OUT_OF_SERVICE type: string out_of_service_date: format: date-time type: string safety_rating: type: string safety_rating_date: format: date-time type: string safety_review_date: format: date-time type: string safety_review_type: type: string type: object SlimRMISJobStatus: properties: is_running: type: boolean last_updated_at: format: date-time type: string type: object SlimSaferWatchAuthority: properties: auth_grant_date: type: string broker_authority: type: boolean broker_authority_pending: type: boolean broker_authority_revocation: type: boolean common_authority: type: string common_authority_pending: type: boolean common_authority_revocation: type: boolean contract_authority: type: string contract_authority_pending: type: boolean contract_authority_revocation: type: boolean type: object SlimSaferWatchCarrier: properties: authority: $ref: '#/components/schemas/SlimSaferWatchAuthority' cert_data: $ref: '#/components/schemas/SlimSaferWatchCertData' dot_number: type: string fmcsa_insurance: $ref: '#/components/schemas/SlimSaferWatchFMCSAInsurance' mc_number: type: string name: type: string operating: $ref: '#/components/schemas/SlimSaferWatchOperation' review: $ref: '#/components/schemas/SlimSaferWatchReview' risk_assessment: $ref: '#/components/schemas/SlimSaferWatchRiskAssessment' safety: $ref: '#/components/schemas/SlimSaferWatchSafety' type: object SlimSaferWatchCarrierStatus: properties: mc_number: type: string status: type: string type: object SlimSaferWatchCertData: properties: certificates: items: $ref: '#/components/schemas/SlimSaferWatchCoverage' status: type: string type: object SlimSaferWatchCoverage: properties: am_best_rating: type: string coverage_limit: type: string coverage_type: type: string deductable: type: string expiration_date: type: string insurer_name: type: string policy_number: type: string type: object SlimSaferWatchFMCSAInsurance: properties: policy_items: items: $ref: '#/components/schemas/SlimSaferWatchPolicyItem' type: object SlimSaferWatchOperation: properties: operating_status: type: string out_of_service_date: type: string type: object SlimSaferWatchPolicyItem: properties: am_best_rating: type: string cancellation_date: type: string company_name: type: string coverage_to: type: string insurance_type: type: string policy_number: type: string type: object SlimSaferWatchReview: properties: review_date: type: string review_type: type: string type: object SlimSaferWatchRiskAssessment: properties: authority: type: string insurance: type: string operation: type: string other: type: string overall: type: string safety: type: string type: object SlimSaferWatchSafety: properties: rating: type: string rating_date: type: string type: object SlimShipment: allOf: - $ref: '#/components/schemas/BaseShipment' - properties: current_carrier: $ref: '#/components/schemas/SlimCompany' relationship_to_customer: $ref: '#/components/schemas/SlimCarrierAssignment' relationship_to_vendor: $ref: '#/components/schemas/SlimCarrierStatusCarrierAssignment' type: object type: object SlimShipmentLineItem: properties: id: format: uuid type: string purchase_order: $ref: '#/components/schemas/SlimPurchaseOrder' type: object SlimUser: properties: email: type: string first_name: type: string id: format: uuid type: string last_name: type: string phone_number: type: string required: - first_name - last_name - email type: object SpotNegotiation: properties: carrier_status: enum: - ACTIVE - INACTIVE - DO_NOT_USE type: string closed_by_customer_at: format: date-time type: string closed_by_vendor_at: format: date-time type: string created_at: format: date-time type: string customer: $ref: '#/components/schemas/SlimCompany' id: format: uuid type: string involved_customer_users: items: $ref: '#/components/schemas/User' type: array involved_vendor_users: items: $ref: '#/components/schemas/User' type: array is_most_recent_winner: type: boolean message_count: type: integer quotes: description: Optional list of quotes included on this spot negotiation items: $ref: '#/components/schemas/Quote' type: array updated_at: format: date-time type: string vendor: $ref: '#/components/schemas/SlimCompany' required: - involved_customer_users - involved_vendor_users type: object SpotNegotiationMessage: properties: created_at: format: date-time type: string id: format: uuid type: string message: type: string sender: $ref: '#/components/schemas/User' spot_negotiation: format: uuid type: string updated_at: format: date-time type: string type: object SpotNegotiationQuoteInfo: properties: declined_at: format: date-time type: string spot_negotiation: format: uuid type: string type: object Stop: properties: accessorials: items: $ref: '#/components/schemas/Accessorial' type: array alerts: items: $ref: '#/components/schemas/StopAlert' type: array appointment_type: $ref: '#/components/schemas/AppointmentType' carrier_specified_eta: $ref: '#/components/schemas/ETAWindow' confirmed_arrival_at: description: Optional of when the driver first arrived at the Stop format: date-time type: string confirmed_departure_at: description: Optional of when the Stop was departed format: date-time type: string created_at: format: date-time type: string custom_data: $ref: '#/components/schemas/StopCustomData' display_eta_window: type: string display_planned_window: type: string display_schedule: type: string eta_overridden_by: description: ID of user who marked ETA as overridden, if exists format: uuid type: string id: format: uuid type: string instructions: type: string internal_notes: type: string is_completed: description: Whether or not the Stop was completed type: boolean is_dropoff: type: boolean is_pickup: type: boolean location: $ref: '#/components/schemas/StopLocation' ordinal_index: format: int32 type: integer planned_date: description: Planned date of the stop, in string of the form YYYY-MM-DD type: string planned_time_window_end: format: time type: string planned_time_window_start: format: time type: string predictive_model_eta: $ref: '#/components/schemas/ETAWindow' deprecated: true status: enum: - AT_STOP - CANCELLED - DEPARTED - EN_ROUTE type: string status_reason_code: enum: - ACCIDENT - ALTERNATE_CARRIER_DELIVERED - ALTERNATE_CARRIER_PICKED_UP - AWAITING_IMPORT - BORDER_CLEARANCE - CARRIER_KEYING_ERROR - CARRIER_RELATED - CASH_NOT_AVAILABLE_FROM_CONSIGNEE - CIVIL_EVENT - COLLECT_ON_DELIVERY_REQUIRED - CONSIGNEE_CLOSED - CONSIGNEE_RELATED - CONTAMINATED - CREDIT_HOLD - CUSTOMER_REQUESTED_DIFFERENT_DELIVERY_WINDOW - CUSTOMS_DOCUMENTATION_PROBLEM - CUSTOMS_DOCUMENTATION_PROBLEMS - DAMAGED - DELIVERY_SHORTAGE - DRIVER_NOT_AVAILABLE - DRIVER_RELATED - EQUIPMENT_SHORTAGE - EQUIPMENT_VOLUME_NOT_AVAILABLE - EXCEEDS_SERVICE_LIMITATIONS - FAILED_TO_RELEASE_BILLING - HELD_FOR_FULL_CARRIER_LOAD - HELD_FOR_PAYMENT - HELD_FOR_PROTECTIVE_SERVICE - HELD_PENDING_APPOINTMENT - HOLIDAY_CLOSED - IMPROPER_FACILITY_OR_EQUIPMENT - IMPROPER_TEMPERATURE - INCONSISTENT_WEIGHT - INCORRECT_ADDRESS - INSUFFICIENT_DELIVERY_TIME - INSUFFICIENT_PICKUP_TIME - INSUFFICIENT_TRAVEL_TIME_DETECTED - INTERNATIONAL_NON_CARRIER_DELAY - MECHANICAL_BREAKDOWN - MISSING_DOCUMENTS - MIS_SORT - NON_EXPRESS_CLEARANCE_DELAY - NORMAL_APPOINTMENT - NORMAL_STATUS - NO_APPOINTMENT_SCHEDULED - NO_REQUESTED_ARRIVAL_DATE_OR_TIME - OTHER - PAST_CUT_OFF_TIME - PROCESSING_DELAY - RAILROAD_FAILED_TO_MEET_SCHEDULE - RECIPIENT_UNAVAILABLE - RECONSIGNED - RESTRICTED_ARTICLES_UNACCEPTABLE - RETURNED_TO_SHIPPER - ROAD_CONDITIONS - SHIPMENT_OVERWEIGHT - SHIPPER_RELATED - TRACKING_EVENT_AUTOMATED_CALL - TRACKING_EVENT_EDI_UPDATE - TRACKING_EVENT_ELD_UPDATE - TRACKING_EVENT_GEOFENCE_BREACH - TRACKING_EVENT_MANUAL_LOCATION_UPDATED - TRACKING_EVENT_MOBILE_APP - TRACKING_EVENT_MOBILE_APP_UPDATED_BY_DRIVER - TRAIN_DERAILMENT - UNABLE_TO_CONTACT_RECIPIENT - UNABLE_TO_LOCATE - UNKNOWN - WAITING_FOR_CUSTOMER_PICKUP - WAITING_INSPECTION - WAITING_SHIPPING_INSTRUCTIONS - WEATHER_OR_NATURAL_DISASTER type: string trip_management_eta: format: date-time type: string unconfirmed_arrival_at: description: Read-only. Geofence arrival time format: date-time type: string unconfirmed_departure_at: description: Read-only. Geofence departure time format: date-time type: string updated_at: format: date-time type: string required: - id - location - ordinal_index - is_dropoff - is_pickup type: object StopAlert: properties: alert_type: enum: - AT_RISK - DELAYED - EARLY - LATE - OTHER - WAITING - DETENTION type: string created_at: format: date-time type: string created_by_driver: description: Read-only. The driver that created the StopAlert. format: uuid type: string created_by_user: description: Read-only. The user that created the StopAlert. format: uuid type: string description: type: string expiration: format: date-time type: string id: format: uuid type: string location: $ref: '#/components/schemas/Address' occurred_at: format: date-time type: string reason_code: enum: - ACCIDENT - ALTERNATE_CARRIER_DELIVERED - ALTERNATE_CARRIER_PICKED_UP - AWAITING_IMPORT - BORDER_CLEARANCE - CARRIER_KEYING_ERROR - CARRIER_RELATED - CASH_NOT_AVAILABLE_FROM_CONSIGNEE - CIVIL_EVENT - COLLECT_ON_DELIVERY_REQUIRED - CONSIGNEE_CLOSED - CONSIGNEE_RELATED - CONTAMINATED - CREDIT_HOLD - CUSTOMER_REQUESTED_DIFFERENT_DELIVERY_WINDOW - CUSTOMS_DOCUMENTATION_PROBLEM - CUSTOMS_DOCUMENTATION_PROBLEMS - DAMAGED - DELIVERY_SHORTAGE - DRIVER_NOT_AVAILABLE - DRIVER_RELATED - EQUIPMENT_SHORTAGE - EQUIPMENT_VOLUME_NOT_AVAILABLE - EXCEEDS_SERVICE_LIMITATIONS - FAILED_TO_RELEASE_BILLING - HELD_FOR_FULL_CARRIER_LOAD - HELD_FOR_PAYMENT - HELD_FOR_PROTECTIVE_SERVICE - HELD_PENDING_APPOINTMENT - HOLIDAY_CLOSED - IMPROPER_FACILITY_OR_EQUIPMENT - IMPROPER_TEMPERATURE - INCONSISTENT_WEIGHT - INCORRECT_ADDRESS - INSUFFICIENT_DELIVERY_TIME - INSUFFICIENT_PICKUP_TIME - INSUFFICIENT_TRAVEL_TIME_DETECTED - INTERNATIONAL_NON_CARRIER_DELAY - MECHANICAL_BREAKDOWN - MISSING_DOCUMENTS - MIS_SORT - NON_EXPRESS_CLEARANCE_DELAY - NORMAL_APPOINTMENT - NORMAL_STATUS - NO_APPOINTMENT_SCHEDULED - NO_REQUESTED_ARRIVAL_DATE_OR_TIME - OTHER - PAST_CUT_OFF_TIME - PROCESSING_DELAY - RAILROAD_FAILED_TO_MEET_SCHEDULE - RECIPIENT_UNAVAILABLE - RECONSIGNED - RESTRICTED_ARTICLES_UNACCEPTABLE - RETURNED_TO_SHIPPER - ROAD_CONDITIONS - SHIPMENT_OVERWEIGHT - SHIPPER_RELATED - TRACKING_EVENT_AUTOMATED_CALL - TRACKING_EVENT_EDI_UPDATE - TRACKING_EVENT_ELD_UPDATE - TRACKING_EVENT_GEOFENCE_BREACH - TRACKING_EVENT_MANUAL_LOCATION_UPDATED - TRACKING_EVENT_MOBILE_APP - TRACKING_EVENT_MOBILE_APP_UPDATED_BY_DRIVER - TRAIN_DERAILMENT - UNABLE_TO_CONTACT_RECIPIENT - UNABLE_TO_LOCATE - UNKNOWN - WAITING_FOR_CUSTOMER_PICKUP - WAITING_INSPECTION - WAITING_SHIPPING_INSTRUCTIONS - WEATHER_OR_NATURAL_DISASTER type: string stop: format: uuid type: string updated_at: format: date-time type: string required: - alert_type type: object StopCustomData: additionalProperties: {} description: Custom data for Stop type: object x-is-free-form: false StopLocation: properties: address: $ref: '#/components/schemas/Address' company_name: type: string created_at: format: date-time type: string dock_external_id: type: string dock_hours_end: format: time type: string dock_hours_start: format: time type: string id: format: uuid type: string identification_code: type: string location_name: type: string location_type: $ref: '#/components/schemas/LocationType' notes: type: string point_of_contacts: items: $ref: '#/components/schemas/PointOfContact' type: array updated_at: format: date-time type: string required: - address - location_name type: object SupplierInvite: description: A user's supplier invite properties: allow_autobook: type: boolean booked_at: format: date-time type: string company: format: uuid type: string created_at: format: date-time type: string customer: format: uuid type: string express_delivery: type: boolean key: type: string message_to_supplier: type: string po_number: type: string revoked_at: format: date-time type: string sent_by_user: format: uuid type: string shipment: format: uuid type: string shipment_created_at: format: date-time type: string status: enum: - BOOKED - CANCELLED - REQUESTED - UNABLE_TO_BOOK - PENDING_BOOKING type: string supplier_email_address: format: email type: string required: - supplier_email_address type: object SupplierInviteResponse: allOf: - $ref: '#/components/schemas/SupplierInvite' - properties: shipment: $ref: '#/components/schemas/SlimShipment' user: $ref: '#/components/schemas/User' type: object type: object Task: description: A task properties: assignee: $ref: '#/components/schemas/User' case: format: uuid type: string created_at: format: date-time type: string created_by_user: $ref: '#/components/schemas/User' description: type: string due_date: format: date-time type: string id: format: uuid type: string is_open: type: boolean shipment: format: uuid type: string updated_at: format: date-time type: string required: - description type: object TeletracCredentials: description: Credentials for connecting to Teletrac properties: owner_id: type: string required: - owner_id type: object TenderAcceptReject: properties: rejection_code: enum: - A13 - EQU - CPU - LL1 - LL2 - CNA - ASE type: string rejection_reason: type: string type: enum: - ACCEPT - REJECT type: string required: - type title: TenderAcceptReject type: object TenderAppointmentEventRequest: properties: created_at: format: date-time type: string notes: type: string recorded_at: format: date-time type: string stop_sequence_id: minimum: 1 type: number window_end: format: date-time type: string window_start: format: date-time type: string required: - stop_sequence_id - recorded_at - window_start - window_end title: TenderAppointmentEventRequest type: object TenderBase: properties: charge_line_items: items: properties: category: description: Code the charge category for this line item type: string unit_amount: description: Amount of a single unit of this line item type: number unit_amount_currency: description: 3 letter code of currency for this line item. If not provided, assumed to be USD. maxLength: 3 minLength: 3 type: string unit_name: description: Name of charge type: string unit_quantity: description: Quantity of this line item type: number required: - unit_amount - unit_name - unit_quantity title: TenderChargeLineItem type: object type: array delivery_date: description: requested delivery date for this tender (in YYYY-MM-DD format) format: date type: string earliest_pickup_date: description: Earliest date tender is available for pickup (in YYYY-MM-DD format) format: date type: string earliest_pickup_time: description: Earliest time tender is available for pickup (in HH:MM:SS format) type: string equipment_type: description: machine_readable string of the EquipmentType requested for this tender. type: string error_message: description: Open-ended field for error information regarding this tender type: string expires_at: description: Datetime that this tender expires at. format: date-time type: string info_message: description: Open-ended field for other information regarding this tender e.g special instructions type: string lane_type: description: machine_readable string of the LaneType (formerly QuoteLaneType) requested for this tender. enum: - DIRECT - INTERLINE - UNSPECIFIED type: string latest_pickup_date: description: Latest date tender is available for pickup (in YYYY-MM-DD format) format: date type: string latest_pickup_time: description: Latest time tender is available for pickup (in HH:MM:SS format) type: string reference_number: description: Reference number/string for this tender. Primarially for references from external systems. type: string transit_days: description: Number of days scheduled for transit type: integer type: object TenderCreate: allOf: - $ref: '#/components/schemas/TenderBase' - properties: carrier: description: UUID of the carrier for the company the shipment is being tendered to format: uuid type: string involved_tender_to_company_users: items: format: uuid type: string type: array mode: description: Id of the shipment mode format: int32 type: integer service_level: description: Id of the service level type format: int32 type: integer shipment: description: UUID of the shipment this tender is for format: uuid type: string tender_to_company: description: UUID of the company to tender this shipment to format: uuid type: string required: - shipment - tender_to_company type: object TenderEquipmentEventRequest: properties: equipment_id: type: string notes: type: string recorded_at: format: date-time type: string type_code: enum: - BULK - CONTAINER - CONESTOGA - DRY_VAN - DOUBLE_DROP - DROP_DECK - FLATBED - FLATBED_CONESTOGA - OTHER - REEFER - TRUCK_AND_TRAILER - VAN_VENTED type: string title: TenderEquipmentEventRequest type: object TenderEtaEventRequest: properties: created_at: format: date-time type: string notes: type: string recorded_at: format: date-time type: string stop_sequence_id: minimum: 1 type: number window_end: format: date-time type: string window_start: format: date-time type: string required: - stop_sequence_id - recorded_at - window_start - window_end title: TenderEtaEventRequest type: object TenderEventRequest: properties: customer: $ref: '#/components/schemas/TenderRequestCustomer' events: properties: appointment: items: $ref: '#/components/schemas/TenderAppointmentEventRequest' type: array equipment: items: $ref: '#/components/schemas/TenderEquipmentEventRequest' type: array eta: items: $ref: '#/components/schemas/TenderEtaEventRequest' type: array location: items: $ref: '#/components/schemas/TenderLocationEventRequest' type: array shipment_state: items: $ref: '#/components/schemas/TenderShipmentStateEventRequest' type: array stop_location_event: items: $ref: '#/components/schemas/TenderStopLocationEventRequest' type: array type: object tender_id: format: uuid type: string vendor: $ref: '#/components/schemas/TenderRequestVendor' required: - customer - vendor - tender_id - events title: TenderEventRequest type: object TenderGet: allOf: - $ref: '#/components/schemas/TenderBase' - properties: accepted_at: description: Datetime that the tender was accepted at or null if not accepted. format: date-time type: string carrier: $ref: '#/components/schemas/Carrier' carrier_status: enum: - ACTIVE - INACTIVE - DO_NOT_USE type: string created_at: format: date-time type: string created_by_company_id: description: UUID of company that created this tender format: uuid type: string created_by_user_id: description: UUID of user that created this tender (if known) format: uuid type: string expires_at: description: Datetime the tender expires or null if it doesn't expire. format: date-time type: string external_edi_system_shipment_id: description: External system shipment identification value type: string id: description: UUID of this tender format: uuid type: string involved_tender_to_company_users: items: $ref: '#/components/schemas/SlimUser' type: array mode: $ref: '#/components/schemas/ShipmentMode' rejected_at: description: Datetime the tender was rejected or null if not rejected. format: date-time type: string revoked_at: description: Datetime the tender was revoked by the shipper or null if not revoked. format: date-time type: string service_level: $ref: '#/components/schemas/ServiceLevel' shipment_id: description: UUID of the shipment this tender is for format: uuid type: string status: enum: - open - accepted - rejected - revoked - expired type: string tender_to_company: $ref: '#/components/schemas/Company' updated_at: format: date-time type: string required: - id - created_by_company_id type: object TenderLocationEventRequest: properties: city: type: string country: type: string description: type: string geo_location: properties: lat: format: float type: number lon: format: float type: number type: object notes: type: string postal_code: type: string recorded_at: format: date-time type: string state: type: string required: - city - state - country - geo_location title: TenderLocationEventRequest type: object TenderRequest: properties: customer: $ref: '#/components/schemas/TenderRequestCustomer' equipment: properties: temperature_control: properties: lower_limit: $ref: '#/components/schemas/TenderRequestTemperature' upper_limit: $ref: '#/components/schemas/TenderRequestTemperature' type: object type_code: enum: - BULK - CONTAINER - CONESTOGA - DRY_VAN - DOUBLE_DROP - DROP_DECK - FLATBED - FLATBED_CONESTOGA - OTHER - REEFER - TRUCK_AND_TRAILER - VAN_VENTED type: string required: - type_code title: TenderRequestEquipment type: object isa: properties: external_edi_system_isa_id: maxLength: 16 type: string external_edi_system_isa_id_qualifier: maxLength: 2 type: string required: - external_edi_system_isa_id - external_edi_system_isa_id_qualifier title: TenderExternalEDISystem type: object shipment: properties: accessorials: items: enum: - GUARANTEED - HAZMAT - NOTIFY_BEFORE_DELIVERY type: string type: array uniqueItems: true bol_number: maxLength: 256 type: string charges: items: properties: category: $ref: '#/components/schemas/ChargeCategory' unit_amount: format: float minimum: 0 type: number unit_name: maxLength: 256 type: string unit_quantity: format: int64 minimum: 1 type: number required: - unit_name - unit_quantity - unit_amount - category title: TenderRequestCharge type: object type: array drayage_booking_number: maxLength: 256 type: string drayage_chassis_number: maxLength: 256 type: string drayage_container_number: maxLength: 256 type: string drayage_seal_number: maxLength: 256 type: string expires_at: format: date-time type: string external_edi_system_shipment_id: description: The identifier for the shipment in an external EDI system type: string pickup_number: maxLength: 256 type: string pro_number: maxLength: 256 type: string purchase_order_number: maxLength: 256 type: string shipment_reference_id: maxLength: 20 type: string shipper_reference_id: maxLength: 256 type: string special_instructions: type: string stops: items: properties: accessorials: items: enum: - APPOINTMENT_REQUESTED - LIFTGATE - CONVENTION_TRADESHOW - CONSTRUCTION_SITE - INSIDE_PICKUP_DELIVERY - LIMITED_ACCESS - FARM type: string type: array uniqueItems: true address: properties: city: maxLength: 128 type: string country: maxLength: 2 type: string identification_code: maxLength: 256 type: string line_1: maxLength: 256 type: string line_2: maxLength: 256 type: string postal_code: maxLength: 20 type: string state_or_province: maxLength: 2 type: string timezone: maxLength: 48 type: string required: - line_1 - city - state_or_province - country - postal_code title: TenderRequestShipmentStopAddress type: object company_name: type: string contacts: items: properties: email: format: email type: string first_name: maxLength: 45 type: string last_name: maxLength: 45 type: string phone: type: string required: - first_name title: TenderRequestShipmentStopContact type: object minItems: 1 type: array earliest_pickup: format: date-time type: string latest_pickup: format: date-time type: string line_items: items: properties: description: maxLength: 256 type: string height: $ref: '#/components/schemas/TenderRequestLength' length: $ref: '#/components/schemas/TenderRequestLength' package_quantity: format: int32 minimum: 0 type: integer package_type: enum: - BAG - BALE - BOX - BUCKET - BUNDLE - CAN - CARTON - CASE - COIL - CRATE - CYLINDER - DRUM - FLOOR_LOADED - PAIL - PIECES - PKG - PLT - REEL - ROLL - SKID - TUBE type: string piece_quantity: format: int32 minimum: 0 type: integer piece_type: enum: - BAG - BALE - BOX - BUCKET - BUNDLE - CAN - CARTON - CASE - COIL - CRATE - CYLINDER - DRUM - PAIL - PIECES - REEL - ROLL - SKID - TUBE type: string weight: $ref: '#/components/schemas/TenderRequestWeight' width: $ref: '#/components/schemas/TenderRequestLength' title: TenderRequestShipmentStopLineItem type: object type: array reason: enum: - LOAD - UNLOAD type: string sequence_id: minimum: 1 type: number special_instructions: type: string required: - sequence_id - reason - address - contacts title: TenderRequestShipmentStop type: object type: array tender_id: format: uuid readOnly: true type: string total_declared_value: maxLength: 256 type: string weight: $ref: '#/components/schemas/TenderRequestWeight' required: - stops - charges title: TenderRequestShipment type: object vendor: $ref: '#/components/schemas/TenderRequestVendor' required: - customer - vendor - shipment - equipment title: TenderRequest type: object TenderRequestCustomer: properties: duns: type: string id: format: uuid type: string name: type: string title: TenderRequestCustomer type: object TenderRequestLength: properties: unit: enum: - IN - FT type: string value: format: float minimum: 0 type: number required: - unit - value title: TenderRequestLength type: object TenderRequestTemperature: properties: unit: enum: - C - F type: string value: type: number required: - unit - value title: TenderRequestTemperature type: object TenderRequestVendor: properties: ff: type: string id: format: uuid type: string mc: type: string mx: type: string nsc: type: string scac: type: string usdot: type: string title: TenderRequestVendor type: object TenderRequestWeight: properties: unit: enum: - KG - LBS type: string value: minimum: 0 type: number required: - unit - value title: TenderRequestWeight type: object TenderShipmentStateEventRequest: properties: recorded_at: format: date-time type: string status: enum: - TENDERED_FOR_DELIVERY - IN_TRANSIT - CANCELLED - LOADING - DELAYED - DELIVERED - HELD type: string required: - recorded_at - status title: TenderStopLocationEventRequest type: object TenderStopLocationEventRequest: properties: event_type: enum: - ARRIVAL - AT_LOCATION - ATTEMPT - COMPLETED - DEPARTURE - EXCEPTION - MISSED type: string notes: type: string recorded_at: format: date-time type: string stop_sequence_id: minimum: 1 type: number required: - stop_sequence_id - recorded_at - event_type title: TenderStopLocationEventRequest type: object TextMessageTemplates: properties: ambiguous_feedback_message: type: string ambiguous_response_to_delivery_message: type: string damage_only_message: type: string detention_only_message: type: string internal_ambiguous_feedback_message: type: string internal_damage_only_message: type: string internal_detention_only_message: type: string internal_multiple_issues_message: type: string multiple_issues_message: type: string no_feedback_messsage: type: string no_response_to_delivery_message: type: string pod_attached_message: type: string pod_not_attached_message: type: string validate_delivery_completion_message: type: string yes_response_to_delivery_message: type: string required: - validate_delivery_completion_message - ambiguous_response_to_delivery_message - yes_response_to_delivery_message - no_response_to_delivery_message - pod_not_attached_message - pod_attached_message - ambiguous_feedback_message - internal_ambiguous_feedback_message - no_feedback_messsage - detention_only_message - internal_detention_only_message - damage_only_message - internal_damage_only_message - multiple_issues_message - internal_multiple_issues_message type: object TotalWeightOverride: properties: unit: enum: - KG - LB type: string value: format: float type: number type: object Trailer: properties: created_at: format: date-time type: string description: type: string distance_traveled_miles: format: float type: number equipment_type: $ref: '#/components/schemas/EquipmentType' id: format: uuid type: string license_plate_number: type: string license_plate_state_province: type: string max_haul_volume_ft3: format: int32 type: integer max_haul_weight_lbs: format: int32 type: integer name: type: string updated_at: format: date-time type: string required: - name type: object TriumphPayAuthDetails: description: Triumph Pay authorization details for a given company properties: authorized_by_user: format: uuid type: string company: format: uuid type: string created_at: format: date-time type: string id: format: uuid type: string re_authorized_by_user: format: uuid type: string realm_id: type: string updated_at: format: date-time type: string type: object TriumphPayCarrierInvoice: description: Triumph Pay vendor invoices submitted properties: external_key: type: string is_paid: type: boolean source_bill: format: uuid type: string type: object TriumphPayCarrierPaymentAccount: description: Triumph Pay vendor payments accounts synced properties: created_at: format: date-time type: string id: format: uuid type: string is_default: type: boolean mail_check_data: properties: address: $ref: '#/components/schemas/Address' mail_to_name: type: string type: object payment_type: enum: - ACH_BANK - MAIL_CHECK - FACTOR type: string vendor_factor_company: $ref: '#/components/schemas/VendorFactoringCompany' required: - payment_type type: object TriumphPayDocumentsSubmissionEmail: description: Triumph Pay documents submission email properties: documents_submission_email: description: The documents submission email format: email type: string required: - documents_submission_email type: object TriumphPayPaymentAccountTypes: enum: - ACH_BANK - MAIL_CHECK - FACTOR type: string TriumphPayVendor: description: Triumph Pay vendor list details properties: created_at: format: date-time type: string freight_authority_vendor_relationship_details: properties: freight_authority: type: string vendor_name: type: string type: object id: format: uuid type: string triumph_carrier_accounts: items: $ref: '#/components/schemas/TriumphPayCarrierPaymentAccount' type: array triumph_carrier_invoices: items: $ref: '#/components/schemas/TriumphPayCarrierInvoice' type: array vendor: format: uuid type: string type: object TriumphPayVendorPaymentAccountData: description: Triumph Pay vendor payment account create or update data properties: account_name: description: A nickname to identify the account. Only required for ACH_BANK payment type type: string bank_account_data: description: Bank account data if payment_type is ACH_BANK properties: bank_account_number: type: string bank_routing_number: type: string type: object payment_type: description: The payment type information to update enum: - ACH_BANK - MAIL_CHECK - FACTOR type: string vendor_billing_address: allOf: - $ref: '#/components/schemas/Address' description: Mailing address data if payment_type is MAIL_CHECK vendor_factor_company: allOf: - $ref: '#/components/schemas/VendorFactoringCompany' description: Factoring company data if payment_type is FACTOR required: - payment_type type: object TriumphPayVendorPaymentAccountDataWithFactorCompanyChangeDocuments: allOf: - $ref: '#/components/schemas/TriumphPayVendorPaymentAccountData' - properties: id: description: Id of the particular payment account format: uuid type: string letter_of_release_document: format: uuid type: string notice_of_assignment_document: format: uuid type: string type: object type: object TruckloadHistoricalPricingAggregate: properties: average: type: number high: type: number low: type: number type: object TruckloadHistoricalPricingListResponse: properties: page_size: type: number results: items: $ref: '#/components/schemas/ShipwellHistoricalPricingSinglePrice' type: array total_count: type: number total_pages: type: number type: object TruckloadHistoricalPricingPrice: properties: avg_price: type: number date: description: Date string in of the form YYYY-MM-DD type: string max_price: type: number min_price: type: number type: object TruckloadHistoricalPricingRequest: properties: equipment_type: description: Shipment EquipmentType id type: integer is_contract: type: boolean pickup_date_gte: format: date type: string predictive_sources: items: enum: - shipwell_market_carrier - shipwell_internal_shipper type: string type: array query: type: string sources: items: enum: - chainalytics_spot - dat_spot - shipwell_internal - shipwell_market type: string type: array stops: items: properties: country: type: string zip: type: string type: object title: Stops type: array required: - equipment_type - stops - sources type: object TruckloadHistoricalPricingResponse: properties: aggregates: properties: chainalytics_spot: $ref: '#/components/schemas/TruckloadHistoricalSingleSourceAggregate' dat_spot: $ref: '#/components/schemas/TruckloadHistoricalSingleSourceAggregate' shipwell_internal: $ref: '#/components/schemas/TruckloadHistoricalSingleSourceAggregate' title: Aggregates type: object error_message: type: string failed: type: boolean historical_pricing: properties: chainalytics_spot: items: $ref: '#/components/schemas/TruckloadHistoricalPricingPrice' type: array dat_spot: items: $ref: '#/components/schemas/TruckloadHistoricalPricingPrice' type: array shipwell_internal: items: $ref: '#/components/schemas/ShipwellHistoricalPricingSinglePrice' type: array title: HistoricalPricing type: object predictive_pricing: properties: shipwell_internal_shipper: $ref: '#/components/schemas/TruckloadPredictivePricingPrice' shipwell_market_carrier: $ref: '#/components/schemas/TruckloadPredictivePricingPrice' title: PredictivePricing type: object trip_miles: type: number type: object TruckloadHistoricalSingleSourceAggregate: properties: all_time: $ref: '#/components/schemas/TruckloadHistoricalPricingAggregate' six_month: $ref: '#/components/schemas/TruckloadHistoricalPricingAggregate' three_month: $ref: '#/components/schemas/TruckloadHistoricalPricingAggregate' twelve_month: $ref: '#/components/schemas/TruckloadHistoricalPricingAggregate' type: object TruckloadPredictivePricingPrice: properties: date: description: Date string in of the form YYYY-MM-DD type: string high: format: float type: number low: format: float type: number mid: format: float type: number type: object TruckloadPricingRequest: properties: equipment_type: description: Shipment EquipmentType id type: integer shipment: description: Shipment being priced by the request format: uuid type: string stops: items: properties: country: type: string is_pickup: type: boolean planned_date: format: date type: string postal_code: type: string state_province: type: string required: - postal_code - state_province - country - is_pickup type: object title: Stops type: array required: - equipment_type - stops type: object UPSAccount: properties: account_number: type: string company: format: uuid type: string id: format: uuid type: string provider_reference_number: type: string type: object UPSDirectQuote: allOf: - $ref: '#/components/schemas/GenesisQuote' UPSPackaging: properties: description: description: All possible dimensional sub-types of the package type items: type: string type: array id: description: identifier for the package type type: string label: description: Human-readable short description of the package type type: string type: object UPSShipmentOptions: allOf: - $ref: '#/components/schemas/GenesisShipmentOptions' - properties: account: description: Id of the UPSAccount to dispatch or rate format: uuid type: string alcohol_recipient_type: enum: - CONSUMER - LICENSEE type: string packaging: enum: - UPS_LETTER - UPS_EXPRESS_BOX - UPS_25KG_BOX - UPS_10_KG_BOX - UPS_TUBE - UPS_PAK - UPS_SMALL_EXPRESS_BOX - UPS_MEDIUM_EXPRESS_BOX - UPS_LARGE_EXPRESS_BOX - YOUR_PACKAGING type: string service_code: enum: - GROUND - UPS_STANDARD - UPS_SAVER - EXPRESS - EXPRESS_PLUS - EXPEDITED - NEXT_DAY_AIR - NEXT_DAY_AIR_SAVER - NEXT_DAY_AIR_EARLY_AM - SECOND_DAY_AIR - SECOND_DAY_AIR_AM - THREE_DAY_SELECT type: string type: object description: Shipment rating and dispatch options specific to UPS USPSAccount: properties: account_number: type: string address: $ref: '#/components/schemas/GenesisAddress' company: format: uuid type: string email: type: string id: format: uuid type: string is_default: type: boolean provider_reference_number: type: string type: object USPSDirectQuote: allOf: - $ref: '#/components/schemas/GenesisQuote' USPSPackaging: properties: description: description: All possible dimensional sub-types of the package type items: type: string type: array id: description: identifier for the package type type: string label: description: Human-readable short description of the package type type: string type: object USPSShipmentOptions: allOf: - $ref: '#/components/schemas/GenesisShipmentOptions' - properties: account: description: Id of the USPSAccount to dispatch or rate format: uuid type: string packaging: enum: - USPS_LETTER - USPS_FLAT - USPS_FLAT_RATE_ENVELOPE - USPS_FLAT_RATE_LEGAL_ENVELOPE - USPS_FLAT_RATE_PADDED_ENVELOPE - USPS_PARCEL - USPS_IRREGULAR_PARCEL - USPS_SOFT_PACK - USPS_SMALL_FLAT_RATE_BOX - USPS_MEDIUM_FLAT_RATE_BOX - USPS_LARGE_FLAT_RATE_BOX - USPS_LARGE_FLAT_RATE_BOX_APOFPO - USPS_REGIONAL_RATE_BOX_A - USPS_REGIONAL_RATE_BOX_B - USPS_LARGE_PARCEL - USPS_FLAT_RATE_GIFT_CARD_ENVELOPE - USPS_FLAT_RATE_WINDOW_ENVELOPE - USPS_FLAT_RATE_CARDBOARD_ENVELOPE - USPS_SMALL_FLAT_RATE_ENVELOPE - USPS_LARGE_FLAT_RATE_BOARD_GAME_BOX - YOUR_PACKAGING type: string service_code: enum: - FIRST - PRIORITY - EXPRESS - PARCEL_SELECT - LIBRARY_MAIL - MEDIA_MAIL type: string type: object description: Shipment rating and dispatch options specific to USPS User: properties: avatar: type: string company_id: format: uuid type: string completed_onboarding: type: boolean created_at: format: date-time type: string custom_data: $ref: '#/components/schemas/UserCustomData' default_shipment_tags: description: List of ShipmentTag ids items: format: uuid type: string type: array email: type: string feature_flag_new_shipment_details: type: boolean feature_flag_new_ui: type: boolean first_name: type: string id: format: uuid type: string is_quoting_limited_user: type: boolean last_login: format: date-time type: string last_name: type: string password: type: string permissions: items: type: string type: array phone_number: type: string subscribed_to_loadboard: type: boolean timezone: type: string updated_at: format: date-time type: string required: - first_name - last_name - email type: object UserCustomData: additionalProperties: {} description: Custom data for User type: object x-is-free-form: false UserDashboardConfiguration: properties: config: properties: columns: description: 'Array of column names in the order that they should render when loading the dashboard ' items: type: string type: array filters: additionalProperties: items: type: string type: array description: 'Object with the filters you want in it ' type: object ordering: description: 'Array of column names prefixed with ''+'' or ''-'' to indicate how the dashboard columns should be sorted ' items: type: string type: array type: object created_at: format: date-time type: string id: format: uuid type: string is_default: type: boolean name: description: Unique name of this user's dashboard configuration type: string table_type: type: string updated_at: format: date-time type: string user: format: uuid type: string type: object UserPreferences: properties: created_at: format: date-time type: string table_row_defaults: additionalProperties: type: integer description: Tables rows default size updated_at: format: date-time type: string user: format: uuid type: string required: - user type: object ValidatedAddress: properties: field_warnings: additionalProperties: items: type: string type: array description: Address field-specific warnings type: object geocoded_address: $ref: '#/components/schemas/Address' provided_formatted_address: type: string warnings: description: Overall warnings about geocoding items: type: string type: array required: - provided_formatted_address type: object VehicleLocation: allOf: - $ref: '#/components/schemas/ELDLocation' - properties: unit_id: type: string vehicle_id: type: string required: - vehicle_id type: object description: Vehicle Location Data Vendor: properties: existing_vendor_relationship: format: uuid type: string fmcsa_census_data: $ref: '#/components/schemas/FmcsaCensusData' fmcsa_vendor: $ref: '#/components/schemas/Company' is_editable: type: boolean shipwell_vendor: $ref: '#/components/schemas/Company' type: object VendorFactoringCompany: properties: address: $ref: '#/components/schemas/Address' company_name: type: string created_at: format: date-time type: string email: format: email type: string id: format: uuid type: string triumph_pay_key: type: string updated_at: format: date-time type: string required: - company_name - address type: object VendorRelationship: properties: company: $ref: '#/components/schemas/SlimCompany' id: format: uuid type: string type: object Versions: properties: frontend_version: type: string type: object WorkflowAutomationStructuredConditional: additionalProperties: {} description: StructuredConditional object that can be evaluated within workflow automation type: object x-is-free-form: false securitySchemes: AuthToken: in: header name: Authorization type: apiKey info: description: Shipwell's v2 Core API contains most shipping and carrier-specific supply chain endpoints. It is written according to OAS specifications. To make use of this API reference, use the side nav to find the endpoints you need. Endpoints are categorized by use case. title: Shipwell v2 Core API version: 2.5.620 openapi: 3.0.3 paths: /address-book/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' - $ref: '#/components/parameters/q' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/AddressBookEntry' type: array total_count: type: integer total_pages: type: integer title: PaginatedAddressBookEntry type: object description: Successfully returned a list of address book entries default: $ref: '#/components/responses/defaultError' summary: Get a list of address book entries tags: - locations post: requestBody: $ref: '#/components/requestBodies/AddressBookEntry' responses: '201': content: application/json: schema: $ref: '#/components/schemas/AddressBookEntry' description: Successfully created a new address book entry default: $ref: '#/components/responses/defaultError' summary: Creates a new address book entry tags: - locations /address-book/{addressBookId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete an address book entry tags: - locations get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/AddressBookEntry' description: Successfully returned an address book entry default: $ref: '#/components/responses/defaultError' summary: Obtain information about an address book entry tags: - locations parameters: - $ref: '#/components/parameters/addressBookId' put: requestBody: $ref: '#/components/requestBodies/AddressBookEntry' responses: '200': content: application/json: schema: $ref: '#/components/schemas/AddressBookEntry' description: Successfully returned an address book entry default: $ref: '#/components/responses/defaultError' summary: Update an address book entry or add point of contacts tags: - locations /auth/change-password/: post: requestBody: content: application/json: schema: properties: new_password: type: string old_password: type: string title: ChangePassword type: object required: true responses: '200': content: application/json: schema: properties: token: type: string title: TokenResponse type: object description: Password was changed default: $ref: '#/components/responses/defaultError' summary: Change a user's password tags: - users /auth/me/: get: responses: '200': content: application/json: schema: properties: company: $ref: '#/components/schemas/Company' driver: $ref: '#/components/schemas/Driver' driver_token: type: string user: $ref: '#/components/schemas/User' title: MeResponse type: object description: Returns the authenticated user object default: $ref: '#/components/responses/defaultError' summary: Returns the currently authenticated user tags: - users /auth/password-reset/: post: requestBody: content: application/json: schema: properties: password: type: string token: format: uuid type: string title: ResetPassword type: object required: true responses: '204': description: Token accepted and password set default: $ref: '#/components/responses/defaultError' summary: Submit a password reset token tags: - users /auth/request-password-reset/: post: requestBody: content: application/json: schema: properties: email: type: string title: RequestPasswordReset type: object required: true responses: '204': description: If the user exists and has not yet been verified, the email is sent. default: $ref: '#/components/responses/defaultError' summary: Requests a Reset Password Email tags: - users /auth/request-verification-email/: post: requestBody: content: application/json: schema: properties: email: type: string title: RequestVerificationEmail type: object required: true responses: '204': description: If the user exists and has not yet been verified, the email is sent. default: $ref: '#/components/responses/defaultError' summary: Requests a Verification Email tags: - users /auth/set-password/: post: requestBody: content: application/json: schema: properties: password: type: string token: format: uuid type: string title: SetPassword type: object required: true responses: '204': description: Token accepted and password set, email is also verified default: $ref: '#/components/responses/defaultError' summary: Submit a set password token tags: - users /auth/token/: post: requestBody: content: application/json: schema: $ref: '#/components/schemas/Login' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LoginResponse' description: Returns the associated auth token and the user object default: $ref: '#/components/responses/defaultError' security: [] summary: Login given a users credentials tags: - users /auth/verify-email/: post: requestBody: content: application/json: schema: properties: token: format: uuid type: string title: VerifyEmail type: object required: true responses: '200': content: application/json: schema: properties: email: type: string is_active: type: boolean phone_number: type: string title: VerificationResponse type: object description: Token accepted and user's email verified. default: $ref: '#/components/responses/defaultError' summary: Submit an email verification token tags: - users /brokerages/{brokerageId}/shipper-relationships/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' - $ref: '#/components/parameters/q' - $ref: '#/components/parameters/accountRepsContains' - $ref: '#/components/parameters/accountRepsIds' - $ref: '#/components/parameters/salesRepsContains' - $ref: '#/components/parameters/salesRepsIds' - $ref: '#/components/parameters/companyContains' - $ref: '#/components/parameters/companyPrimaryEmailContains' - $ref: '#/components/parameters/companyPrimaryPhoneNumberContains' - $ref: '#/components/parameters/customerId' - $ref: '#/components/parameters/expandUsers' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/ShipperRelationship' type: array total_count: type: integer total_pages: type: integer title: PaginatedShipperRelationship type: object description: Successfully returned a list of shipper relationships default: $ref: '#/components/responses/defaultError' summary: Returns a list of a brokerage shipper relationships tags: - shipper-relationship parameters: - $ref: '#/components/parameters/brokerageId' post: requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateShipperRelationship' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/ShipperRelationship' description: Successfully created a new shipper along with a relationship to the authenticated broker default: $ref: '#/components/responses/defaultError' summary: Creates a new shipper along with a relationship to the authenticated broker tags: - shipper-relationship /brokerages/{brokerageId}/shipper-relationships/{shipperRelationshipId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a shipper relationship tags: - shipper-relationship get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/ShipperRelationship' description: Successfully returned a shipper relationship default: $ref: '#/components/responses/defaultError' summary: Obtain information about a shipper relationship tags: - shipper-relationship parameters: - $ref: '#/components/parameters/brokerageId' - $ref: '#/components/parameters/shipperRelationshipId' put: requestBody: content: application/json: schema: $ref: '#/components/schemas/ShipperRelationship' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ShipperRelationship' description: Successfully returned a shipper relationship default: $ref: '#/components/responses/defaultError' summary: Update a shipper relationship tags: - shipper-relationship /brokerages/{brokerageId}/shipper-relationships/{shipperRelationshipId}/carriers/: get: responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/CarrierSpecificShipperRelationship' type: array description: Successfully returned a list of carrier relationships default: $ref: '#/components/responses/defaultError' summary: Returns a list of carrier relationships for a given shipper to brokerage relationship tags: - shipper-carrier-relationships parameters: - $ref: '#/components/parameters/brokerageId' - $ref: '#/components/parameters/shipperRelationshipId' put: requestBody: content: application/json: schema: items: $ref: '#/components/schemas/CarrierSpecificShipperRelationship' type: array required: true responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/CarrierSpecificShipperRelationship' type: array description: Successfully modified a new carrier relationships default: $ref: '#/components/responses/defaultError' summary: Updates any modified carrier relationships tags: - shipper-carrier-relationships /brokerages/{brokerageId}/shipper-relationships/{shipperRelationshipId}/documents/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/DocumentMetadata' type: array total_count: type: integer total_pages: type: integer title: PaginatedDocumentMetadata type: object description: Successfully retrieved document metadata default: $ref: '#/components/responses/defaultError' summary: Get metadata about documents on a shipper relationship tags: - shipper-relationship parameters: - $ref: '#/components/parameters/brokerageId' - $ref: '#/components/parameters/shipperRelationshipId' post: requestBody: $ref: '#/components/requestBodies/PostBrokeragesBrokerageidShipperRelationshipsShipperrelationshipidDocuments' responses: '201': content: application/json: schema: $ref: '#/components/schemas/DocumentMetadata' description: Successfully created a document default: $ref: '#/components/responses/defaultError' summary: Create a document on a shipment tags: - shipper-relationship x-codegen-request-body-name: body /brokerages/{brokerageId}/shipper-relationships/{shipperRelationshipId}/documents/{documentId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a Document tags: - shipper-relationship get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/DocumentMetadata' description: Successfully retrieved document metadata default: $ref: '#/components/responses/defaultError' summary: Get metadata about a document tags: - shipper-relationship parameters: - $ref: '#/components/parameters/brokerageId' - $ref: '#/components/parameters/shipperRelationshipId' - $ref: '#/components/parameters/documentId' put: requestBody: $ref: '#/components/requestBodies/ShipmentDocumentMetadata' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ShipmentDocumentMetadata' description: Successfully updated document metadata default: $ref: '#/components/responses/defaultError' summary: Update metadata about a document tags: - shipper-relationship /carrier-compliance/integrations/fmcsa/policy/: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/FMCSACarrierPolicy' description: Successfully returned a company's FMCSA Carrier Policy. default: $ref: '#/components/responses/defaultError' summary: Get FMCSA Carrier Compliance policy settings tags: [] put: requestBody: content: application/json: schema: $ref: '#/components/schemas/FMCSACarrierPolicy' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/FMCSACarrierPolicy' description: Update FMCSA Carrier Compliance policy settings default: $ref: '#/components/responses/defaultError' summary: Update FMCSA Carrier Compliance policy settings tags: [] /carrier-compliance/integrations/saferwatch/policy/: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/SaferWatchCarrierPolicy' description: Successfully returned a company's SaferWatch Carrier Policy. default: $ref: '#/components/responses/defaultError' summary: Get SaferWatch Carrier Compliance policy settings tags: [] put: requestBody: content: application/json: schema: $ref: '#/components/schemas/SaferWatchCarrierPolicy' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/SaferWatchCarrierPolicy' description: Update SaferWatch Carrier Compliance policy settings default: $ref: '#/components/responses/defaultError' summary: Update SaferWatch Carrier Compliance policy settings tags: [] /carrier-poc-tags/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/CarrierPocTag' type: array total_count: type: integer total_pages: type: integer title: PaginatedCarrierPocTag type: object description: Successfully returned a list of carrier point of contact tags default: $ref: '#/components/responses/defaultError' summary: Get a list of available carrier point of contact tags tags: - carrier-tags post: requestBody: $ref: '#/components/requestBodies/CarrierPocTag' responses: '201': content: application/json: schema: $ref: '#/components/schemas/CarrierPocTag' description: Successfully created a new carrier point of contact tag default: $ref: '#/components/responses/defaultError' summary: Create a new carrier point of contact tag tags: - carrier-tags /carrier-poc-tags/{tagId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a carrier point of contact tag tags: - carrier-tags get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/CarrierPocTag' description: Successfully returned a carrier point of contact tag default: $ref: '#/components/responses/defaultError' summary: Obtain information about a carrier point of contact tag tags: - carrier-tags parameters: - $ref: '#/components/parameters/tagId' put: requestBody: $ref: '#/components/requestBodies/CarrierPocTag' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CarrierPocTag' description: Successfully updated the carrier point of contact tag default: $ref: '#/components/responses/defaultError' summary: Update the carrier point of contact tag tags: - carrier-tags /carrier-recommendation/v1/feedback/: post: requestBody: content: application/json: schema: $ref: '#/components/schemas/CrFeedbackCreate' description: The shipment to get recommendations for. responses: '200': content: application/json: schema: $ref: '#/components/schemas/CrFeedback' description: Newly created Shipment object and list of suggestions generated. '400': content: application/json: schema: $ref: '#/components/schemas/CrFieldErrorsResponse' description: Request was bad; usually missing parameters summary: Saves feedback for the given recommendation. tags: - carrier-prioritization x-codegen-request-body-name: body /carrier-recommendation/v1/recommendation-shipments/: get: parameters: - in: query name: external_shipment_id required: true schema: format: uuid type: string responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/CrRecommendationShipmentResponse' type: array total_count: type: integer total_pages: type: integer type: object description: List of shipment objects and list of associated suggestions generated. summary: Searches for recommendation shipments with the given external_shipment_id. tags: - carrier-prioritization post: requestBody: content: application/json: schema: $ref: '#/components/schemas/CrRecommendationShipment' description: The shipment to get recommendations for. responses: '200': content: application/json: schema: $ref: '#/components/schemas/CrRecommendationShipmentResponse' description: Newly created Shipment object and list of suggestions generated. '400': content: application/json: schema: $ref: '#/components/schemas/CrFieldErrorsResponse' description: Request was bad; usually missing parameters summary: Saves and returns a list of recommended companies for a shipment with the given parameters. tags: - carrier-prioritization x-codegen-request-body-name: body /carrier-recommendation/v1/recommendation-shipments/{CrRecommendationShipmentId}/: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/CrRecommendationShipmentResponse' description: Shipment object and list of associated suggestions generated. default: $ref: '#/components/responses/defaultError' summary: Returns the recommendation object and its associated recommendations. tags: - carrier-prioritization parameters: - $ref: '#/components/parameters/CrRecommendationShipmentId' /carrier-recommendation/v1/recommendations/: get: parameters: - in: query name: recommendation_shipment__external_shipment_id required: true schema: format: uuid type: string responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/CrRecommendationResponse' type: array total_count: type: integer total_pages: type: integer type: object description: List of associated recommendations. default: $ref: '#/components/responses/defaultError' summary: Searches for recommendations with the given external_shipment_id. tags: - carrier-prioritization /carrier-recommendation/v1/recommendations/{CrRecommendationId}/: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/CrRecommendationResponse' description: Recommendation object. default: $ref: '#/components/responses/defaultError' summary: Returns the recommendation object. tags: - carrier-prioritization parameters: - $ref: '#/components/parameters/CrRecommendationId' /carrier-relationships/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' - $ref: '#/components/parameters/q' - $ref: '#/components/parameters/includeIds' - $ref: '#/components/parameters/carrierOwnerId' - $ref: '#/components/parameters/carrierOwnerEmail' - $ref: '#/components/parameters/carrierOwnerName' - $ref: '#/components/parameters/carrierStatus' - $ref: '#/components/parameters/companyBillingAddressContains' - $ref: '#/components/parameters/companyContains' - $ref: '#/components/parameters/companyMailingAddressContains' - $ref: '#/components/parameters/companyPrimaryEmailContains' - $ref: '#/components/parameters/companyPrimaryPhoneNumberContains' - $ref: '#/components/parameters/mcNumber' - $ref: '#/components/parameters/mcNumberContains' - $ref: '#/components/parameters/pointOfContactsContains' - $ref: '#/components/parameters/tags' - $ref: '#/components/parameters/tagsContains' - $ref: '#/components/parameters/usdot' - $ref: '#/components/parameters/usdotContains' - $ref: '#/components/parameters/vendor' - $ref: '#/components/parameters/vendorEnabledForLoadBoard' - $ref: '#/components/parameters/hasDirectIntegration' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/SlimCarrierRelationship' type: array total_count: type: integer total_pages: type: integer title: PaginatedSlimCarrierRelationship type: object description: Successfully returned a list of carrier relationships default: $ref: '#/components/responses/defaultError' summary: Get the list of relationships with carriers tags: - carrier-relationships post: parameters: - $ref: '#/components/parameters/manual_entry' requestBody: $ref: '#/components/requestBodies/CarrierRelationship' responses: '201': content: application/json: schema: $ref: '#/components/schemas/CarrierRelationship' description: Successfully created a new carrier relationship default: $ref: '#/components/responses/defaultError' summary: Creates a new relationship with a carrier. If the carrier does not exist, it will be created. tags: - carrier-relationships /carrier-relationships/{carrierRelationshipId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a carrier relationship tags: - carrier-relationships get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/CarrierRelationship' description: Successfully returned a carrier relationship default: $ref: '#/components/responses/defaultError' summary: Obtain information about a carrier relationship tags: - carrier-relationships parameters: - $ref: '#/components/parameters/carrierRelationshipId' put: requestBody: $ref: '#/components/requestBodies/CarrierRelationship' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CarrierRelationship' description: Successfully returned a carrier relationship default: $ref: '#/components/responses/defaultError' summary: Update information about a carrier relationship tags: - carrier-relationships /carrier-relationships/{carrierRelationshipId}/contracts/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' - $ref: '#/components/parameters/q' - $ref: '#/components/parameters/destinationContains' - $ref: '#/components/parameters/destinationStateProvince' - $ref: '#/components/parameters/originContains' - $ref: '#/components/parameters/originStateProvince' - $ref: '#/components/parameters/contractNameContains' - $ref: '#/components/parameters/contractStatus' - $ref: '#/components/parameters/createdAt' - $ref: '#/components/parameters/updatedAt' - $ref: '#/components/parameters/rate' - $ref: '#/components/parameters/carrierNameContains' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/Contract' type: array total_count: type: integer total_pages: type: integer title: PaginatedContract type: object description: Paginated list of contracts default: $ref: '#/components/responses/defaultError' summary: List contracts tags: - contracts parameters: - $ref: '#/components/parameters/carrierRelationshipId' post: requestBody: $ref: '#/components/requestBodies/Contract' responses: '201': content: application/json: schema: $ref: '#/components/schemas/Contract' description: Successfully created a contract default: $ref: '#/components/responses/defaultError' summary: Create a new contract tags: - contracts /carrier-relationships/{carrierRelationshipId}/contracts/{contractId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a Contract tags: - contracts get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/Contract' description: Successfully returned a Contract default: $ref: '#/components/responses/defaultError' summary: Retrieve a Contracct tags: - contracts parameters: - $ref: '#/components/parameters/carrierRelationshipId' - $ref: '#/components/parameters/contractId' put: requestBody: $ref: '#/components/requestBodies/Contract' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Contract' description: Successfully updated a Contract default: $ref: '#/components/responses/defaultError' summary: Update a Contract tags: - contracts /carrier-relationships/{carrierRelationshipId}/documents/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/DocumentMetadata' type: array total_count: type: integer total_pages: type: integer title: PaginatedDocumentMetadata type: object description: Successfully retrieved document metadata default: $ref: '#/components/responses/defaultError' summary: Get metadata about documents on a carrier relationship tags: - carrier-relationships parameters: - $ref: '#/components/parameters/carrierRelationshipId' post: requestBody: $ref: '#/components/requestBodies/PostBrokeragesBrokerageidShipperRelationshipsShipperrelationshipidDocuments' responses: '201': content: application/json: schema: $ref: '#/components/schemas/DocumentMetadata' description: Successfully created a document default: $ref: '#/components/responses/defaultError' summary: Create a document on a shipment tags: - carrier-relationships x-codegen-request-body-name: body /carrier-relationships/{carrierRelationshipId}/documents/{documentId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a Document tags: - carrier-relationships get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/DocumentMetadata' description: Successfully retrieved document metadata default: $ref: '#/components/responses/defaultError' summary: Get metadata about a document tags: - carrier-relationships parameters: - $ref: '#/components/parameters/carrierRelationshipId' - $ref: '#/components/parameters/documentId' put: requestBody: $ref: '#/components/requestBodies/ShipmentDocumentMetadata' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ShipmentDocumentMetadata' description: Successfully updated document metadata default: $ref: '#/components/responses/defaultError' summary: Update metadata about a document tags: - carrier-relationships /carrier-relationships/{carrierRelationshipId}/equipment-types/: get: responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/RecordedEquipmentType' type: array total_count: type: integer total_pages: type: integer title: PaginatedRecordedEquipmentType type: object description: Successfully equipment types providers default: $ref: '#/components/responses/defaultError' summary: List equipment types for a carrier relationship tags: - carrier-relationships parameters: - $ref: '#/components/parameters/carrierRelationshipId' post: requestBody: $ref: '#/components/requestBodies/RecordedEquipmentType' responses: '201': content: application/json: schema: $ref: '#/components/schemas/RecordedEquipmentType' description: Created equipment type entry default: $ref: '#/components/responses/defaultError' summary: Create an equipment type entry for a carrier relationship tags: - carrier-relationships /carrier-relationships/{carrierRelationshipId}/equipment-types/{recordedEquipmentTypeId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete an equipment type entry for a carrier relationship tags: - carrier-relationships get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/RecordedEquipmentType' description: Retrieved equipment type entry default: $ref: '#/components/responses/defaultError' summary: Retrieve an equipment type entry for a carrier relationship tags: - carrier-relationships parameters: - $ref: '#/components/parameters/carrierRelationshipId' - $ref: '#/components/parameters/recordedEquipmentTypeId' put: requestBody: $ref: '#/components/requestBodies/RecordedEquipmentType' responses: '200': content: application/json: schema: $ref: '#/components/schemas/RecordedEquipmentType' description: Updated equipment type entry default: $ref: '#/components/responses/defaultError' summary: Update an equipment type entry for a carrier relationship tags: - carrier-relationships /carrier-relationships/{carrierRelationshipId}/rmis-carrier-profile/{rmisCarrierProfileId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete RMIS carrier profile tags: - carrier-relationships parameters: - $ref: '#/components/parameters/carrierRelationshipId' - $ref: '#/components/parameters/rmisCarrierProfileId' /carrier-relationships/{carrierRelationshipId}/saferwatch-carrier-profile/{saferwatchCarrierProfileId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete SaferWatch carrier profile tags: - carrier-relationships parameters: - $ref: '#/components/parameters/carrierRelationshipId' - $ref: '#/components/parameters/saferWatchCarrierProfileId' /carrier-tags/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' - $ref: '#/components/parameters/vendorTagName' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/CarrierTag' type: array total_count: type: integer total_pages: type: integer title: PaginatedCarrierTag type: object description: Successfully returned a list of carrier tags default: $ref: '#/components/responses/defaultError' summary: Get a list of available carrier tags tags: - carrier-tags post: requestBody: $ref: '#/components/requestBodies/CarrierTag' responses: '201': content: application/json: schema: $ref: '#/components/schemas/CarrierTag' description: Successfully created a new carrier tag default: $ref: '#/components/responses/defaultError' summary: Create a new carrier tag tags: - carrier-tags /carrier-tags/{tagId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a carrier tag tags: - carrier-tags get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/CarrierTag' description: Successfully returned a carrier tag default: $ref: '#/components/responses/defaultError' summary: Obtain information about a carrier tag tags: - carrier-tags parameters: - $ref: '#/components/parameters/tagId' put: requestBody: $ref: '#/components/requestBodies/CarrierTag' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CarrierTag' description: Successfully updated the carrier tag default: $ref: '#/components/responses/defaultError' summary: Update the carrier tag tags: - carrier-tags /carriers/: get: parameters: - $ref: '#/components/parameters/usdot' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Vendor' description: Successfully returned a carrier default: $ref: '#/components/responses/defaultError' summary: Get a FMCSA and carrier reported data about a carrier given a USDOT tags: - carrier-relationships /carriers/integrations/automated-vendors/: get: responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/AutomatedVendorProfile' type: array description: List of automated vendor profiles default: $ref: '#/components/responses/defaultError' summary: 'Retrieve a list of all vendors that support some form of automated quoting, dispatching, tracking, or imaging ' tags: - carriers /carriers/search/: get: parameters: - $ref: '#/components/parameters/q' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/FmcsaCarrier' type: array total_count: type: integer total_pages: type: integer title: PaginatedFmcsaCarrier type: object description: Successfully returned a list of FMCSA carriers default: $ref: '#/components/responses/defaultError' summary: Search for a list of carriers tags: - carrier-relationships /carriers/{carrierId}/elds/credentials/: parameters: - $ref: '#/components/parameters/carrierId' post: requestBody: content: application/json: schema: $ref: '#/components/schemas/ELDCredentials' required: true responses: '201': description: Successfully created new credentials default: $ref: '#/components/responses/defaultError' summary: Creates or Updates ELD Credentials tags: - carriers /carriers/{carrierId}/elds/hos/: get: responses: '200': content: application/json: schema: properties: results: items: $ref: '#/components/schemas/HoursOfServiceResponse' type: array title: HoursOfServiceRecords type: object description: Successfully got Hours of Service for carrier drivers '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Get all driver hours of service for the carrier tags: - carriers parameters: - $ref: '#/components/parameters/carrierId' - $ref: '#/components/parameters/providers' /carriers/{carrierId}/elds/hos/{driverId}/: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/HoursOfServiceResponse' description: Successfully got Hours of Service '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Get Hours of Service for the driver tags: - carriers parameters: - $ref: '#/components/parameters/carrierId' - $ref: '#/components/parameters/driverId' /carriers/{carrierId}/elds/power-unit-locations/: get: responses: '200': content: application/json: schema: properties: vehicle_locations: items: $ref: '#/components/schemas/VehicleLocation' type: array title: FleetLocationResponse type: object description: Successfully got locations default: $ref: '#/components/responses/defaultError' summary: Get most recently reported Locations for the fleet tags: - carriers parameters: - $ref: '#/components/parameters/carrierId' - $ref: '#/components/parameters/providers' /carriers/{carrierId}/elds/power-unit-locations/{powerUnitId}/: get: parameters: - $ref: '#/components/parameters/carrierId' - $ref: '#/components/parameters/powerUnitId' responses: '200': content: application/json: schema: $ref: '#/components/schemas/VehicleLocation' description: Successfully got vehicle location default: $ref: '#/components/responses/defaultError' summary: Get the most recent location for the power unit tags: - carriers /carriers/{carrierId}/power-units/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' - $ref: '#/components/parameters/powerUnitName' - $ref: '#/components/parameters/powerUnitNameContains' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/PowerUnit' type: array total_count: type: integer total_pages: type: integer title: PaginatedPowerUnit type: object description: Successfully returned a list of power units default: $ref: '#/components/responses/defaultError' summary: Power units for a carrier tags: - carriers parameters: - $ref: '#/components/parameters/carrierId' post: description: If this Carrier has an ELD Provider, calling this with no body, will pull the power units from the provider requestBody: $ref: '#/components/requestBodies/PowerUnit' responses: '201': content: application/json: schema: $ref: '#/components/schemas/PowerUnit' description: Successfully created a new power unit or if this has an ELD Provider, then successfully pulled vehicle information and created power units in which case, the response is a list of PowerUnits default: $ref: '#/components/responses/defaultError' summary: Creates a new power unit tags: - carriers /carriers/{carrierId}/power-units/{powerUnitId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a power unit tags: - carriers get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/PowerUnit' description: Successfully returned a power unit default: $ref: '#/components/responses/defaultError' summary: Obtain information about a power unit tags: - carriers parameters: - $ref: '#/components/parameters/carrierId' - $ref: '#/components/parameters/powerUnitId' put: requestBody: $ref: '#/components/requestBodies/PowerUnit' responses: '200': content: application/json: schema: $ref: '#/components/schemas/PowerUnit' description: Successfully returned a power unit default: $ref: '#/components/responses/defaultError' summary: Update information about a power unit tags: - carriers /carriers/{carrierId}/power-units/{powerUnitId}/shipments/: get: responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/Shipment' type: array description: Successfully returned a list of shipments default: $ref: '#/components/responses/defaultError' summary: Active shipments that have this power-unit assigned tags: - carriers parameters: - $ref: '#/components/parameters/carrierId' - $ref: '#/components/parameters/powerUnitId' /carriers/{carrierId}/trailers/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/Trailer' type: array total_count: type: integer total_pages: type: integer title: PaginatedTrailer type: object description: Successfully returned a list of trailers default: $ref: '#/components/responses/defaultError' summary: Trailers for a carrier tags: - carriers parameters: - $ref: '#/components/parameters/carrierId' post: requestBody: $ref: '#/components/requestBodies/Trailer' responses: '201': content: application/json: schema: $ref: '#/components/schemas/Trailer' description: Successfully created a new trailer default: $ref: '#/components/responses/defaultError' summary: Creates a new trailer tags: - carriers /carriers/{carrierId}/trailers/{trailerId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a trailer tags: - carriers get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/Trailer' description: Successfully returned a trailer default: $ref: '#/components/responses/defaultError' summary: Obtain information about a trailer tags: - carriers parameters: - $ref: '#/components/parameters/carrierId' - $ref: '#/components/parameters/trailerId' put: requestBody: $ref: '#/components/requestBodies/Trailer' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Trailer' description: Successfully returned a trailer default: $ref: '#/components/responses/defaultError' summary: Update information about a trailer tags: - carriers /companies/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' - $ref: '#/components/parameters/carrierIdQuery' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/Company' type: array total_count: type: integer total_pages: type: integer title: PaginatedCompany type: object description: Successfully returned a list of companies default: $ref: '#/components/responses/defaultError' summary: Returns a list of companies scoped to the authorization token. tags: - companies /companies/identifying-codes/: get: responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/IdentifyingCodeType' type: array description: Successfully returned a list of identifying codes default: $ref: '#/components/responses/defaultError' security: [] summary: A list of all identifying codes supported by the API tags: - companies /companies/{companyId}/: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/Company' description: Successfully returned a company default: $ref: '#/components/responses/defaultError' summary: Obtain information about a company tags: - companies parameters: - $ref: '#/components/parameters/companyId' put: requestBody: content: application/json: schema: $ref: '#/components/schemas/Company' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Company' description: Returns the updated company object default: $ref: '#/components/responses/defaultError' summary: Update a company tags: - companies /companies/{companyId}/documents/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/DocumentMetadata' type: array total_count: type: integer total_pages: type: integer title: PaginatedDocumentMetadata type: object description: Successfully retrieved company documents default: $ref: '#/components/responses/defaultError' summary: Get metadata about documents on a company tags: - companies parameters: - $ref: '#/components/parameters/companyId' post: requestBody: content: multipart/form-data: schema: properties: description: type: string file: format: binary type: string type: type: string required: - file - description - type type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/DocumentMetadata' description: Successfully created a document default: $ref: '#/components/responses/defaultError' summary: Create a document on a company tags: - companies /companies/{companyId}/documents/{documentId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a Company Document tags: - companies get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/DocumentMetadata' description: Successfully retrieved company document default: $ref: '#/components/responses/defaultError' summary: Get metadata about a company document tags: - companies parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/documentId' put: requestBody: content: application/json: schema: $ref: '#/components/schemas/DocumentMetadata' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DocumentMetadata' description: Successfully updated company document default: $ref: '#/components/responses/defaultError' summary: Update metadata about a company document tags: - companies /companies/{companyId}/drivers/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' - $ref: '#/components/parameters/providers' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/Driver' type: array total_count: type: integer total_pages: type: integer title: PaginatedDriver type: object description: Successfully returned a list of Drivers default: $ref: '#/components/responses/defaultError' summary: Returns a list of drivers associated to a company tags: - companies parameters: - $ref: '#/components/parameters/companyId' post: requestBody: content: application/json: schema: $ref: '#/components/schemas/Driver' responses: '201': content: application/json: schema: $ref: '#/components/schemas/Driver' description: Successfully created a new driver. If the request was for an init of ELD drivers, the response is ELDDriversCreated default: $ref: '#/components/responses/defaultError' summary: Creates a new driver. If the company has an ELD Provider, doing a post with an empty body will pull the drivers from the ELD Service and create users if the driver phone number and email are unique tags: - carriers x-codegen-request-body-name: body /companies/{companyId}/drivers/{driverId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a driver tags: - companies get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/Driver' description: Successfully returned a Driver default: $ref: '#/components/responses/defaultError' summary: Returns a driver associated to a company tags: - companies parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/driverId' put: requestBody: $ref: '#/components/requestBodies/Driver' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Driver' description: Successfully updated a Driver default: $ref: '#/components/responses/defaultError' summary: Update a driver tags: - companies /companies/{companyId}/preferences/: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/CompanyPreferences' description: Successfully returned company preference info default: $ref: '#/components/responses/defaultError' summary: Obtain the company's preferences tags: - companies parameters: - $ref: '#/components/parameters/companyId' put: requestBody: content: application/json: schema: $ref: '#/components/schemas/CompanyPreferences' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/CompanyPreferences' description: Successfully updated the company's preferences default: $ref: '#/components/responses/defaultError' summary: Update the company's preferences tags: - companies /companies/{companyId}/users/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' - $ref: '#/components/parameters/q' - $ref: '#/components/parameters/userFirstName' - $ref: '#/components/parameters/userLastName' - $ref: '#/components/parameters/userEmail' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/User' type: array total_count: type: integer total_pages: type: integer title: PaginatedUser type: object description: Successfully returned a list of users default: $ref: '#/components/responses/defaultError' summary: Returns a list of users associated to a company tags: - users parameters: - $ref: '#/components/parameters/companyId' post: requestBody: $ref: '#/components/requestBodies/PostCompaniesCompanyidUsers' responses: '201': content: application/json: schema: $ref: '#/components/schemas/User' description: Successfully created a new user default: $ref: '#/components/responses/defaultError' summary: Creates a new user tags: - users x-codegen-request-body-name: body /companies/{companyId}/users/{userId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a user tags: - users get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/User' description: Successfully returned a user default: $ref: '#/components/responses/defaultError' summary: Obtain information about a user tags: - users parameters: - $ref: '#/components/parameters/companyId' - $ref: '#/components/parameters/userId' put: requestBody: $ref: '#/components/requestBodies/PostCompaniesCompanyidUsers' responses: '200': content: application/json: schema: $ref: '#/components/schemas/User' description: Returns the updated user object default: $ref: '#/components/responses/defaultError' summary: Update a user tags: - users x-codegen-request-body-name: body /contracts/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' - $ref: '#/components/parameters/q' - $ref: '#/components/parameters/destinationsContains' - $ref: '#/components/parameters/destinationsStateProvince' - $ref: '#/components/parameters/originsContains' - $ref: '#/components/parameters/originsStateProvince' - $ref: '#/components/parameters/contractNameContains' - $ref: '#/components/parameters/contractStatus' - $ref: '#/components/parameters/equipmentTypes' - $ref: '#/components/parameters/modes' - $ref: '#/components/parameters/carrierRelationshipIdSearch' - $ref: '#/components/parameters/createdAt' - $ref: '#/components/parameters/updatedAt' - $ref: '#/components/parameters/rate' - $ref: '#/components/parameters/carrierNameContains' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/Contract' type: array total_count: type: integer total_pages: type: integer title: PaginatedContract type: object description: Paginated list of contracts default: $ref: '#/components/responses/defaultError' summary: List contracts tags: - contracts /contracts/{contractId}/: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/Contract' description: Successfully returned a Contract default: $ref: '#/components/responses/defaultError' summary: Retrieve a Contract tags: - contracts parameters: - $ref: '#/components/parameters/contractId' /documents/document-types/: get: responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/DocumentType' type: array description: Successfully returned a list of document types default: $ref: '#/components/responses/defaultError' security: [] summary: A list of all the currently supported document types tags: - documents /documents/generate-labels/: post: requestBody: content: application/json: schema: $ref: '#/components/schemas/BulkPrintLabelsRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/BulkPrintLabelsResponse' description: Successfully returned a batch of labels to print default: $ref: '#/components/responses/defaultError' summary: Generate shipping labels in bulk tags: - documents /imports/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/DataImport' type: array total_count: type: integer total_pages: type: integer title: PaginatedDataImport type: object description: Successfully returned a list of imports default: $ref: '#/components/responses/defaultError' summary: Get a list of imports tags: - imports post: requestBody: content: multipart/form-data: schema: properties: csv_file: format: binary type: string google_sheet_id: type: string google_sheet_tab: type: string is_complete: type: boolean name: type: string type: type: string required: - type type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/DataImport' description: Successfully started a new import default: $ref: '#/components/responses/defaultError' summary: Creates a new import tags: - imports /imports/importable-fields/: get: responses: '200': content: application/json: schema: additionalProperties: additionalProperties: properties: description: type: string required: type: boolean type: object type: object type: object description: Successfully returned a list of importable fields default: $ref: '#/components/responses/defaultError' summary: A list of all fields allowed to be imported for a given importable-type tags: - imports /imports/importable-types/: get: responses: '200': content: application/json: schema: additionalProperties: type: string type: object description: Successfully returned a list of importable types default: $ref: '#/components/responses/defaultError' summary: A list of all object types allowed to be imported. Key is the key which is used elsewhere, value is the human readable string tags: - imports /imports/{importId}/: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/DataImport' description: Successfully returned an import default: $ref: '#/components/responses/defaultError' summary: Obtain information about an import tags: - imports parameters: - $ref: '#/components/parameters/importId' put: requestBody: content: application/json: schema: $ref: '#/components/schemas/DataImport' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/DataImport' description: Returns the updated import object default: $ref: '#/components/responses/defaultError' summary: Update an import tags: - imports /imports/{importId}/column-mappings/: get: parameters: - $ref: '#/components/parameters/importId' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/ImportColumnMapping' type: array total_count: type: integer total_pages: type: integer title: PaginatedImportColumnMapping type: object description: Successfully returned a list column mappings for an import default: $ref: '#/components/responses/defaultError' summary: Get a list column mappings for an import tags: - imports /imports/{importId}/column-mappings/{importColumnMappingId}/: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/ImportColumnMapping' description: Successfully returned an import column mapping default: $ref: '#/components/responses/defaultError' summary: Obtain information about an import column mapping tags: - imports parameters: - $ref: '#/components/parameters/importId' - $ref: '#/components/parameters/importColumnMappingId' put: requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportColumnMapping' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ImportColumnMapping' description: Returns the updated import column mapping object default: $ref: '#/components/responses/defaultError' summary: Update an import column mapping tags: - imports /imports/{importId}/jobs/: get: responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/ImportJob' type: array total_count: type: integer total_pages: type: integer title: PaginatedImportJob type: object description: Successfully returned a list of import jobs default: $ref: '#/components/responses/defaultError' summary: Get a list jobs for an import tags: - imports parameters: - $ref: '#/components/parameters/importId' post: parameters: - $ref: '#/components/parameters/validateOnly' responses: '201': content: application/json: schema: $ref: '#/components/schemas/ImportJob' description: Returns the created job default: $ref: '#/components/responses/defaultError' summary: Validates then saves an import. This commits all data. tags: - imports /imports/{importId}/jobs/{importJobId}/: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/ImportJob' description: Successfully returned an import job default: $ref: '#/components/responses/defaultError' summary: Get a job for an import tags: - imports parameters: - $ref: '#/components/parameters/importId' - $ref: '#/components/parameters/importJobId' /imports/{importId}/rows/: get: parameters: - $ref: '#/components/parameters/importId' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/ImportRow' type: array total_count: type: integer total_pages: type: integer title: PaginatedImportRow type: object description: Successfully returned a list rows for an import default: $ref: '#/components/responses/defaultError' summary: Get a list rows for an import tags: - imports /imports/{importId}/rows/{importRowId}/: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/ImportRow' description: Successfully returned an import row default: $ref: '#/components/responses/defaultError' summary: Obtain information about an import row tags: - imports parameters: - $ref: '#/components/parameters/importId' - $ref: '#/components/parameters/importRowId' put: requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportRow' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ImportRow' description: Returns the updated import row default: $ref: '#/components/responses/defaultError' summary: Update an import row tags: - imports /imports/{importId}/values/{importValueId}/: parameters: - $ref: '#/components/parameters/importId' - $ref: '#/components/parameters/importValueId' put: requestBody: content: application/json: schema: $ref: '#/components/schemas/ImportValue' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ImportValue' description: Returns the updated import value default: $ref: '#/components/responses/defaultError' summary: Update an import value tags: - imports /location-types/: get: responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/LocationType' type: array description: Successfully returned a list of location types default: $ref: '#/components/responses/defaultError' security: [] summary: Get a list of all available location types tags: - locations /locations/addresses/validate/: post: description: This will validate and return back components, timezone, and any warnings or errors requestBody: content: application/json: schema: $ref: '#/components/schemas/FormattedAddress' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ValidatedAddress' description: The validated and parsed address default: $ref: '#/components/responses/defaultError' security: [] summary: Validate a formatted address tags: - locations /locations/distance/: post: description: This will take in two addresses and return the distance between them requestBody: content: application/json: schema: properties: destination: $ref: '#/components/schemas/Address' origin: $ref: '#/components/schemas/Address' title: DistanceRequest type: object required: true responses: '200': content: application/json: schema: properties: distance_meters: type: integer duration_seconds: type: integer title: DistanceResponse type: object description: The distance between addresses default: $ref: '#/components/responses/defaultError' summary: Get the distance between two locations tags: - locations /permissions/: get: responses: '200': content: application/json: schema: properties: description: type: string permissions: items: properties: display: type: string key: type: string title: Permission type: object type: array title: PermissionResponse type: object description: The permission categories and underlying permissions. default: $ref: '#/components/responses/defaultError' summary: Returns a dictionary of all permission categories and their underlying permissions. tags: - permissions /products/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' - $ref: '#/components/parameters/q' - description: Include products where the description contains this string in: query name: description__contains required: false schema: type: string - description: Include products where the product ref contains this string in: query name: product_ref__contains required: false schema: type: string - description: Include products where the package type contains this string in: query name: package_type__contains required: false schema: type: string responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/Product' type: array total_count: type: integer total_pages: type: integer title: PaginatedProduct type: object description: Successfully returns the list of products default: $ref: '#/components/responses/defaultError' summary: Return a list of products for a company tags: - products post: requestBody: $ref: '#/components/requestBodies/PostProducts' responses: '201': content: application/json: schema: $ref: '#/components/schemas/Product' description: Successfully created the product default: $ref: '#/components/responses/defaultError' summary: Create a Product tags: - products x-codegen-request-body-name: body /products/{productId}/: delete: parameters: - $ref: '#/components/parameters/productId' responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a product tags: - products get: parameters: - $ref: '#/components/parameters/productId' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Product' description: Successfully returns the product default: $ref: '#/components/responses/defaultError' summary: Return a specific product tags: - products put: parameters: - $ref: '#/components/parameters/productId' requestBody: $ref: '#/components/requestBodies/PostProducts' responses: '201': content: application/json: schema: $ref: '#/components/schemas/Product' description: Successfully created the product default: $ref: '#/components/responses/defaultError' summary: Update a product tags: - products x-codegen-request-body-name: body /purchase-orders/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' - $ref: '#/components/parameters/q' - $ref: '#/components/parameters/purchaseOrderArchived' - $ref: '#/components/parameters/purchaseOrderCreatedAt' - $ref: '#/components/parameters/purchaseOrderCreatedAtGte' - $ref: '#/components/parameters/purchaseOrderCreatedAtLte' - $ref: '#/components/parameters/purchaseOrderCreatedByUserContains' - $ref: '#/components/parameters/purchaseOrderCreatedByUserId' - $ref: '#/components/parameters/purchaseOrderCreatedByUserName' - $ref: '#/components/parameters/purchaseOrderCreatedByUserNameContains' - $ref: '#/components/parameters/purchaseOrderCustomerExternalIdContains' - $ref: '#/components/parameters/purchaseOrderCustomerNameContains' - $ref: '#/components/parameters/purchaseOrderDescriptionContains' - $ref: '#/components/parameters/purchaseOrderDestinationAddressContains' - $ref: '#/components/parameters/purchaseOrderInvoiceExternalIdContains' - $ref: '#/components/parameters/purchaseOrderOriginAddressContains' - $ref: '#/components/parameters/purchaseOrderPlannedDeliveryStartDatetime' - $ref: '#/components/parameters/purchaseOrderPlannedDeliveryEndDatetime' - $ref: '#/components/parameters/purchaseOrderPlannedDeliveryStartDatetimeGte' - $ref: '#/components/parameters/purchaseOrderPlannedDeliveryEndDatetimeGte' - $ref: '#/components/parameters/purchaseOrderPlannedDeliveryStartDatetimeLte' - $ref: '#/components/parameters/purchaseOrderPlannedDeliveryEndDatetimeLte' - $ref: '#/components/parameters/purchaseOrderPlannedPickupStartDatetime' - $ref: '#/components/parameters/purchaseOrderPlannedPickupEndDatetime' - $ref: '#/components/parameters/purchaseOrderPlannedPickupStartDatetimeGte' - $ref: '#/components/parameters/purchaseOrderPlannedPickupEndDatetimeGte' - $ref: '#/components/parameters/purchaseOrderPlannedPickupStartDatetimeLte' - $ref: '#/components/parameters/purchaseOrderPlannedPickupEndDatetimeLte' - $ref: '#/components/parameters/purchaseOrderActualDeliveryDatetime' - $ref: '#/components/parameters/purchaseOrderActualPickupDatetime' - $ref: '#/components/parameters/purchaseOrderActualDeliveryDatetimeGte' - $ref: '#/components/parameters/purchaseOrderActualPickupDatetimeGte' - $ref: '#/components/parameters/purchaseOrderActualDeliveryDatetimeLte' - $ref: '#/components/parameters/purchaseOrderActualPickupDatetimeLte' - $ref: '#/components/parameters/purchaseOrderOverallStatus' - $ref: '#/components/parameters/purchaseOrderPONumberContains' - $ref: '#/components/parameters/purchaseOrderShipmentAssigned' - $ref: '#/components/parameters/purchaseOrderShipmentId' - $ref: '#/components/parameters/purchaseOrderShipmentReferenceId' - $ref: '#/components/parameters/purchaseOrderSource' - $ref: '#/components/parameters/purchaseOrderSourceSystemIdContains' - $ref: '#/components/parameters/purchaseOrderStatus' - $ref: '#/components/parameters/purchaseOrderTotalPriceGte' - $ref: '#/components/parameters/purchaseOrderTotalPriceLte' - $ref: '#/components/parameters/purchaseOrderSupplierExternalIdContains' - $ref: '#/components/parameters/purchaseOrderSupplierNameContains' - $ref: '#/components/parameters/purchaseOrderName' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/PurchaseOrderResponse' type: array total_count: type: integer total_pages: type: integer title: PaginatedPurchaseOrder type: object description: Paginated list of purchase orders default: $ref: '#/components/responses/defaultError' summary: List purchase orders tags: - purchase-orders post: requestBody: $ref: '#/components/requestBodies/PurchaseOrder' responses: '201': content: application/json: schema: $ref: '#/components/schemas/PurchaseOrderResponse' description: Successfully created a purchase order default: $ref: '#/components/responses/defaultError' summary: Create a new purchase order tags: - purchase-orders /purchase-orders/build-shipment/: post: requestBody: content: application/json: schema: properties: customer: format: uuid type: string purchase_orders: items: format: uuid type: string type: array title: PurchaseOrderBuildShipmentRequest type: object required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/Shipment' description: Successfully created a shipment default: $ref: '#/components/responses/defaultError' summary: Build a shipment from purchase orders tags: - purchase-orders /purchase-orders/update-built-shipment/: put: requestBody: content: application/json: schema: properties: purchase_orders: items: format: uuid type: string type: array shipment: format: uuid type: string title: PurchaseOrderUpdateShipmentRequest type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Shipment' description: Successfully updated the shipment with purchase orders default: $ref: '#/components/responses/defaultError' summary: Update an existing shipment with purchase orders tags: - purchase-orders /purchase-orders/{purchaseOrderId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a PurchaseOrder tags: - purchase-orders get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/PurchaseOrderResponse' description: Successfully returned a PurchaseOrder default: $ref: '#/components/responses/defaultError' summary: Retrieve a PurchaseOrder tags: - purchase-orders parameters: - $ref: '#/components/parameters/purchaseOrderId' put: requestBody: $ref: '#/components/requestBodies/PurchaseOrder' responses: '200': content: application/json: schema: $ref: '#/components/schemas/PurchaseOrderResponse' description: Successfully updated a PurchaseOrder default: $ref: '#/components/responses/defaultError' summary: Update a PurchaseOrder tags: - purchase-orders /purchase-orders/{purchaseOrderId}/line-items/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/PurchaseOrderLineItem' type: array total_count: type: integer total_pages: type: integer title: PaginatedPurchaseOrderLineItem type: object description: Successfully returned a list of PurchaseOrderLineItems default: $ref: '#/components/responses/defaultError' summary: Get a list of line items for a given purchase order tags: - purchase-orders parameters: - $ref: '#/components/parameters/purchaseOrderId' post: requestBody: $ref: '#/components/requestBodies/PurchaseOrderLineItem' responses: '201': content: application/json: schema: $ref: '#/components/schemas/PurchaseOrderLineItem' description: Successfully created a PurchaseOrderLineItem default: $ref: '#/components/responses/defaultError' summary: Create a new PurchaseOrderLineItem tags: - purchase-orders /purchase-orders/{purchaseOrderId}/line-items/{purchaseOrderLineItemId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a PurchaseOrderLineItem tags: - purchase-orders get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/PurchaseOrderLineItem' description: Successfully returned a PurchaseOrderLineItem default: $ref: '#/components/responses/defaultError' summary: Obtain information about a PurchaseOrderLineItem tags: - purchase-orders parameters: - $ref: '#/components/parameters/purchaseOrderId' - $ref: '#/components/parameters/purchaseOrderLineItemId' put: requestBody: $ref: '#/components/requestBodies/PurchaseOrderLineItem' responses: '200': content: application/json: schema: $ref: '#/components/schemas/PurchaseOrderLineItem' description: Successfully updated a PurchaseOrderLineItem default: $ref: '#/components/responses/defaultError' summary: Update a PurchaseOrderLineItem tags: - purchase-orders /quoting/carrier-bids/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' - $ref: '#/components/parameters/carrierBidShipmentId' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/CarrierBid' type: array total_count: type: integer total_pages: type: integer title: PaginatedCarrierBid type: object description: Paginated list of carrier bids default: $ref: '#/components/responses/defaultError' summary: List all carrier bids tags: - carrier-bids post: requestBody: $ref: '#/components/requestBodies/CarrierBid' responses: '201': content: application/json: schema: $ref: '#/components/schemas/CarrierBid' description: Newly created carrier bid default: $ref: '#/components/responses/defaultError' summary: Create a carrier bid tags: - carrier-bids /quoting/carrier-bids/shipment-summary/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' - $ref: '#/components/parameters/q' - $ref: '#/components/parameters/shipmentStatus' - $ref: '#/components/parameters/open' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/CarrierBiddingSummaryShipment' type: array total_count: type: integer total_pages: type: integer title: PaginatedCarrierBiddingSummaryShipment type: object description: Paginated list of shipment carrier bidding summaries default: $ref: '#/components/responses/defaultError' summary: List carrier bidding-specific information about shipments tags: - carrier-bids /quoting/carrier-bids/{carrierBidId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a carrier bid tags: - carrier-bids get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/CarrierBid' description: The desired carrier bid default: $ref: '#/components/responses/defaultError' summary: Retrieve a carrier bid tags: - carrier-bids parameters: - $ref: '#/components/parameters/carrierBidId' put: requestBody: $ref: '#/components/requestBodies/CarrierBid' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CarrierBid' description: The updated carrier bid default: $ref: '#/components/responses/defaultError' summary: Update a carrier bid tags: - carrier-bids /quoting/fedex/package-types/: get: responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/FedexPackaging' type: array description: List of all Fedex custom package types default: $ref: '#/components/responses/defaultError' summary: List all Fedex custom package types tags: - shipment-master-list /quoting/loadboard/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' - $ref: '#/components/parameters/q' - $ref: '#/components/parameters/activeVendorAssignment' - $ref: '#/components/parameters/archived' - $ref: '#/components/parameters/bolNumber' - $ref: '#/components/parameters/bolNumberContains' - $ref: '#/components/parameters/bolNumberExclude' - $ref: '#/components/parameters/buyItNowAmountGte' - $ref: '#/components/parameters/buyItNowAmountLte' - $ref: '#/components/parameters/customer' - $ref: '#/components/parameters/customerContains' - $ref: '#/components/parameters/customerId' - $ref: '#/components/parameters/customerReferenceNumber' - $ref: '#/components/parameters/customerReferenceNumberContains' - $ref: '#/components/parameters/customerReferenceNumberExclude' - $ref: '#/components/parameters/deliveryStopsContains' - $ref: '#/components/parameters/deliveryStopsCompanyNameContains' - $ref: '#/components/parameters/destinationContains' - $ref: '#/components/parameters/destinationStateProvince' - $ref: '#/components/parameters/deliveryStopsStateProvince' - $ref: '#/components/parameters/drayageBookingNumber' - $ref: '#/components/parameters/drayageChassisNumber' - $ref: '#/components/parameters/drayageContainerNumber' - $ref: '#/components/parameters/drayageContainerReturnDateGte' - $ref: '#/components/parameters/drayageContainerReturnDateLte' - $ref: '#/components/parameters/drayageEstimatedArrivalDateGte' - $ref: '#/components/parameters/drayageEstimatedArrivalDateLte' - $ref: '#/components/parameters/drayageLastFreeDateGte' - $ref: '#/components/parameters/drayageLastFreeDateLte' - $ref: '#/components/parameters/drayageReleaseDateGte' - $ref: '#/components/parameters/drayageReleaseDateLte' - $ref: '#/components/parameters/drayageSealNumber' - $ref: '#/components/parameters/dropoffGte' - $ref: '#/components/parameters/dropoffLte' - $ref: '#/components/parameters/expiresAtGte' - $ref: '#/components/parameters/expiresAtLte' - $ref: '#/components/parameters/loadBoardBiddingStatus' - $ref: '#/components/parameters/loadBoardTenderStatus' - $ref: '#/components/parameters/loadBoardEnabled' - $ref: '#/components/parameters/nameContains' - $ref: '#/components/parameters/open' - $ref: '#/components/parameters/originContains' - $ref: '#/components/parameters/originStateProvince' - $ref: '#/components/parameters/pickupStopsStateProvince' - $ref: '#/components/parameters/pickupStopsContains' - $ref: '#/components/parameters/pickupStopsCompanyNameContains' - $ref: '#/components/parameters/pickupGte' - $ref: '#/components/parameters/pickupLte' - $ref: '#/components/parameters/pickupNumber' - $ref: '#/components/parameters/pickupNumberContains' - $ref: '#/components/parameters/pickupNumberExclude' - $ref: '#/components/parameters/proNumber' - $ref: '#/components/parameters/proNumberContains' - $ref: '#/components/parameters/proNumberExclude' - $ref: '#/components/parameters/purchaseOrderNumber' - $ref: '#/components/parameters/purchaseOrderNumberContains' - $ref: '#/components/parameters/purchaseOrderNumberExclude' - $ref: '#/components/parameters/referenceId' - $ref: '#/components/parameters/referenceIdContains' - $ref: '#/components/parameters/referenceIdExclude' - $ref: '#/components/parameters/reps' - $ref: '#/components/parameters/requestedEquipmentTypes' - $ref: '#/components/parameters/requestedEquipmentTypesContains' - $ref: '#/components/parameters/requestedShipmentModes' - $ref: '#/components/parameters/shipmentCreatedAtGte' - $ref: '#/components/parameters/shipmentCreatedAtLte' - $ref: '#/components/parameters/shipmentStatus' - $ref: '#/components/parameters/shipmentStatusExclude' - $ref: '#/components/parameters/shipmentStatusContains' - $ref: '#/components/parameters/shipmentTags' - $ref: '#/components/parameters/stopsContains' - $ref: '#/components/parameters/stopsCompanyNameContains' - $ref: '#/components/parameters/stopsStateProvince' - $ref: '#/components/parameters/totalMilesGte' - $ref: '#/components/parameters/totalMilesLte' - $ref: '#/components/parameters/vendor' - $ref: '#/components/parameters/vendorContains' - $ref: '#/components/parameters/totalWeightOverrideGte' - $ref: '#/components/parameters/totalWeightOverrideLte' - $ref: '#/components/parameters/originRadius' - $ref: '#/components/parameters/originLat' - $ref: '#/components/parameters/originLon' - $ref: '#/components/parameters/pickupRadius' - $ref: '#/components/parameters/pickupLat' - $ref: '#/components/parameters/pickupLon' - $ref: '#/components/parameters/destinationRadius' - $ref: '#/components/parameters/destinationLat' - $ref: '#/components/parameters/destinationLon' - $ref: '#/components/parameters/deliveryRadius' - $ref: '#/components/parameters/deliveryLat' - $ref: '#/components/parameters/deliveryLon' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/LoadBoardShipment' type: array total_count: type: integer total_pages: type: integer title: PaginatedLoadBoardShipment type: object description: Paginated list of load board shipments default: $ref: '#/components/responses/defaultError' summary: List all shipments available on a carrier load board tags: - loadboard /quoting/loadboard/{loadBoardShipmentId}/: get: parameters: - $ref: '#/components/parameters/loadBoardShipmentId' responses: '200': content: application/json: schema: $ref: '#/components/schemas/LoadBoardShipment' description: The requested load board shipment default: $ref: '#/components/responses/defaultError' summary: Retrieve a load board shipment by its id tags: - loadboard /quoting/loadboard/{loadBoardShipmentId}/spot-negotiations/: post: parameters: - $ref: '#/components/parameters/loadBoardShipmentId' requestBody: $ref: '#/components/requestBodies/SpotNegotiation' responses: '201': content: application/json: schema: $ref: '#/components/schemas/SpotNegotiation' description: The newly created spot negotiation default: $ref: '#/components/responses/defaultError' summary: Create a spot negotiation for a load board shipment tags: - loadboard /quoting/privatemarket/rfqs/{rfqId}/customer-negotiation-preview/: get: responses: '200': content: application/json: schema: properties: message: type: string template: type: string title: CustomerNegotiationPreview type: object description: The HTML Template and Message default: $ref: '#/components/responses/defaultError' summary: Returns a preview of the HTML Email that will be sent and the included message tags: - private-market parameters: - $ref: '#/components/parameters/rfqId' /quoting/privatemarket/rfqs/{rfqId}/customer-negotiation/: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/SpotNegotiation' description: Customer-facing SpotNegotiation default: $ref: '#/components/responses/defaultError' summary: 'Retrieve a SpotNegotiation for the given RFQ that is outbound to a customer rather than inbound from solicited capacity providers ' tags: - private-market parameters: - $ref: '#/components/parameters/rfqId' put: requestBody: $ref: '#/components/requestBodies/SpotNegotiation' responses: '200': content: application/json: schema: $ref: '#/components/schemas/SpotNegotiation' description: Updated customer-facing SpotNegotiation default: $ref: '#/components/responses/defaultError' summary: 'Retrieve a SpotNegotiation for the given RFQ that is outbound to a customer rather than inbound from solicited capacity providers ' tags: - private-market /quoting/privatemarket/rfqs/{rfqId}/spot-negotiation-preview/: get: responses: '200': content: application/json: schema: properties: message: type: string template: type: string title: SpotNegotiationPreview type: object description: The HTML Template and Message default: $ref: '#/components/responses/defaultError' summary: Returns a preview of the HTML Email that will be sent and the included message tags: - private-market parameters: - $ref: '#/components/parameters/rfqId' /quoting/privatemarket/rfqs/{rfqId}/spot-negotiations/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' - description: 'Integer boolean, if equal to True SpotNegotiations will expand Quotes under the SpotNegotiation ' in: query name: expand_quotes required: false schema: type: boolean responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/SpotNegotiation' type: array total_count: type: integer total_pages: type: integer title: PaginatedSpotNegotiation type: object description: 'List of SpotNegotiations, excluding the external customer negotiation if one exists ' default: $ref: '#/components/responses/defaultError' summary: List all SpotNegotiations under this RFQ tags: - private-market parameters: - $ref: '#/components/parameters/rfqId' /quoting/privatemarket/shipments/{shipmentId}/discover-solicited-negotiation/: get: parameters: - $ref: '#/components/parameters/shipmentId' responses: '200': content: application/json: schema: $ref: '#/components/schemas/SpotNegotiation' description: The most recent SpotNegotiation soliciting the Company '404': content: application/json: schema: $ref: '#/components/schemas/ShipwellError' description: Shipment has no SpotNegotiations soliciting the Company default: $ref: '#/components/responses/defaultError' summary: 'For a given Shipment id, find the most recently created SpotNegotiation for which the authenticated Company is the solicited company ' tags: - private-market /quoting/privatemarket/spot-negotiations/: post: requestBody: $ref: '#/components/requestBodies/BulkCreateSpotNegotiationRequest' responses: '201': content: application/json: schema: items: $ref: '#/components/schemas/SpotNegotiation' type: array description: List of all SpotNegotiations for the provided RFQ default: $ref: '#/components/responses/defaultError' summary: Bulk create SpotNegotiations for an RFQ and emails tags: - private-market /quoting/privatemarket/spot-negotiations/{spotNegotiationId}/: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/SpotNegotiation' description: SpotNegotiation with the provided id default: $ref: '#/components/responses/defaultError' summary: Retrieve a SpotNegotiation tags: - private-market parameters: - $ref: '#/components/parameters/spotNegotiationId' /quoting/privatemarket/spot-negotiations/{spotNegotiationId}/award-decline-quote/{spotNegotiationQuoteId}/: parameters: - $ref: '#/components/parameters/spotNegotiationId' - $ref: '#/components/parameters/spotNegotiationQuoteId' put: requestBody: $ref: '#/components/requestBodies/AwardDeclineQuoteRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Quote' description: The updated SpotNegotiation Quote default: $ref: '#/components/responses/defaultError' summary: Award or decline a SpotNegotiation Quote tags: - private-market /quoting/privatemarket/spot-negotiations/{spotNegotiationId}/link-quote/: parameters: - $ref: '#/components/parameters/spotNegotiationId' - $ref: '#/components/parameters/companyImpersonation' put: requestBody: content: application/json: schema: properties: acceptor_emails: description: Email addresses to which the quote will be sent items: format: email type: string type: array link: description: true to link the Quote, and false to unlink type: boolean message: description: Message to include in Quote Email that get sent out type: string quote: description: id of the Quote to link/unlink format: uuid type: string required: - link - quote title: LinkQuoteToSpotNegotiationRequest type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Quote' description: The updated Quote object default: $ref: '#/components/responses/defaultError' summary: Link/unlink an existing Quote to a SpotNegotiation tags: - private-market /quoting/privatemarket/spot-negotiations/{spotNegotiationId}/messages/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/SpotNegotiationMessage' type: array total_count: type: integer total_pages: type: integer title: PaginatedSpotNegotiationMessage type: object description: Successfully returned a list of SpotNegotiationMessages default: $ref: '#/components/responses/defaultError' summary: Get a list of messages for a SpotNegotiation tags: - private-market parameters: - $ref: '#/components/parameters/spotNegotiationId' post: requestBody: $ref: '#/components/requestBodies/SpotNegotiationMessage' responses: '201': content: application/json: schema: $ref: '#/components/schemas/SpotNegotiationMessage' description: Successfully created a SpotNegotiationMessage default: $ref: '#/components/responses/defaultError' summary: Create a new SpotNegotiationMessage tags: - private-market /quoting/privatemarket/spot-negotiations/{spotNegotiationId}/messages/{spotNegotiationMessageId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a SpotNegotiationMessage tags: - private-market get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/SpotNegotiationMessage' description: Successfully returned a SpotNegotiationMessage default: $ref: '#/components/responses/defaultError' summary: Obtain information about SpotNegotiationMessage tags: - private-market parameters: - $ref: '#/components/parameters/spotNegotiationId' - $ref: '#/components/parameters/spotNegotiationMessageId' put: requestBody: $ref: '#/components/requestBodies/SpotNegotiationMessage' responses: '200': content: application/json: schema: $ref: '#/components/schemas/SpotNegotiationMessage' description: Successfully updated a SpotNegotiationMessage default: $ref: '#/components/responses/defaultError' summary: Update a SpotNegotiationMessage tags: - private-market /quoting/privatemarket/spot-negotiations/{spotNegotiationId}/quotes/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' - $ref: '#/components/parameters/includeFailureQuotes' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/Quote' type: array total_count: type: integer total_pages: type: integer title: PaginatedSpotNegotiationQuote type: object description: Successfully returned a list of SpotNegotiation quotes default: $ref: '#/components/responses/defaultError' summary: Get a list of quotes for a SpotNegotiation tags: - private-market parameters: - $ref: '#/components/parameters/spotNegotiationId' post: requestBody: $ref: '#/components/requestBodies/CreateSpotNegotiationQuote' responses: '201': content: application/json: schema: $ref: '#/components/schemas/Quote' description: Successfully created a SpotNegotiation Quote default: $ref: '#/components/responses/defaultError' summary: Create a new SpotNegotiation Quote tags: - private-market /quoting/privatemarket/spot-negotiations/{spotNegotiationId}/quotes/{spotNegotiationQuoteId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a SpotNegotiation Quote tags: - private-market get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/Quote' description: Successfully returned a SpotNegotiation Quote default: $ref: '#/components/responses/defaultError' summary: Obtain information about a SpotNegotiation Quote tags: - private-market parameters: - $ref: '#/components/parameters/spotNegotiationId' - $ref: '#/components/parameters/spotNegotiationQuoteId' put: requestBody: $ref: '#/components/requestBodies/Quote' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Quote' description: Successfully updated a SpotNegotiation Quote default: $ref: '#/components/responses/defaultError' summary: Update a SpotNegotiation Quote tags: - private-market /quoting/rfqs/: parameters: - $ref: '#/components/parameters/companyImpersonation' post: description: 'An RFQ is a Request For Quote. All quotes will be created under an RFQ. ' requestBody: $ref: '#/components/requestBodies/RFQ' responses: '201': content: application/json: schema: $ref: '#/components/schemas/RFQ' description: Successfully created a RFQ default: $ref: '#/components/responses/defaultError' summary: Create a new RFQ, kicking off autoquoting if specified tags: - quoting /quoting/rfqs/{rfqId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete an RFQ tags: - quoting get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/RFQ' description: Successfully returned an RFQ default: $ref: '#/components/responses/defaultError' summary: Obtain information about an RFQ tags: - quoting parameters: - $ref: '#/components/parameters/rfqId' - $ref: '#/components/parameters/companyImpersonation' - $ref: '#/components/parameters/includeFailureQuotes' put: description: 'Note: Complexities of updating not implemented' requestBody: $ref: '#/components/requestBodies/RFQ' responses: '200': content: application/json: schema: $ref: '#/components/schemas/RFQ' description: Successfully updated an RFQ default: $ref: '#/components/responses/defaultError' summary: Update an RFQ tags: - quoting /quoting/rfqs/{rfqId}/quotes/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' - $ref: '#/components/parameters/includeFailureQuotes' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/Quote' type: array total_count: type: integer total_pages: type: integer title: PaginatedQuote type: object description: Successfully returned a list of quotes default: $ref: '#/components/responses/defaultError' summary: Get a list of all quotes under an RFQ tags: - quoting parameters: - $ref: '#/components/parameters/rfqId' - $ref: '#/components/parameters/companyImpersonation' post: description: 'Note: Need to add more info about creating a quote here' requestBody: $ref: '#/components/requestBodies/CreateQuote' responses: '201': content: application/json: schema: $ref: '#/components/schemas/Quote' description: Successfully created a new quote default: $ref: '#/components/responses/defaultError' summary: Create a new quote under an RFQ tags: - quoting /quoting/rfqs/{rfqId}/quotes/{quoteId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a Quote tags: - quoting get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/Quote' description: Successfully returned a Quote default: $ref: '#/components/responses/defaultError' summary: Obtain information about a quote tags: - quoting parameters: - $ref: '#/components/parameters/rfqId' - $ref: '#/components/parameters/quoteId' - $ref: '#/components/parameters/companyImpersonation' put: description: 'Note: this route might be eliminated, so create new quotes when possible' requestBody: $ref: '#/components/requestBodies/CreateQuote' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Quote' description: Successfully updated a Quote default: $ref: '#/components/responses/defaultError' summary: Update a quote tags: - quoting /quoting/spotnegotiations/shipments/{shipmentId}/spot-negotiations/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - description: 'Boolean, if True will include quotes ' in: query name: expand_quotes required: false schema: type: boolean responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/SpotNegotiation' type: array total_count: type: integer total_pages: type: integer title: PaginatedSpotNegotiation type: object description: Paginated list of SpotNegotiations default: $ref: '#/components/responses/defaultError' summary: 'List all outstanding negotiations under this shipment where the authenticated user is a customer ' tags: - spot-negotiations parameters: - $ref: '#/components/parameters/shipmentId' post: requestBody: $ref: '#/components/requestBodies/BulkCreateSpotNegotiationRequest' responses: '201': content: application/json: schema: items: $ref: '#/components/schemas/SpotNegotiation' type: array description: 'List of newly created negotiations ' default: $ref: '#/components/responses/defaultError' summary: Bulk create SpotNegotiations for a Shipment tags: - spot-negotiations /quoting/spotnegotiations/shipments/{shipmentId}/spot-negotiations/customer-negotiation/: parameters: - $ref: '#/components/parameters/shipmentId' post: requestBody: $ref: '#/components/requestBodies/SpotNegotiation' responses: '200': content: application/json: schema: $ref: '#/components/schemas/SpotNegotiation' description: The customer SpotNegotiation default: $ref: '#/components/responses/defaultError' summary: 'Get, create, or update a negotiation in which you are the vendor and the shipment''s customer_freight_authority is the customer. Only available to companies that are already assigned as a vendor to that customer. ' tags: - spot-negotiations /quoting/spotnegotiations/shipments/{shipmentId}/spot-negotiations/preview/: get: parameters: - description: 'If True, render a template for sending a quote to a customer. Else, render a request for quote to be sent to a vendor. ' in: query name: is_customer_facing required: false schema: type: boolean responses: '200': content: application/json: schema: properties: message: type: string template: type: string title: SpotNegotiationPreview type: object description: The HTML Template and Message default: $ref: '#/components/responses/defaultError' summary: Returns a preview of the HTML Email that will be sent and the included message tags: - spot-negotiations parameters: - $ref: '#/components/parameters/shipmentId' /quoting/spotnegotiations/spot-negotiations/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' - $ref: '#/components/parameters/q' - $ref: '#/components/parameters/spotnegotiationClosedByCustomer' - $ref: '#/components/parameters/spotnegotiationClosedByVendor' - $ref: '#/components/parameters/spotnegotiationCustomerId' - $ref: '#/components/parameters/spotnegotiationCustomerNameContains' - $ref: '#/components/parameters/spotnegotiationInvolvedOnly' - $ref: '#/components/parameters/spotnegotiationInvolvedVendorUsers' - $ref: '#/components/parameters/spotnegotiationIsMostRecentWinner' - $ref: '#/components/parameters/spotnegotiationIsOpen' - $ref: '#/components/parameters/spotnegotiationShipment' - $ref: '#/components/parameters/spotnegotiationShipmentBolNumber' - $ref: '#/components/parameters/spotnegotiationShipmentBolNumberContains' - $ref: '#/components/parameters/spotnegotiationShipmentCapacityProviderCustomerReferenceNumber' - $ref: '#/components/parameters/spotnegotiationShipmentCapacityProviderCustomerReferenceNumberContains' - $ref: '#/components/parameters/spotnegotiationShipmentCustomerReferenceNumber' - $ref: '#/components/parameters/spotnegotiationShipmentCustomerReferenceNumberContains' - $ref: '#/components/parameters/spotnegotiationShipmentDelayed' - $ref: '#/components/parameters/spotnegotiationShipmentDestinationContains' - $ref: '#/components/parameters/spotnegotiationShipmentDropoffGte' - $ref: '#/components/parameters/spotnegotiationShipmentDropoffLte' - $ref: '#/components/parameters/spotnegotiationShipmentName' - $ref: '#/components/parameters/spotnegotiationShipmentNameContains' - $ref: '#/components/parameters/spotnegotiationShipmentOriginContains' - $ref: '#/components/parameters/spotnegotiationShipmentPickupGte' - $ref: '#/components/parameters/spotnegotiationShipmentPickupLte' - $ref: '#/components/parameters/spotnegotiationShipmentPickupNumber' - $ref: '#/components/parameters/spotnegotiationShipmentPickupNumberContains' - $ref: '#/components/parameters/spotnegotiationShipmentProNumber' - $ref: '#/components/parameters/spotnegotiationShipmentProNumberContains' - $ref: '#/components/parameters/spotnegotiationShipmentPurchaseOrderNumber' - $ref: '#/components/parameters/spotnegotiationShipmentPurchaseOrderNumberContains' - $ref: '#/components/parameters/spotnegotiationShipmentReferenceId' - $ref: '#/components/parameters/spotnegotiationShipmentReferenceIdContains' - $ref: '#/components/parameters/spotnegotiationShipmentState' - $ref: '#/components/parameters/spotnegotiationShipmentStatus' - $ref: '#/components/parameters/spotnegotiationVendorId' - $ref: '#/components/parameters/spotnegotiationVendorNameContains' - description: 'Boolean, if True will include quotes ' in: query name: expand_quotes required: false schema: type: integer responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/ShipmentSpotNegotiation' type: array total_count: type: integer total_pages: type: integer title: PaginatedShipmentSpotNegotiation type: object description: List of SpotNegotiations with shipments expanded default: $ref: '#/components/responses/defaultError' summary: List all SpotNegotiations in which the user's company is involved tags: - spot-negotiations /quoting/spotnegotiations/spot-negotiations/open-close/: post: requestBody: content: application/json: schema: properties: close: description: If true, close the negotiations, else open them type: boolean spot_negotiations: description: SpotNegotiation ids to open or close items: format: uuid type: string type: array required: - spot_negotiations - close title: OpenCloseSpotNegotiationsRequest type: object required: true responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/SpotNegotiation' type: array description: List of updated SpotNegotiations default: $ref: '#/components/responses/defaultError' summary: Open or close authenticated company's side of the provided negotiations tags: - spot-negotiations /quoting/spotnegotiations/spot-negotiations/{spotNegotiationId}/: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/ShipmentSpotNegotiation' description: ShipmentSpotNegotiation with the given id default: $ref: '#/components/responses/defaultError' summary: Retrieve a ShipmentSpotNegotiation by its id tags: - spot-negotiations parameters: - $ref: '#/components/parameters/spotNegotiationId' put: requestBody: content: application/json: schema: $ref: '#/components/schemas/ShipmentSpotNegotiation' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ShipmentSpotNegotiation' description: Successfully updated ShipmentSpotNegotiation default: $ref: '#/components/responses/defaultError' summary: Update a ShipmentSpotNegotiation tags: - spot-negotiations /quoting/spotnegotiations/spot-negotiations/{spotNegotiationId}/buy-it-now/: parameters: - $ref: '#/components/parameters/spotNegotiationId' post: requestBody: $ref: '#/components/requestBodies/BuyItNowRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/SpotNegotiation' description: The spot negotiation between customer and vendor default: $ref: '#/components/responses/defaultError' summary: Accept a shipment for the customer buy-it-now amount tags: - spot-negotiations /quoting/spotnegotiations/spot-negotiations/{spotNegotiationId}/messages/: get: parameters: - $ref: '#/components/parameters/q' - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/SpotNegotiationMessage' type: array total_count: type: integer total_pages: type: integer title: PaginatedSpotNegotiationMessage type: object description: List of SpotNegotiationMessages default: $ref: '#/components/responses/defaultError' summary: List all SpotNegotiationMessages of a SpotNegotiation tags: - spot-negotiations parameters: - $ref: '#/components/parameters/spotNegotiationId' post: requestBody: $ref: '#/components/requestBodies/SpotNegotiationMessage' responses: '201': content: application/json: schema: $ref: '#/components/schemas/SpotNegotiationMessage' description: Newly created SpotNegotiationMessage default: $ref: '#/components/responses/defaultError' summary: Create a SpotNegotiationMessage tags: - spot-negotiations /quoting/spotnegotiations/spot-negotiations/{spotNegotiationId}/messages/{spotNegotiationMessageId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a SpotNegotiationMessage tags: - spot-negotiations get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/SpotNegotiationMessage' description: The requested SpotNegotiationMessage default: $ref: '#/components/responses/defaultError' summary: Retrieve a SpotNegotiationMessage tags: - spot-negotiations parameters: - $ref: '#/components/parameters/spotNegotiationId' - $ref: '#/components/parameters/spotNegotiationMessageId' put: requestBody: $ref: '#/components/requestBodies/SpotNegotiationMessage' responses: '200': content: application/json: schema: $ref: '#/components/schemas/SpotNegotiationMessage' description: The updated SpotNegotiationMessage default: $ref: '#/components/responses/defaultError' summary: Update a SpotNegotiationMessage tags: - spot-negotiations /quoting/spotnegotiations/spot-negotiations/{spotNegotiationId}/quotes/: get: responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/Quote' type: array total_count: type: integer total_pages: type: integer title: PaginatedQuote type: object description: List of all Quotes under the SpotNegotiation default: $ref: '#/components/responses/defaultError' summary: List all Quotes of the SpotNegotiation tags: - spot-negotiations parameters: - $ref: '#/components/parameters/spotNegotiationId' post: requestBody: $ref: '#/components/requestBodies/CreateSpotNegotiationQuote' responses: '201': content: application/json: schema: $ref: '#/components/schemas/Quote' description: Newly created Quote object default: $ref: '#/components/responses/defaultError' summary: Create a Quote on the SpotNegotiation tags: - spot-negotiations /quoting/spotnegotiations/spot-negotiations/{spotNegotiationId}/quotes/{spotNegotiationQuoteId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a SpotNegotiation Quote tags: - spot-negotiations get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/Quote' description: Successfully returned a SpotNegotiation Quote default: $ref: '#/components/responses/defaultError' summary: Obtain information about a SpotNegotiation Quote tags: - spot-negotiations parameters: - $ref: '#/components/parameters/spotNegotiationId' - $ref: '#/components/parameters/spotNegotiationQuoteId' put: requestBody: $ref: '#/components/requestBodies/Quote' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Quote' description: Successfully updated a SpotNegotiation Quote default: $ref: '#/components/responses/defaultError' summary: Update a SpotNegotiation Quote tags: - spot-negotiations /quoting/spotnegotiations/spot-negotiations/{spotNegotiationId}/quotes/{spotNegotiationQuoteId}/award-decline/: parameters: - $ref: '#/components/parameters/spotNegotiationId' - $ref: '#/components/parameters/spotNegotiationQuoteId' put: requestBody: $ref: '#/components/requestBodies/AwardDeclineQuoteRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Quote' description: The updated SpotNegotiation Quote default: $ref: '#/components/responses/defaultError' summary: Award or decline a SpotNegotiation Quote tags: - spot-negotiations /quoting/ups/package-types/: get: responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/UPSPackaging' type: array description: List of all UPS custom package types default: $ref: '#/components/responses/defaultError' summary: List all UPS custom package types tags: - reference-data /quoting/usps/package-types/: get: responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/USPSPackaging' type: array description: List of all USPS custom package types default: $ref: '#/components/responses/defaultError' summary: List all USPS custom package types tags: - reference-data /registration/FEDEX/: get: responses: '200': content: application/json: schema: allOf: - $ref: '#/components/schemas/FedexAccount' - properties: address: $ref: '#/components/schemas/GenesisAddress' type: object description: Successfully returned Fedex account default: $ref: '#/components/responses/defaultError' summary: Obtain FedexAccount information tags: - registration parameters: - $ref: '#/components/parameters/accountNumber' post: description: 'Company has to have an account with Fedex before registering with Shipwell. ' requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisterFedex' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/RegisterFedexResponse' description: Fedex account was already registered with Shipwell '201': content: application/json: schema: $ref: '#/components/schemas/RegisterFedexResponse' description: Successfully registered Fedex account with Shipwell default: $ref: '#/components/responses/defaultError' summary: Registers Company's Fedex account with Shipwell tags: - registration /registration/FEDEX/{fedexAccountId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a registered Fedex account tags: - registration parameters: - $ref: '#/components/parameters/fedexAccountId' put: description: Can only modify freight account number and smart post hub id at this time requestBody: content: application/json: schema: $ref: '#/components/schemas/FedexAccount' required: true responses: '200': content: application/json: schema: allOf: - $ref: '#/components/schemas/FedexAccount' - properties: address: $ref: '#/components/schemas/GenesisAddress' type: object description: Successfully updated Fedex account default: $ref: '#/components/responses/defaultError' summary: Update a Company's Fedex account with Shipwell tags: - registration /registration/UPS/: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/UPSAccount' description: Successfully returned UPS account default: $ref: '#/components/responses/defaultError' summary: Obtain UPSAccount information tags: - registration parameters: - $ref: '#/components/parameters/accountNumber' post: description: 'Company has to have an account with UPS before registering with Shipwell. ' requestBody: content: application/json: schema: $ref: '#/components/schemas/RegisterUPS' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/RegisterUPSResponse' description: UPS account was already registered with Shipwell '201': content: application/json: schema: $ref: '#/components/schemas/RegisterUPSResponse' description: Successfully registered UPS account with Shipwell default: $ref: '#/components/responses/defaultError' summary: Registers Company's UPS account with Shipwell tags: - registration /registration/UPS/{upsAccountId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a registered UPS account tags: - registration parameters: - $ref: '#/components/parameters/upsAccountId' /registration/USPS/: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/USPSAccount' description: Successfully returned USPS account default: $ref: '#/components/responses/defaultError' summary: Obtain USPSAccount information tags: - registration parameters: - $ref: '#/components/parameters/accountNumber' /registration/USPS/{uspsAccountId}: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/USPSAccount' description: Successfully returned USPS account default: $ref: '#/components/responses/defaultError' summary: Obtain USPSAccount information tags: - registration parameters: - $ref: '#/components/parameters/uspsAccountId' /routing-guide/policies/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' - $ref: '#/components/parameters/q' - $ref: '#/components/parameters/createdAt' - $ref: '#/components/parameters/updatedAt' - $ref: '#/components/parameters/destinationsContains' - $ref: '#/components/parameters/destinationsStateProvince' - $ref: '#/components/parameters/originsContains' - $ref: '#/components/parameters/originsStateProvince' - $ref: '#/components/parameters/equipmentTypes' - $ref: '#/components/parameters/modes' - $ref: '#/components/parameters/policyNameContains' - $ref: '#/components/parameters/policyEndDateGte' - $ref: '#/components/parameters/policyEndDateLte' - $ref: '#/components/parameters/policyStartDateGte' - $ref: '#/components/parameters/policyStartDateLte' - $ref: '#/components/parameters/policyStatus' - $ref: '#/components/parameters/policyType' - $ref: '#/components/parameters/policyReference' - $ref: '#/components/parameters/policyWorkflowId' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/Policy' type: array total_count: type: integer total_pages: type: integer title: PaginatedPolicy type: object description: Paginated list of policies default: $ref: '#/components/responses/defaultError' summary: List of policies tags: - policies post: requestBody: content: application/json: schema: $ref: '#/components/schemas/Policy' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/Policy' description: Successfully created a policy default: $ref: '#/components/responses/defaultError' summary: Create a new policy tags: - policies /routing-guide/policies/{policyId}/: delete: responses: '200': content: application/json: schema: $ref: '#/components/schemas/Policy' description: Successfully deleted a Policy default: $ref: '#/components/responses/defaultError' summary: Delete a Policy tags: - policies get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/Policy' description: Successfully returned a Policy default: $ref: '#/components/responses/defaultError' summary: Retrieve a Policy tags: - policies parameters: - $ref: '#/components/parameters/policyId' put: requestBody: content: application/json: schema: $ref: '#/components/schemas/Policy' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Policy' description: Successfully updated a Policy default: $ref: '#/components/responses/defaultError' summary: Update a Policy tags: - policies /service-level-agreements/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' - $ref: '#/components/parameters/q' - $ref: '#/components/parameters/serviceLevelAgreementStatus' - $ref: '#/components/parameters/serviceLevelAgreementName' - $ref: '#/components/parameters/serviceLevelAgreementPosition' - $ref: '#/components/parameters/serviceLevelAgreementStartDateGte' - $ref: '#/components/parameters/serviceLevelAgreementStartDateLte' - $ref: '#/components/parameters/serviceLevelAgreementEndDateGte' - $ref: '#/components/parameters/serviceLevelAgreementEndDateLte' - $ref: '#/components/parameters/serviceLevelAgreementAwardedLoadsPerDay' - $ref: '#/components/parameters/serviceLevelAgreementCapacityPerDay' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/ServiceLevelAgreement' type: array total_count: type: integer total_pages: type: integer title: PaginatedServiceLevelAgreement type: object description: Paginated list of service level agreements default: $ref: '#/components/responses/defaultError' summary: List service level agreements tags: - service-level-agreements post: requestBody: $ref: '#/components/requestBodies/ServiceLevelAgreement' responses: '201': content: application/json: schema: $ref: '#/components/schemas/ServiceLevelAgreement' description: Successfully created a ServiceLevelAgreement default: $ref: '#/components/responses/defaultError' summary: Create a new ServiceLevelAgreement tags: - service-level-agreements /service-level-agreements/{serviceLevelAgreementId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a ServiceLevelAgreement tags: - service-level-agreements get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/ServiceLevelAgreement' description: Successfully returned a ServiceLevelAgreement default: $ref: '#/components/responses/defaultError' summary: Retrieve a ServiceLevelAgreement tags: - service-level-agreements parameters: - $ref: '#/components/parameters/serviceLevelAgreementId' put: requestBody: $ref: '#/components/requestBodies/ServiceLevelAgreement' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ServiceLevelAgreement' description: Successfully updated a ServiceLevelAgreement default: $ref: '#/components/responses/defaultError' summary: Update a ServiceLevelAgreement tags: - service-level-agreements /shipments/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' - $ref: '#/components/parameters/q' - $ref: '#/components/parameters/activeVendorAssignment' - $ref: '#/components/parameters/alerts' - $ref: '#/components/parameters/archived' - $ref: '#/components/parameters/bolNumber' - $ref: '#/components/parameters/bolNumberContains' - $ref: '#/components/parameters/bolNumberExclude' - $ref: '#/components/parameters/createdAt' - $ref: '#/components/parameters/createdBySource' - $ref: '#/components/parameters/createdByUserContains' - $ref: '#/components/parameters/createdByUserId' - $ref: '#/components/parameters/createdByUserName' - $ref: '#/components/parameters/createdByUserNameContains' - $ref: '#/components/parameters/customer' - $ref: '#/components/parameters/customerContains' - $ref: '#/components/parameters/customerId' - $ref: '#/components/parameters/customerReferenceNumber' - $ref: '#/components/parameters/customerReferenceNumberContains' - $ref: '#/components/parameters/customerReferenceNumberExclude' - $ref: '#/components/parameters/destinationContains' - $ref: '#/components/parameters/deliveryStopsContains' - $ref: '#/components/parameters/deliveryStopsCompanyNameContains' - $ref: '#/components/parameters/destinationStateProvince' - $ref: '#/components/parameters/deliveryStopsStateProvince' - $ref: '#/components/parameters/drayageBookingNumber' - $ref: '#/components/parameters/drayageChassisNumber' - $ref: '#/components/parameters/drayageContainerNumber' - $ref: '#/components/parameters/drayageContainerReturnDateGte' - $ref: '#/components/parameters/drayageContainerReturnDateLte' - $ref: '#/components/parameters/drayageEstimatedArrivalDateGte' - $ref: '#/components/parameters/drayageEstimatedArrivalDateLte' - $ref: '#/components/parameters/drayageLastFreeDateGte' - $ref: '#/components/parameters/drayageLastFreeDateLte' - $ref: '#/components/parameters/drayageReleaseDateGte' - $ref: '#/components/parameters/drayageReleaseDateLte' - $ref: '#/components/parameters/drayageSealNumber' - $ref: '#/components/parameters/driverAssigned' - $ref: '#/components/parameters/dropoffGte' - $ref: '#/components/parameters/dropoffLte' - $ref: '#/components/parameters/equipmentType' - $ref: '#/components/parameters/equipmentTypeContains' - $ref: '#/components/parameters/fedexAccount' - $ref: '#/components/parameters/groupId' - $ref: '#/components/parameters/hasInvoice' - $ref: '#/components/parameters/hasBill' - $ref: '#/components/parameters/include' - $ref: '#/components/parameters/loadBoardEnabled' - $ref: '#/components/parameters/loadBoardId' - $ref: '#/components/parameters/loadBoardIdContains' - $ref: '#/components/parameters/mode' - $ref: '#/components/parameters/modeContains' - $ref: '#/components/parameters/nameContains' - $ref: '#/components/parameters/open' - $ref: '#/components/parameters/originContains' - $ref: '#/components/parameters/originStateProvince' - $ref: '#/components/parameters/pickupStopsStateProvince' - $ref: '#/components/parameters/pickupStopsContains' - $ref: '#/components/parameters/pickupStopsCompanyNameContains' - $ref: '#/components/parameters/parcelPickupStatus' - $ref: '#/components/parameters/pickupGte' - $ref: '#/components/parameters/pickupLte' - $ref: '#/components/parameters/pickupId' - $ref: '#/components/parameters/pickupNumber' - $ref: '#/components/parameters/pickupNumberContains' - $ref: '#/components/parameters/pickupNumberExclude' - $ref: '#/components/parameters/proNumber' - $ref: '#/components/parameters/proNumberContains' - $ref: '#/components/parameters/proNumberExclude' - $ref: '#/components/parameters/powerUnit' - $ref: '#/components/parameters/purchaseOrderNumber' - $ref: '#/components/parameters/purchaseOrderNumberContains' - $ref: '#/components/parameters/purchaseOrderNumberExclude' - $ref: '#/components/parameters/referenceId' - $ref: '#/components/parameters/referenceIdContains' - $ref: '#/components/parameters/referenceIdExclude' - $ref: '#/components/parameters/reps' - $ref: '#/components/parameters/role' - $ref: '#/components/parameters/serviceLevel' - $ref: '#/components/parameters/shipmentAccessorials' - $ref: '#/components/parameters/shipmentCreatedAtGte' - $ref: '#/components/parameters/shipmentCreatedAtLte' - $ref: '#/components/parameters/shipmentStatus' - $ref: '#/components/parameters/shipmentStatusExclude' - $ref: '#/components/parameters/shipmentStatusContains' - $ref: '#/components/parameters/shipmentTags' - $ref: '#/components/parameters/stopsContains' - $ref: '#/components/parameters/stopsCompanyNameContains' - $ref: '#/components/parameters/stopsStateProvince' - $ref: '#/components/parameters/timelineLastUpdatedAtGte' - $ref: '#/components/parameters/timelineLastUpdatedAtLte' - $ref: '#/components/parameters/timeFrame' - $ref: '#/components/parameters/totalMilesGte' - $ref: '#/components/parameters/totalMilesLte' - $ref: '#/components/parameters/upsAccount' - $ref: '#/components/parameters/vendor' - $ref: '#/components/parameters/vendorContains' - $ref: '#/components/parameters/totalWeightOverrideGte' - $ref: '#/components/parameters/totalWeightOverrideLte' - $ref: '#/components/parameters/originRadius' - $ref: '#/components/parameters/originLat' - $ref: '#/components/parameters/originLon' - $ref: '#/components/parameters/pickupRadius' - $ref: '#/components/parameters/pickupLat' - $ref: '#/components/parameters/pickupLon' - $ref: '#/components/parameters/destinationRadius' - $ref: '#/components/parameters/destinationLat' - $ref: '#/components/parameters/destinationLon' - $ref: '#/components/parameters/deliveryRadius' - $ref: '#/components/parameters/deliveryLat' - $ref: '#/components/parameters/deliveryLon' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/SlimShipment' type: array total_count: type: integer total_pages: type: integer title: PaginatedSlimShipment type: object description: Successfully returned a list of Shipments default: $ref: '#/components/responses/defaultError' summary: Get a list of shipments tags: - shipments parameters: - $ref: '#/components/parameters/companyImpersonation' post: description: 'Shipments start in a "draft" state by default. Only the `metadata` parameter set to `"open": false, "archived": false,` and `tags:` set to `[]` are required to begin a draft shipment.' requestBody: $ref: '#/components/requestBodies/Shipment' responses: '201': content: application/json: schema: $ref: '#/components/schemas/Shipment' description: Successfully created a Shipment default: $ref: '#/components/responses/defaultError' summary: Create a new Shipment tags: - shipments /shipments/accessorials/: get: responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/Accessorial' type: array description: Successfully returned a list of accessorials default: $ref: '#/components/responses/defaultError' security: [] summary: A list of all shipment accessorials supported by the API tags: - reference-data /shipments/appointment-types/: get: responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/AppointmentType' type: array description: Successfully returnes a list of appointment types default: $ref: '#/components/responses/defaultError' summary: A list of all appointment types supported by the API tags: - reference-data /shipments/charge-line-item-categories/: get: responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/ChargeLineItemCategory' type: array description: Successfully returned a list charge line item categories default: $ref: '#/components/responses/defaultError' summary: A list of all charge line item categories supported by the API tags: - reference-data /shipments/equipment-types/: get: responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/EquipmentType' type: array description: Successfully returned a list of Equipment Types default: $ref: '#/components/responses/defaultError' summary: A list of all Equipment Types supported by the API tags: - reference-data /shipments/external/: get: responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/Shipment' type: array description: List of shipments found (with limited data) default: $ref: '#/components/responses/defaultError' summary: 'Return a limited amount of shipment details using API Key authentication and query params to search. Returns an empty list if no query params are passed ' tags: - shipments parameters: - $ref: '#/components/parameters/bolNumber' - $ref: '#/components/parameters/pickupNumber' - $ref: '#/components/parameters/proNumber' - $ref: '#/components/parameters/purchaseOrderNumber' /shipments/external/{shipmentId}/: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/Shipment' description: Limited data about a Shipment default: $ref: '#/components/responses/defaultError' security: [] summary: 'Retrieve a limited amount of shipment details using a query param key instead of authentication ' tags: - shipments parameters: - $ref: '#/components/parameters/shipmentId' - $ref: '#/components/parameters/externalShipmentViewKey' /shipments/external/{shipmentId}/tracking/: get: parameters: - $ref: '#/components/parameters/beginDatetime' - $ref: '#/components/parameters/endDatetime' - $ref: '#/components/parameters/shipmentLocationFilterDistance' responses: '200': content: application/json: schema: properties: shipment_locations: items: $ref: '#/components/schemas/ELDDeviceLocation' type: array tracking_source: enum: - eld - mobile_app - unknown type: string tracking_status: enum: - tracking_not_setup - not_tracking - tracking - tracking_complete type: string title: ShipmentLocationResponse type: object description: List of locations for the given Shipment default: $ref: '#/components/responses/defaultError' security: [] summary: 'Get locations for the shipment using a query param key instead of authentication ' tags: - shipments parameters: - $ref: '#/components/parameters/shipmentId' - $ref: '#/components/parameters/externalShipmentViewKey' /shipments/hazmat/: get: responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/Hazmat' type: array description: Successfully returned a list of hazmat items default: $ref: '#/components/responses/defaultError' summary: A list of all hazmat supported by the API tags: - reference-data /shipments/linear-feet/: post: requestBody: content: application/json: schema: $ref: '#/components/schemas/LinearFeetEstimate' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/LinearFeetEstimate' description: Successfully calculated linear feet default: $ref: '#/components/responses/defaultError' summary: 'Estimate how many linear feet of a truck that ShipmentLineItems would fill if packed optimally ' tags: - shipments /shipments/nmfc/: get: responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/NMFC' type: array description: Successfully returned a list of NMFCs default: $ref: '#/components/responses/defaultError' summary: A list of all NMFCs supported by the API tags: - reference-data /shipments/package-types/: get: responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/PackageType' type: array description: Successfully returned a list of package types default: $ref: '#/components/responses/defaultError' security: [] summary: A list of all package types supported by the API tags: - reference-data /shipments/pickups/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' - $ref: '#/components/parameters/q' - $ref: '#/components/parameters/scheduledDate' - $ref: '#/components/parameters/scheduledDateGte' - $ref: '#/components/parameters/scheduledDateLte' - $ref: '#/components/parameters/scheduledTimeWindowStartGte' - $ref: '#/components/parameters/scheduledTimeWindowStartLte' - $ref: '#/components/parameters/scheduledTimeWindowEndGte' - $ref: '#/components/parameters/scheduledTimeWindowEndLte' - $ref: '#/components/parameters/pointOfContact' - $ref: '#/components/parameters/pointOfContactContains' - $ref: '#/components/parameters/pointOfContactExcludes' - $ref: '#/components/parameters/specialInstructions' - $ref: '#/components/parameters/specialInstructionsContains' - $ref: '#/components/parameters/specialInstructionsExcludes' - $ref: '#/components/parameters/pickupPickupNumber' - $ref: '#/components/parameters/pickupPickupNumberContains' - $ref: '#/components/parameters/pickupPickupNumberExcludes' - $ref: '#/components/parameters/providerCode' - $ref: '#/components/parameters/providerCarrierCode' - $ref: '#/components/parameters/providerCarrierCodeContains' - $ref: '#/components/parameters/providerCarrierCodeExcludes' - $ref: '#/components/parameters/providerLocationId' - $ref: '#/components/parameters/providerLocationIdContains' - $ref: '#/components/parameters/providerLocationIdExcludes' - $ref: '#/components/parameters/addressBookEntry' - $ref: '#/components/parameters/isRegularlyScheduled' - $ref: '#/components/parameters/cancelled' - $ref: '#/components/parameters/pickupShipmentIds' - $ref: '#/components/parameters/pickupCompany' - $ref: '#/components/parameters/fedexAccount' - $ref: '#/components/parameters/upsAccount' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/ShipmentPickup' type: array total_count: type: integer total_pages: type: integer title: PaginatedShipmentPickup type: object description: List of cases for a given company summary: List of pickups for a company tags: - shipments post: requestBody: content: application/json: schema: $ref: '#/components/schemas/ScheduleShipmentPickupRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ShipmentPickup' description: Pickup details default: $ref: '#/components/responses/defaultError' summary: Schedule a pickup tags: - shipments /shipments/pickups/{shipmentPickupId}/: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/ShipmentPickup' description: Data for shipment pickup default: $ref: '#/components/responses/defaultError' summary: Retrieve data for a shipment pickup tags: - shipments parameters: - $ref: '#/components/parameters/shipmentPickupId' put: requestBody: content: application/json: schema: $ref: '#/components/schemas/ShipmentPickup' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ShipmentPickup' description: Successfully updated the shipment pickup default: $ref: '#/components/responses/defaultError' summary: Update a shipment pickup tags: - shipments /shipments/pickups/{shipmentPickupId}/cancel/: parameters: - $ref: '#/components/parameters/shipmentPickupId' post: responses: '200': content: application/json: schema: $ref: '#/components/schemas/ShipmentPickup' description: Pickup details default: $ref: '#/components/responses/defaultError' summary: Cancel a scheduled pickup tags: - shipment-actions /shipments/piece-types/: get: responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/PieceType' type: array description: Successfully returned a list of piece types default: $ref: '#/components/responses/defaultError' security: [] summary: A list of all piece types supported by the API tags: - reference-data /shipments/service-levels/: get: responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/ServiceLevel' type: array description: Successfully returned a list of service levels default: $ref: '#/components/responses/defaultError' summary: A list of all service levels supported by the API tags: - reference-data /shipments/shipment-modes/: get: responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/ShipmentMode' type: array description: Successfully returned a list of shipment modes default: $ref: '#/components/responses/defaultError' summary: A list of all shipment modes supported by the API tags: - reference-data /shipments/shipment-rep-roles/: get: responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/ShipmentRepRole' type: array description: Successfully returned a list of shipment rep roles default: $ref: '#/components/responses/defaultError' summary: A list of all shipment rep roles supported by the API tags: - reference-data /shipments/statuses/: get: parameters: - description: If true, exclude statuses that can be automated based on stop status transitions in: query name: exclude_stop_automated_statuses required: false schema: type: boolean responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/ShipmentState' type: array description: Successfully returned a list of shipment states default: $ref: '#/components/responses/defaultError' summary: A list of all shipment states supported by the API tags: - reference-data /shipments/stop-event-types/: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/GroupedEnum' description: Description of stop event type enum default: $ref: '#/components/responses/defaultError' summary: List of all stop event types supported by the API along with their categorial groupings tags: - shipments /shipments/stop-locations/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/stopLocationCompanyName' - $ref: '#/components/parameters/stopLocationCompanyNameContains' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/StopLocation' type: array total_count: type: integer total_pages: type: integer title: PaginatedShipmentStopLocation type: object description: Successfully returned a list of stop locations for shipments user is associated with default: $ref: '#/components/responses/defaultError' summary: Get a list of all stop locations for shipments user is associated with tags: - shipments /shipments/stop-status-reason-codes/: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/GroupedEnum' description: Description of stop status reason code enum default: $ref: '#/components/responses/defaultError' summary: List of all stop status reason codes supported by the API along with their categorial groupings tags: - reference-data /shipments/tags/: get: responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/ShipmentTag' type: array description: List of all ShipmentTags for a company default: $ref: '#/components/responses/defaultError' summary: List all ShipmentTags for the authenticated company tags: - shipments post: requestBody: $ref: '#/components/requestBodies/ShipmentTag' responses: '201': content: application/json: schema: $ref: '#/components/schemas/ShipmentTag' description: The newly created ShipmentTag default: $ref: '#/components/responses/defaultError' summary: Create a ShipmentTag for the authenticated company tags: - shipments /shipments/tags/{shipmentTagId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a ShipmentTag tags: - shipments get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/ShipmentTag' description: The ShipmentTag with the given id default: $ref: '#/components/responses/defaultError' summary: Retrieve a ShipmentTag by its id tags: - shipments parameters: - $ref: '#/components/parameters/shipmentTagId' put: requestBody: $ref: '#/components/requestBodies/ShipmentTag' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ShipmentTag' description: The updated ShipmentTag default: $ref: '#/components/responses/defaultError' summary: Update a ShipmentTag tags: - shipments /shipments/tenders/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' - $ref: '#/components/parameters/q' - $ref: '#/components/parameters/tenderCreatedByCompany' - $ref: '#/components/parameters/tenderCustomerShipperReferenceNumber' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/TenderRequest' type: array total_count: type: integer total_pages: type: integer title: PaginatedTenders type: object description: Shipment successfully tendered default: $ref: '#/components/responses/defaultError' summary: List tendered shipments tags: - shipments post: requestBody: $ref: '#/components/requestBodies/TenderRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/TenderRequest' description: Shipment successfully tendered default: $ref: '#/components/responses/defaultError' summary: Create and tender a shipment to a Shipwell company tags: - shipments /shipments/tenders/{tenderId}/: delete: responses: '204': description: Shipment successfully marked as closed default: $ref: '#/components/responses/defaultError' summary: Mark a tendered shipment as no longer available. Renders as 'closed' in the Shipwell platform. tags: - shipments parameters: - $ref: '#/components/parameters/tenderId' put: requestBody: $ref: '#/components/requestBodies/TenderRequest' responses: '200': content: application/json: schema: $ref: '#/components/schemas/TenderRequest' description: Shipment successfully tendered default: $ref: '#/components/responses/defaultError' summary: 'Update a tendered shipment to a shipwell company NOTE: Only valid for shipments created by posting to this endpoint. Shipments created via other methods are not guaranteed to work and may have unintended side effects.' tags: - shipments /shipments/tenders/{tenderId}/actions/: parameters: - $ref: '#/components/parameters/tenderId' post: requestBody: $ref: '#/components/requestBodies/TenderAcceptReject' responses: '200': content: application/json: schema: $ref: '#/components/schemas/SpotNegotiation' description: Accepted or Rejected SpotNegotiations default: $ref: '#/components/responses/defaultError' summary: Accept or reject tendered shipments. tags: - shipments /shipments/tenders/{tenderId}/events/: parameters: - $ref: '#/components/parameters/tenderId' post: requestBody: $ref: '#/components/requestBodies/TenderEventRequest' responses: '200': content: application/json: schema: properties: message: type: string type: object description: Tender events successfully saved. default: $ref: '#/components/responses/defaultError' summary: Update tendered Shipment events. tags: - shipments /shipments/{shipmentId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a shipment tags: - shipments get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/Shipment' description: Successfully returned a shipment default: $ref: '#/components/responses/defaultError' summary: Obtain information about a shipment tags: - shipments parameters: - $ref: '#/components/parameters/shipmentId' - $ref: '#/components/parameters/companyImpersonation' put: description: 'After a successful update, the ''stops'' and ''line_items'' of the Shipment will be exactly the same as those provided in the request. This means that if existing ''stops'' or ''ShipmentLineItems'' were left out of their arrays, those objects would be deleted. Providing existing objects in those arrays with their ids will update those objects instead of creating or deleting them. Providing objects in the arrays that do not have ids will create new objects. If you omit the ''stops'' or ''line_items'' arrays from the request body, no changes will be made to those related object sets. ' requestBody: $ref: '#/components/requestBodies/Shipment' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Shipment' description: Successfully updated a Shipment default: $ref: '#/components/responses/defaultError' summary: Update a shipment tags: - shipments /shipments/{shipmentId}/auto-book/: parameters: - $ref: '#/components/parameters/shipmentId' post: requestBody: content: application/json: schema: properties: fedex_specific_options: $ref: '#/components/schemas/FedexShipmentOptions' quote: description: id of the quote to auto-book format: uuid type: string ups_specific_options: $ref: '#/components/schemas/UPSShipmentOptions' usps_specific_options: $ref: '#/components/schemas/USPSShipmentOptions' required: - quote title: AutoBookRequest type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Shipment' description: Successfully updated shipment default: $ref: '#/components/responses/defaultError' summary: 'Award an automated quote to a shipment, assign its carrier, dispatch through carriers API, generate a BOL, and send notifications ' tags: - shipment-actions /shipments/{shipmentId}/automation/events/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/AutomationEvent' type: array total_count: type: integer total_pages: type: integer title: PaginatedAutomationEvent type: object description: Retrieved events default: $ref: '#/components/responses/defaultError' summary: Retrieve automated shipwell events tags: - shipments parameters: - $ref: '#/components/parameters/shipmentId' post: requestBody: $ref: '#/components/requestBodies/AutomationEvent' responses: '201': content: application/json: schema: $ref: '#/components/schemas/AutomationEvent' description: Newly created event default: $ref: '#/components/responses/defaultError' summary: Schedule an automated shipwell event tags: - shipments /shipments/{shipmentId}/automation/events/cancel-scheduled/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Cancel and delete all future scheduled automation events on a shipment tags: - shipments parameters: - $ref: '#/components/parameters/shipmentId' /shipments/{shipmentId}/automation/events/{automationEventId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a shipwell automation event tags: - shipments get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/AutomationEvent' description: The shipwell automation event default: $ref: '#/components/responses/defaultError' summary: Retrieve a shipwell automation event tags: - shipments parameters: - $ref: '#/components/parameters/shipmentId' - $ref: '#/components/parameters/automationEventId' put: requestBody: $ref: '#/components/requestBodies/AutomationEvent' responses: '200': content: application/json: schema: $ref: '#/components/schemas/AutomationEvent' description: Updated automation event default: $ref: '#/components/responses/defaultError' summary: Update a shipwell automation event tags: - shipments /shipments/{shipmentId}/award-quote/: parameters: - $ref: '#/components/parameters/shipmentId' post: requestBody: content: application/json: schema: properties: quote: description: Id of the Quote to award format: uuid type: string title: AwardQuoteRequest type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Shipment' description: Successfully updated Shipment default: $ref: '#/components/responses/defaultError' summary: Award a quote to a shipment tags: - shipment-actions /shipments/{shipmentId}/cancel/: parameters: - $ref: '#/components/parameters/shipmentId' post: requestBody: content: application/json: schema: properties: cancellation_reason: description: Reason for cancellation type: string title: CancellationRequest type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Shipment' description: Successfully updated shipment default: $ref: '#/components/responses/defaultError' summary: 'Cancel a shipment, and notify the currently assigned carrier of cancellation in an email ' tags: - shipment-actions /shipments/{shipmentId}/carrier-assignments/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete the carrier assignment associated with the shipment tags: - shipments get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/CarrierAssignment' description: Successfully returned a Carrier Assignment default: $ref: '#/components/responses/defaultError' summary: Get the current assigned carrier associated with this shipment tags: - shipments parameters: - $ref: '#/components/parameters/shipmentId' post: description: 'Only one carrier assignment is associated with a company-shipment combo at a time. Posting here will overwrite the companies carrier assignment. Carrier assignments are only shown to the user who sets it ' requestBody: $ref: '#/components/requestBodies/CarrierAssignment' responses: '201': content: application/json: schema: $ref: '#/components/schemas/CarrierAssignment' description: Successfully created a carrier assignment default: $ref: '#/components/responses/defaultError' summary: Create a new carrier assignment tags: - shipments /shipments/{shipmentId}/carrier-assignments/{carrierAssignmentId}/: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/CarrierAssignment' description: The requested CarrierAssignment default: $ref: '#/components/responses/defaultError' summary: Retrieve a CarrierAssignment by its id tags: - shipments parameters: - $ref: '#/components/parameters/shipmentId' - $ref: '#/components/parameters/carrierAssignmentId' put: requestBody: $ref: '#/components/requestBodies/CarrierAssignment' responses: '200': content: application/json: schema: $ref: '#/components/schemas/CarrierAssignment' description: Successfully updated charge line items default: $ref: '#/components/responses/defaultError' summary: Update the charge line items of a CarrierAssignment tags: - shipments /shipments/{shipmentId}/documents/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/ShipmentDocumentMetadata' type: array total_count: type: integer total_pages: type: integer title: PaginatedShipmentDocumentMetadata type: object description: Successfully retrieved document metadata default: $ref: '#/components/responses/defaultError' summary: Get metadata about a documents on a shipment tags: - shipments parameters: - $ref: '#/components/parameters/shipmentId' post: requestBody: content: multipart/form-data: schema: properties: description: type: string file: format: binary type: string is_carrier_document: type: boolean type: type: string required: - file - type - description - is_carrier_document type: object responses: '201': content: application/json: schema: $ref: '#/components/schemas/ShipmentDocumentMetadata' description: Successfully create a document default: $ref: '#/components/responses/defaultError' summary: Create a document on a shipment tags: - shipments /shipments/{shipmentId}/documents/auditlog/: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/DocumentAuditlog' description: Successfully retrieved auditlog for documents sent default: $ref: '#/components/responses/defaultError' summary: Get auditlog of documents sent tags: - shipments parameters: - $ref: '#/components/parameters/shipmentId' /shipments/{shipmentId}/documents/generate_bol/: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/ShipmentDocumentMetadata' description: Successfully generate BOL default: $ref: '#/components/responses/defaultError' summary: Generate a BOL for a shipment tags: - shipments parameters: - $ref: '#/components/parameters/shipmentId' /shipments/{shipmentId}/documents/generate_rate_confirmation/: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/ShipmentDocumentMetadata' description: Successfully generated rate confirmation default: $ref: '#/components/responses/defaultError' summary: Generate a rate confirmation for a shipment tags: - shipments parameters: - $ref: '#/components/parameters/shipmentId' /shipments/{shipmentId}/documents/send/: parameters: - $ref: '#/components/parameters/shipmentId' post: requestBody: content: application/json: schema: $ref: '#/components/schemas/SendDocument' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/SendDocument' description: 'Task to send emails was properly enqueued to email service ' default: $ref: '#/components/responses/defaultError' summary: Send shipment documents to a list of email recipients tags: - shipments /shipments/{shipmentId}/documents/{documentId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a Document tags: - shipments get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/ShipmentDocumentMetadata' description: Successfully retrieved document metadata default: $ref: '#/components/responses/defaultError' summary: Get metadata about a document tags: - shipments parameters: - $ref: '#/components/parameters/shipmentId' - $ref: '#/components/parameters/documentId' put: requestBody: $ref: '#/components/requestBodies/ShipmentDocumentMetadata' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ShipmentDocumentMetadata' description: Successfully updated document metadata default: $ref: '#/components/responses/defaultError' summary: Update metadata about a document tags: - shipments /shipments/{shipmentId}/equipment-config/: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/EquipmentConfig' description: Successfully returned an equipment Config default: $ref: '#/components/responses/defaultError' summary: Get the current equipment config associated with this shipment tags: - shipments parameters: - $ref: '#/components/parameters/shipmentId' post: description: 'Only one equipment config is associated with a shipment at a time. Posting here will overwrite the previous equipment config and attempt to track with the new configuration. ' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateEquipmentConfig' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/EquipmentConfig' description: Successfully created an EquipmentConfig default: $ref: '#/components/responses/defaultError' summary: Create a new equipment config tags: - shipments /shipments/{shipmentId}/ftl-instant-rate-dispatch/: parameters: - $ref: '#/components/parameters/shipmentId' post: requestBody: content: application/json: schema: properties: quote: format: uuid type: string required: - quote title: FtlInstantRateDispatchRequest type: object required: true responses: '200': content: application/json: schema: properties: spot_negotiation_id: format: uuid type: string title: FtlInstantRateDispatchResponse type: object description: Successfully requested instant rate default: $ref: '#/components/responses/defaultError' summary: Request a previously generated FTL Instant Rate tags: - shipment-actions /shipments/{shipmentId}/initiate-check-call/: parameters: - $ref: '#/components/parameters/shipmentId' post: requestBody: content: application/json: schema: $ref: '#/components/schemas/InitiateCheckCallRequest' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/Shipment' description: Successfully updated Shipment default: $ref: '#/components/responses/defaultError' summary: 'Initiate a check call on the given shipment to the provided phone number ' tags: - shipment-actions /shipments/{shipmentId}/messages/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/q' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/ShipmentMessage' type: array total_count: type: integer total_pages: type: integer title: PaginatedShipmentMessage type: object description: List of messages for the given Shipment default: $ref: '#/components/responses/defaultError' summary: List messages for a Shipment tags: - shipments parameters: - $ref: '#/components/parameters/shipmentId' post: requestBody: $ref: '#/components/requestBodies/ShipmentMessage' responses: '201': content: application/json: schema: $ref: '#/components/schemas/ShipmentMessage' description: The newly created ShipmentMessage default: $ref: '#/components/responses/defaultError' summary: Create a new message for a Shipment tags: - shipments /shipments/{shipmentId}/messages/{shipmentMessageId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a ShipmentMessage tags: - shipments get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/ShipmentMessage' description: Data for a ShipmentMessage default: $ref: '#/components/responses/defaultError' summary: Retrieve data for a ShipmentMessage tags: - shipments parameters: - $ref: '#/components/parameters/shipmentId' - $ref: '#/components/parameters/shipmentMessageId' put: requestBody: $ref: '#/components/requestBodies/ShipmentMessage' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ShipmentMessage' description: The updated ShipmentMessage default: $ref: '#/components/responses/defaultError' summary: Update a ShipmentMessage tags: - shipments /shipments/{shipmentId}/notes/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/ShipmentNote' type: array total_count: type: integer total_pages: type: integer title: PaginatedShipmentNote type: object description: List of notes for the given Shipment or Shipment Quote default: $ref: '#/components/responses/defaultError' summary: List notes for a Shipment or Shipment Quote tags: - shipments parameters: - $ref: '#/components/parameters/shipmentId' post: requestBody: $ref: '#/components/requestBodies/ShipmentNote' responses: '201': content: application/json: schema: $ref: '#/components/schemas/ShipmentNote' description: The newly created ShipmentNote default: $ref: '#/components/responses/defaultError' summary: Create a new note for a Shipment or Shipment Quote tags: - shipments /shipments/{shipmentId}/notes/{shipmentNoteId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a ShipmentNote tags: - shipments get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/ShipmentNote' description: Data for a Shipment Note default: $ref: '#/components/responses/defaultError' summary: Retrieve data for a ShipmentNote tags: - shipments parameters: - $ref: '#/components/parameters/shipmentId' - $ref: '#/components/parameters/shipmentNoteId' put: requestBody: $ref: '#/components/requestBodies/ShipmentNote' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ShipmentNote' description: The updated ShipmentNote default: $ref: '#/components/responses/defaultError' summary: Update a ShipmentNote tags: - shipments /shipments/{shipmentId}/reps/: get: parameters: - $ref: '#/components/parameters/shipmentId' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/ShipmentRep' type: array total_count: type: integer total_pages: type: integer title: PaginatedShipmentRep type: object description: Successfully returned list of reps default: $ref: '#/components/responses/defaultError' summary: Get the list of the shipment reps tags: - shipments post: parameters: - $ref: '#/components/parameters/shipmentId' requestBody: content: application/json: schema: properties: role: description: Id of the role type: integer user: description: Id of the user format: uuid type: string title: CreateShipmentRepRequest type: object required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/ShipmentRep' description: Successfully added rep to shipment default: $ref: '#/components/responses/defaultError' summary: Add a rep to a shipment tags: - shipments /shipments/{shipmentId}/reps/{repId}/: delete: parameters: - $ref: '#/components/parameters/shipmentId' - $ref: '#/components/parameters/repId' responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a rep record tags: - shipments get: parameters: - $ref: '#/components/parameters/shipmentId' - $ref: '#/components/parameters/repId' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ShipmentRep' description: Retrieved Rep default: $ref: '#/components/responses/defaultError' summary: Get a specific shipment rep tags: - shipments put: parameters: - $ref: '#/components/parameters/shipmentId' - $ref: '#/components/parameters/repId' requestBody: content: application/json: schema: properties: role: description: Id of the role type: integer user: description: Id of the user format: uuid type: string title: UpdateShipmentRepRequest type: object required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/ShipmentRep' description: Updated rep default: $ref: '#/components/responses/defaultError' summary: Update a Rep record tags: - shipments /shipments/{shipmentId}/request-app-download/: parameters: - $ref: '#/components/parameters/shipmentId' post: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Send an SMS message requesting that someone download Shipwell app tags: - shipments /shipments/{shipmentId}/route/: parameters: - $ref: '#/components/parameters/shipmentId' post: responses: '200': content: application/json: schema: $ref: '#/components/schemas/ShipmentRoute' description: Recommended route default: $ref: '#/components/responses/defaultError' summary: Get route from Here API, store it and return the route. tags: - shipments /shipments/{shipmentId}/routing-guide/initiate/: parameters: - $ref: '#/components/parameters/shipmentId' post: requestBody: content: application/json: schema: properties: workflow: format: uuid type: string required: - workflow title: InitiateRoutingGuideRequest type: object required: true responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Initiate a routing guide workflow for the given shipment tags: - shipment-actions /shipments/{shipmentId}/send-shipment-booked/: get: responses: '200': description: Successfully sent default: $ref: '#/components/responses/defaultError' summary: Trigger sending the shipment booked notification to all applicable actors on a shipment tags: - shipment-actions parameters: - $ref: '#/components/parameters/shipmentId' - $ref: '#/components/parameters/companyImpersonation' /shipments/{shipmentId}/share/: parameters: - $ref: '#/components/parameters/shipmentId' post: requestBody: content: application/json: schema: $ref: '#/components/schemas/ShareShipment' required: true responses: '201': content: application/json: schema: $ref: '#/components/schemas/ShareShipment' description: Successfully shared the Shipment to the provided emails default: $ref: '#/components/responses/defaultError' summary: Share a Shipment with outside parties and get a link to it tags: - shipment-actions /shipments/{shipmentId}/stops/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/ordering' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/Stop' type: array total_count: type: integer total_pages: type: integer title: PaginatedStop type: object description: Successfully returned a list of Stops default: $ref: '#/components/responses/defaultError' summary: Get a list of Stops for a given Shipment tags: - shipments parameters: - $ref: '#/components/parameters/shipmentId' - $ref: '#/components/parameters/companyImpersonation' post: description: 'The new Stop must not have the same ''ordinal_index'' as any other Stop associated with that Shipment. ' requestBody: $ref: '#/components/requestBodies/Stop' responses: '201': content: application/json: schema: $ref: '#/components/schemas/Stop' description: Successfully created a Stop default: $ref: '#/components/responses/defaultError' summary: Create a new Stop tags: - shipments /shipments/{shipmentId}/stops/{stopId}/: delete: responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Delete a Stop tags: - shipments get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/Stop' description: Successfully returned a Stop default: $ref: '#/components/responses/defaultError' summary: Obtain information about a Stop tags: - shipments parameters: - $ref: '#/components/parameters/shipmentId' - $ref: '#/components/parameters/stopId' - $ref: '#/components/parameters/companyImpersonation' put: requestBody: $ref: '#/components/requestBodies/Stop' responses: '200': content: application/json: schema: $ref: '#/components/schemas/Stop' description: Successfully updated a Stop default: $ref: '#/components/responses/defaultError' summary: Update a Stop tags: - shipments /shipments/{shipmentId}/timeline-events/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/ShipmentTimelineEvent' type: array total_count: type: integer total_pages: type: integer title: PaginatedShipmentTimelineEvent type: object description: Successfully returned a list of ShipmentTimelineEvents default: $ref: '#/components/responses/defaultError' summary: Get a list of ShipmentTimelineEvents for a given Shipment tags: - shipments parameters: - $ref: '#/components/parameters/shipmentId' post: requestBody: $ref: '#/components/requestBodies/CreateShipmentTimelineEvent' responses: '201': content: application/json: schema: $ref: '#/components/schemas/ShipmentTimelineEvent' description: Successfully created a ShipmentTimelineEvent default: $ref: '#/components/responses/defaultError' summary: Create a new ShipmentTimelineEvent tags: - shipments /shipments/{shipmentId}/timeline-events/{shipmentTimelineEventId}/: delete: responses: '204': $ref: '#/components/responses/noContent' summary: Delete a ShipmentTimelineEvent tags: - shipments get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/ShipmentTimelineEvent' description: Successfully returned a ShipmentTimelineEvent default: $ref: '#/components/responses/defaultError' summary: Obtain information about a ShipmentTimelineEvent tags: - shipments parameters: - $ref: '#/components/parameters/shipmentId' - $ref: '#/components/parameters/shipmentTimelineEventId' put: requestBody: $ref: '#/components/requestBodies/CreateShipmentTimelineEvent' responses: '200': content: application/json: schema: $ref: '#/components/schemas/ShipmentTimelineEvent' description: Successfully updated a ShipmentTimelineEvent default: $ref: '#/components/responses/defaultError' summary: Update a ShipmentTimelineEvent tags: - shipments /shipments/{shipmentId}/tracking/: get: parameters: - $ref: '#/components/parameters/beginDatetime' - $ref: '#/components/parameters/endDatetime' - $ref: '#/components/parameters/shipmentLocationFilterDistance' responses: '200': content: application/json: schema: properties: shipment_locations: items: $ref: '#/components/schemas/ELDDeviceLocation' type: array tracking_source: enum: - eld - mobile_app - unknown type: string tracking_status: enum: - tracking_not_setup - not_tracking - tracking - tracking_complete type: string title: ShipmentLocationResponse type: object description: List of locations for the given Shipment default: $ref: '#/components/responses/defaultError' summary: Get locations for the shipment tags: - shipments parameters: - $ref: '#/components/parameters/shipmentId' post: requestBody: content: application/json: schema: $ref: '#/components/schemas/ELDLocationUpdateRequest' required: true responses: '204': $ref: '#/components/responses/noContent' default: $ref: '#/components/responses/defaultError' summary: Manually update Shipment Location. Authenticated drivers can also use this route to update their location tags: - shipments /tenders/: get: parameters: - $ref: '#/components/parameters/page' - $ref: '#/components/parameters/page-size' - $ref: '#/components/parameters/tenderCreatedByCompany' - $ref: '#/components/parameters/tenderCustomerShipperReferenceNumber' - $ref: '#/components/parameters/tenderExternalSystemShipmentId' - $ref: '#/components/parameters/tenderShipmentId' - $ref: '#/components/parameters/tenderShipmentReferenceId' - $ref: '#/components/parameters/tenderTenderToCompany' responses: '200': content: application/json: schema: properties: page_size: type: integer results: items: $ref: '#/components/schemas/TenderGet' type: array total_count: type: integer total_pages: type: integer title: PaginatedTenders type: object description: Shipments successfully listed default: $ref: '#/components/responses/defaultError' summary: List Tenders Shipments tags: - tenders post: requestBody: content: application/json: schema: $ref: '#/components/schemas/TenderCreate' required: true responses: '200': content: application/json: schema: $ref: '#/components/schemas/TenderGet' description: Shipment successfully tendered default: $ref: '#/components/responses/defaultError' summary: Tender a shipment to a company tags: - tenders /tenders/{tenderId}/: get: responses: '200': content: application/json: schema: $ref: '#/components/schemas/TenderGet' description: Shipment successfully tendered default: $ref: '#/components/responses/defaultError' summary: Fetch Details about a tender tags: - tenders parameters: - $ref: '#/components/parameters/tenderId' /tenders/{tenderId}/accept/: parameters: - $ref: '#/components/parameters/tenderId' post: responses: '204': description: Tender successfully accepted default: $ref: '#/components/responses/defaultError' summary: Accept a Tender tags: - tenders /tenders/{tenderId}/reject/: parameters: - $ref: '#/components/parameters/tenderId' post: requestBody: content: application/json: schema: properties: rejection_code: enum: - A13 - EQU - CPU - LL1 - LL2 - CNA - ASE type: string rejection_reason: type: string required: - rejection_code title: TenderRejectRequest type: object responses: '204': description: Tender successfully rejected default: $ref: '#/components/responses/defaultError' summary: Rejects a Tender tags: - tenders x-codegen-request-body-name: body /tenders/{tenderId}/revoke/: parameters: - $ref: '#/components/parameters/tenderId' post: responses: '204': description: Tender successfully revoked default: $ref: '#/components/responses/defaultError' summary: Revokes a Tender tags: - tenders /vendors/vendor-poc-roles/: get: responses: '200': content: application/json: schema: items: $ref: '#/components/schemas/JobRole' type: array description: Successfully returned a list of roles default: $ref: '#/components/responses/defaultError' summary: A list of all point of contact roles/job_titles supported by the API tags: - reference-data security: - AuthToken: [] servers: - url: https://{host}{basePath} variables: basePath: default: /v2 host: default: dev-api.shipwell.com enum: - dev-api.shipwell.com - demo-api.shipwell.com - sandbox-api.shipwell.com - api.shipwell.com