data class BarcodeItemRO(val text: String = "", val type: String = "", val scan_id: String = "", val max_confidence: Float = 0.0f, val recognition_count: Int? = null, val symbol: String? = null, val created_at: String? = null, val position: FloatArray = emptyArray())

CreatePickTicketRequest

@Serializable

data class CreatePickTicketRequest(val referenceId: String, val originLocationId: String, val destination: DestinationDetails, val handlingUnits: List<HandlingUnit>, val userId: String)

Request to create or update a pick ticket

CreateShipmentBaseRequest

@Serializable

data class CreateShipmentBaseRequest(val title: String, val createdById: String, val updatedById: String) : CreateShipmentRequest

CreateShipmentRequest

@Serializable

sealed class CreateShipmentRequest

CreateShipmentScanRequest

@Serializable

data class CreateShipmentScanRequest(val organizationId: String, val shipmentId: String, val title: String, val width: Float?, val height: Float?, val depth: Float?, val weight: Float?, val freightClass: String?, val latitude: Float?, val longitude: Float?, val notes: String?, val status: String?, val scanType: String?, val createdAt: String?, val createdById: String, val updatedById: String)

CreateShipmentWithMetadataRequest

@Serializable

data class CreateShipmentWithMetadataRequest(val title: String, val createdById: String, val updatedById: String, val metadata: JsonObject) : CreateShipmentRequest

DestinationDetails

@Serializable

data class DestinationDetails(val city: String = "", val country: String = "", val companyName: String = "", val contactEmail: String = "", val contactFirstName: String = "", val contactLastName: String = "", val contactPhone: String = "", val state: String = "", val streetLine1: String = "", val streetLine2: String = "", val zipCode: String = "", val locationType: String = "")

Represents destination details for a Pick Ticket

DestinationStop

@Serializable

data class DestinationStop(val zip: String? = null, val city: String? = null, val state: String? = null, val country: String? = null, val companyName: String? = null, val streetLine1: String? = null, val streetLine2: String? = null, val contactEmail: String? = null, val contactPhone: String? = null, val locationType: String? = null, val contactLastName: String? = null, val contactFirstName: String? = null)

Destination stop from pick ticket processing

DocumentInput

@Serializable

data class DocumentInput(val shipmentId: String, val scanId: String? = null, val jobId: String? = null, val title: String? = null, val documentType: String, val imagesPaths: List<String> = emptyList(), val data: JsonObject = JsonObject(emptyMap()))

Input model for creating a document via the documents API

DocumentResponse

@Serializable

data class DocumentResponse(val id: String, val shipmentId: String, val documentType: String, val title: String? = null, val scanId: String? = null, val jobId: String? = null, val imagesPaths: List<String> = emptyList(), val data: JsonObject? = null, val createdAt: String? = null, val updatedAt: String? = null, val createdById: String? = null)

Response model from the documents API

HandlingUnit

@Serializable

data class HandlingUnit(val id: String = "", val weight: Float? = null, val type: String? = null, val height: Float? = null, val length: Float? = null, val width: Float? = null, val freightClass: String? = null, val description: String? = null, val quantity: Int? = 1, val imageUrl: String? = null)

Represents a handling unit (pallet/package) with dimensions

JobStatusResponse

@Serializable

data class JobStatusResponse(val jobType: String, val organizationId: String? = null, val createdById: String? = null, val inputParams: Map<String, JsonElement> = emptyMap(), val metadata: Map<String, JsonElement>? = null, val id: String, val status: String, val progressPercent: Int = 0, val progressCurrent: Int = 0, val progressTotal: Int = 0, val progressMessage: String? = null, val createdAt: String? = null, val startedAt: String? = null, val completedAt: String? = null, val updatedAt: String? = null, val resultData: PickTicketResultData? = null, val errorDetails: Map<String, JsonElement>? = null)

Job status response from /api/jobs/{job_id}

MinimumApiVersionsRO

@Serializable

data class MinimumApiVersionsRO(val android: MinimumApiVersionsRO.PlatformConfig)

MyCarrierDestinationStop

@Serializable

data class MyCarrierDestinationStop(val city: String? = null, val companyName: String? = null, val contactEmail: String? = null, val contactFirstName: String? = null, val contactLastName: String? = null, val contactPhone: String? = null, val country: String? = null, val locationType: String? = null, val state: String? = null, val streetLine1: String? = null, val streetLine2: String? = null, val zip: String? = null)

Destination stop for MyCarrier order

MyCarrierOrder

@Serializable

data class MyCarrierOrder(val quoteReferenceID: String, val originStop: MyCarrierOriginStop, val destinationStop: MyCarrierDestinationStop, val quoteUnits: List<MyCarrierQuoteUnit>)

Individual order in MyCarrier submission

MyCarrierOrderRequest

@Serializable

data class MyCarrierOrderRequest(val orders: List<MyCarrierOrder>)

Request body for submitting orders to MyCarrier service

MyCarrierOrderResponse

@Serializable

data class MyCarrierOrderResponse(val referenceIds: List<String> = emptyList())

Response from MyCarrier order submission

MyCarrierOriginStop

@Serializable

data class MyCarrierOriginStop(val locationID: String)

Origin stop for MyCarrier order

MyCarrierQuoteCommodity

@Serializable

data class MyCarrierQuoteCommodity(val commodityClass: String? = null, val commodityDescription: String? = null, val commodityWeight: Float? = null)

Quote commodity for MyCarrier order

MyCarrierQuoteUnit

@Serializable

data class MyCarrierQuoteUnit(val quoteCommodities: List<MyCarrierQuoteCommodity>, val unitHeight: Int, val unitLength: Int, val unitWidth: Int, val shippingUnitCount: Int = 1, val shippingUnitType: String = "pallet", val unitStackable: Boolean = false)

Quote unit for MyCarrier order

MyCarrierStatusResponse

@Serializable

data class MyCarrierStatusResponse(val isActive: Boolean, val message: String)

Response from MyCarrier status check

OrganizationRO

@Serializable

data class OrganizationRO(val id: String, val name: String, val tier: String, val verified: Boolean, val archived: Boolean, val metadata: JsonObject? = null)

PickTicketData

@Serializable

data class PickTicketData(val referenceId: String = "", val originLocationId: String = "", val proNumber: String? = null, val bolNumber: String? = null, val carrierName: String? = null, val totalWeight: Float? = null, val destination: DestinationDetails = DestinationDetails(), val handlingUnits: List<HandlingUnit> = emptyList(), val createdAt: String? = null, val updatedAt: String? = null)

Represents a Pick Ticket with all associated data

PickTicketExtractionResponse

@Serializable

data class PickTicketExtractionResponse(val jobId: String, val status: String, val data: PickTicketData? = null, val error: String? = null)

Response from pick ticket extraction/processing

PickTicketResultData

@Serializable

data class PickTicketResultData(val destinationStop: DestinationStop? = null, val quoteReferenceID: String? = null, val proNumber: String? = null, val bolNumber: String? = null, val carrierName: String? = null, val totalWeight: Float? = null)

Result data structure from pick ticket processing job

PickTicketUploadResponse

@Serializable

data class PickTicketUploadResponse(val jobId: String, val message: String)

Response from pick ticket upload

QuoteCommodity

@Serializable

data class QuoteCommodity(val commodityClass: String? = null, val commodityWeight: Float? = null, val commodityDescription: String? = null)

Quote commodity from pick ticket processing

QuoteUnit

@Serializable

data class QuoteUnit(val unitWidth: String? = null, val unitHeight: String? = null, val unitLength: String? = null, val unitStackable: String? = null, val quoteCommodities: List<QuoteCommodity> = emptyList(), val shippingUnitType: String? = null, val shippingUnitCount: String? = null)

Quote unit from pick ticket processing

SetMyCarrierApiKeyRequest

@Serializable

data class SetMyCarrierApiKeyRequest(val mycarrierKey: String, val originLocationId: String?)

SharingTab

enum SharingTab : Enum<SharingTab>

ShipmentEntryRO

@Serializable

data class ShipmentEntryRO(val id: String = "", val shipment_id: String = "", val shipment_scan_id: String = "", val organization_id: String = "", val storage_path: String = "", val type: String = "", val file_name: String = "", val file_size: Long? = null, val created_at: String = "", val created_by_id: String = "")

ShipmentEntryTypeRO

@Serializable

enum ShipmentEntryTypeRO : Enum<ShipmentEntryTypeRO>

ShipmentRO

@Serializable

data class ShipmentRO(val id: String = "", val title: String = "", val created_by_id: String = "", val created_at: String = "", val updated_at: String? = null, val archived: String? = null, val barcodes: Map<String, List<BarcodeItemRO>>? = null, val organization_id: String? = null, val status: String? = null, val description: String? = null, val metadata: JsonObject? = null)

ShipmentScanRO

@Serializable

data class ShipmentScanRO(val id: String = "", val shipment_id: String = "", val organization_id: String = "", val title: String = "", val width: Float? = null, val height: Float? = null, val depth: Float? = null, val user_width: Float? = null, val user_height: Float? = null, val user_depth: Float? = null, val user_center: Vector3? = null, val manual_width: Float? = null, val manual_height: Float? = null, val manual_depth: Float? = null, val weight: Float? = null, val freight_class: String? = null, val latitude: Float? = null, val longitude: Float? = null, val notes: String? = null, val status: String? = null, val created_at: String = "", val created_by_id: String = "", val updated_at: String? = null, val updated_by_id: String? = null, val metadata: JsonObject? = null, val scan_type: ShipmentScanTypeRO? = null, val recent_entry_presigned_url: String? = null)

ShipmentScanTypeRO

@Serializable

enum ShipmentScanTypeRO : Enum<ShipmentScanTypeRO>

ShipmentScanVersionMetadata

@Serializable

data class ShipmentScanVersionMetadata(val device_type: String, val device_model: String, val device_brand: String, val app_version: String, val scanner_version: String, val depth_strategy: String)

ShipmentSharingRO

@Serializable

data class ShipmentSharingRO(val id: String = "", val shipment_id: String = "", val shared_by_user_id: String = "", val recipient_email: String = "", val expiration: String = "", val created_at: String = "", val accessed: Boolean = false)

ShipmentWithSharingRO

@Serializable

data class ShipmentWithSharingRO(val shipments: List<ShipmentRO>? = null, val shared_with_user_shipments: List<ShipmentRO>? = null)

SnapshotsRO

@Serializable

data class SnapshotsRO(val length: Float, val height: Float, val width: Float, val ply_file: String?)

StorageRO

@Serializable

data class StorageRO(val key: String, val url: String)

UpdateShipmentBarcodesRequest

@Serializable

data class UpdateShipmentBarcodesRequest(val updatedById: String, val barcodesDto: Map<String, List<BarcodeItemRO>>) : UpdateShipmentRequest

UpdateShipmentMetadataRequest

@Serializable

data class UpdateShipmentMetadataRequest(val updatedById: String, val metadata: JsonObject) : UpdateShipmentRequest

UpdateShipmentRequest

@Serializable

sealed class UpdateShipmentRequest

UpdateShipmentScanBaseRequest

@Serializable

sealed class UpdateShipmentScanBaseRequest

UpdateShipmentScanManualDimensionsRequest

data class UpdateShipmentScanManualDimensionsRequest(val updatedById: String, val manualWidth: Float, val manualHeight: Float, val manualDepth: Float) : UpdateShipmentScanBaseRequest

UpdateShipmentScanRequest

@Serializable

data class UpdateShipmentScanRequest(val organizationId: String? = null, val shipmentId: String? = null, val title: String? = null, val weight: Float? = null, val freightClass: String? = null, val latitude: Float? = null, val longitude: Float? = null, val notes: String? = null, val status: String? = null, val updatedById: String, val metadata: JsonObject? = null) : UpdateShipmentScanBaseRequest

UpdateShipmentScanType

data class UpdateShipmentScanType(val updatedById: String, val scanType: String) : UpdateShipmentScanBaseRequest

UpdateShipmentScanUserDimensionsRequest

@Serializable

data class UpdateShipmentScanUserDimensionsRequest(val updatedById: String, val user_width: Float, val user_height: Float, val user_depth: Float, val user_center: Vector3) : UpdateShipmentScanBaseRequest

UpdateShipmentScanWeightRequest

data class UpdateShipmentScanWeightRequest(val updatedById: String, val weight: Float?) : UpdateShipmentScanBaseRequest

UpdateShipmentTitleRequest

@Serializable

data class UpdateShipmentTitleRequest(val updatedById: String, val title: String) : UpdateShipmentRequest

UserProfileRO

@Serializable

data class UserProfileRO(val id: String, val first_name: String, val last_name: String, val organization_id: String, val invitation_status: String?, val email: String)