Shopee SDK API Reference - v2.8.0
    Preparing search index...

    Module schemas/logistics

    Enumerations

    AddressType
    JobStatus
    ResponseOptionalFields
    ShippingDocumentType
    Status

    Interfaces

    BatchShipOrderDropoff
    BatchShipOrderNonIntegrated
    BatchShipOrderOrder
    BatchShipOrderPickup
    BatchShipOrderRequest
    BatchShipOrderResponseData
    BatchShipOrderResult
    BatchShipOrderWarning
    BatchUpdateTpfWarehouseTrackingStatusFail
    BatchUpdateTpfWarehouseTrackingStatusPackage
    BatchUpdateTpfWarehouseTrackingStatusRequest
    BatchUpdateTpfWarehouseTrackingStatusResponseData
    BatchUpdateTpfWarehouseTrackingStatusSuccess
    CheckPolygonUpdateStatusRequest
    CheckPolygonUpdateStatusResponseData
    CreateBookingShippingDocumentBooking
    CreateBookingShippingDocumentRequest
    CreateBookingShippingDocumentResponseData
    CreateBookingShippingDocumentResult
    CreateBookingShippingDocumentWarning
    CreateShippingDocumentJobFail
    CreateShippingDocumentJobRequest
    CreateShippingDocumentJobResponseData
    CreateShippingDocumentJobUnpackagedSkuRequest
    CreateShippingDocumentOrder
    CreateShippingDocumentRequest
    CreateShippingDocumentResponseData
    CreateShippingDocumentResult
    CreateShippingDocumentWarning
    DeleteAddressRequest
    DeleteSpecialOperatingHourRequest
    DownloadBookingShippingDocumentBooking
    DownloadBookingShippingDocumentRequest
    DownloadBookingShippingDocumentResponseData
    DownloadShippingDocumentJobRequest
    DownloadShippingDocumentJobResponseData
    DownloadShippingDocumentOrder
    DownloadShippingDocumentRequest
    DownloadShippingDocumentResponseData
    DownloadToLabelRequest
    DownloadToLabelResponseData
    GetAddressListAddress
    GetAddressListResponseData
    GetBookingShippingDocumentDataInfo_GetBookingShippingDocumentDataInfoRecipientAddressInfo
    GetBookingShippingDocumentDataInfoRecipientAddressInfo
    GetBookingShippingDocumentDataInfoRecipientSortCode
    GetBookingShippingDocumentDataInfoRequest
    GetBookingShippingDocumentDataInfoResponseData
    GetBookingShippingDocumentDataInfoReturnSortCode
    GetBookingShippingDocumentDataInfoSenderSortCode
    GetBookingShippingDocumentDataInfoShippingDocumentInfo
    GetBookingShippingDocumentDataInfoSpxReceiveStation
    GetBookingShippingDocumentDataInfoStyle
    GetBookingShippingDocumentParameterBooking
    GetBookingShippingDocumentParameterRequest
    GetBookingShippingDocumentParameterResponseData
    GetBookingShippingDocumentParameterResult
    GetBookingShippingDocumentParameterWarning
    GetBookingShippingDocumentResultBooking
    GetBookingShippingDocumentResultRequest
    GetBookingShippingDocumentResultResponseData
    GetBookingShippingDocumentResultResult
    GetBookingShippingDocumentResultWarning
    GetBookingShippingParameterAddress
    GetBookingShippingParameterInfoNeeded
    GetBookingShippingParameterPickup
    GetBookingShippingParameterRequest
    GetBookingShippingParameterResponseData
    GetBookingShippingParameterTimeSlot
    GetBookingTrackingInfoRequest
    GetBookingTrackingInfoResponseData
    GetBookingTrackingInfoTrackingInfo
    GetBookingTrackingNumberRequest
    GetBookingTrackingNumberResponseData
    GetChannelListAutoCallDriverSetting
    GetChannelListChannelRelationRule
    GetChannelListItemMaxDimension
    GetChannelListLogisticsCapability
    GetChannelListLogisticsChannel
    GetChannelListPreparationTimeLimit
    GetChannelListResponseData
    GetChannelListSize
    GetChannelListVolumeLimit
    GetChannelListWeightLimit
    GetMartPackagingInfoDimension
    GetMartPackagingInfoPackagingFee
    GetMartPackagingInfoResponseData
    GetMassShippingParameterAddress
    GetMassShippingParameterBranch
    GetMassShippingParameterDropoff
    GetMassShippingParameterFail
    GetMassShippingParameterInfoNeeded
    GetMassShippingParameterPackage
    GetMassShippingParameterPickup
    GetMassShippingParameterRequest
    GetMassShippingParameterResponseData
    GetMassShippingParameterSuccess
    GetMassShippingParameterTimeSlot
    GetMassTrackingNumberFail
    GetMassTrackingNumberPackage
    GetMassTrackingNumberRequest
    GetMassTrackingNumberResponseData
    GetMassTrackingNumberSuccess
    GetOperatingHourRestrictions_GetOperatingHourRestrictionsTuesday
    GetOperatingHourRestrictionsFriday
    GetOperatingHourRestrictionsInstantOperatingHourRestriction
    GetOperatingHourRestrictionsMonday
    GetOperatingHourRestrictionsPublicHoliday
    GetOperatingHourRestrictionsRegularOperatingHourRestriction
    GetOperatingHourRestrictionsResponseData
    GetOperatingHourRestrictionsSaturday
    GetOperatingHourRestrictionsShopCollectionOperatingHourRestriction
    GetOperatingHourRestrictionsSpecialDay
    GetOperatingHourRestrictionsSpecialOperatingHourRestriction
    GetOperatingHourRestrictionsSunday
    GetOperatingHourRestrictionsThursday
    GetOperatingHourRestrictionsTuesday
    GetOperatingHourRestrictionsWednesday
    GetOperatingHourRestrictionsWorkingDayConfig
    GetOperatingHoursFriday
    GetOperatingHoursInstantOperatingHour
    GetOperatingHoursMonday
    GetOperatingHoursOperatingHour
    GetOperatingHoursPublicHoliday
    GetOperatingHoursRegularOperatingHour
    GetOperatingHoursRepsonse
    GetOperatingHoursResponseData
    GetOperatingHoursSaturday
    GetOperatingHoursShopCollectionOperatingHour
    GetOperatingHoursSpecialOperatingHour
    GetOperatingHoursSunday
    GetOperatingHoursThursday
    GetOperatingHoursTuesday
    GetOperatingHoursWednesday
    GetPauseStatusResponseData
    GetShippingDocumentDataInfo_GetShippingDocumentDataInfoRecipientAddressInfo
    GetShippingDocumentDataInfoBuyerPreferDeliveryTime
    GetShippingDocumentDataInfoRecipientAddressInfo
    GetShippingDocumentDataInfoRecipientSortCode
    GetShippingDocumentDataInfoRequest
    GetShippingDocumentDataInfoResponseData
    GetShippingDocumentDataInfoReturnSortCode
    GetShippingDocumentDataInfoSenderSortCode
    GetShippingDocumentDataInfoShippingDocumentInfo
    GetShippingDocumentDataInfoSpxReceiveStation
    GetShippingDocumentDataInfoStyle
    GetShippingDocumentDataInfoThirdPartyLogisticInfo
    GetShippingDocumentJobStatusRequest
    GetShippingDocumentJobStatusResponseData
    GetShippingDocumentParameterOrder
    GetShippingDocumentParameterRequest
    GetShippingDocumentParameterResponseData
    GetShippingDocumentParameterResult
    GetShippingDocumentParameterWarning
    GetShippingDocumentResultOrder
    GetShippingDocumentResultRequest
    GetShippingDocumentResultResponseData
    GetShippingDocumentResultResult
    GetShippingDocumentResultWarning
    GetShippingParameterAddress
    GetShippingParameterBranch
    GetShippingParameterDropoff
    GetShippingParameterInfoNeeded
    GetShippingParameterPickup
    GetShippingParameterRequest
    GetShippingParameterResponseData
    GetShippingParameterSlug
    GetShippingParameterTimeSlot
    GetTrackingInfoRequest
    GetTrackingInfoResponseData
    GetTrackingInfoReversedTrackingInfo
    GetTrackingInfoTrackingInfo
    GetTrackingNumberRequest
    GetTrackingNumberResponseData
    MassShipOrderDropoff
    MassShipOrderFail
    MassShipOrderNonIntegrated
    MassShipOrderPackage
    MassShipOrderPickup
    MassShipOrderRequest
    MassShipOrderResponseData
    MassShipOrderSuccess
    MassShipOrderTrackingNumber
    SetAddressConfigAddressTypeConfig
    SetAddressConfigRequest
    SetMartPackagingInfo_SetMartPackagingInfoDimension
    SetMartPackagingInfo_SetMartPackagingInfoPackagingFee
    SetMartPackagingInfoDimension
    SetMartPackagingInfoPackagingFee
    SetMartPackagingInfoRequest
    SetMartPackagingInfoResponseData
    SetPauseStatusRequest
    SetPauseStatusResponseData
    ShipBookingPickup
    ShipBookingRequest
    ShipOrderDropoff
    ShipOrderNonIntegrated
    ShipOrderPickup
    ShipOrderRequest
    UpdateAddressRequest
    UpdateChannelAutoCallDriverSetting
    UpdateChannelRequest
    UpdateChannelResponseData
    UpdateChannelUnsupportWarehouse
    UpdateChannelUpdatedChannel
    UpdateOperatingHours_UpdateOperatingHoursInstantOperatingHour
    UpdateOperatingHours_UpdateOperatingHoursRegularOperatingHour
    UpdateOperatingHours_UpdateOperatingHoursShopCollectionOperatingHour
    UpdateOperatingHours_UpdateOperatingHoursSpecialOperatingHour
    UpdateOperatingHoursFriday
    UpdateOperatingHoursInstantOperatingHour
    UpdateOperatingHoursMonday
    UpdateOperatingHoursOperatingHour
    UpdateOperatingHoursPublicHoliday
    UpdateOperatingHoursRegularOperatingHour
    UpdateOperatingHoursRequest
    UpdateOperatingHoursResponseData
    UpdateOperatingHoursResult
    UpdateOperatingHoursSaturday
    UpdateOperatingHoursShopCollectionOperatingHour
    UpdateOperatingHoursSpecialOperatingHour
    UpdateOperatingHoursSunday
    UpdateOperatingHoursThrusday
    UpdateOperatingHoursThursday
    UpdateOperatingHoursTuesday
    UpdateOperatingHoursWednesday
    UpdateSelfCollectionOrderLogisticsRequest
    UpdateShippingOrderPickup
    UpdateShippingOrderRequest
    UpdateTrackingStatusRequest
    UpdateTrackingStatusResponseData
    UploadServiceablePolygonRequest
    UploadServiceablePolygonResponseData

    Type Aliases

    BatchShipOrderResponse
    BatchUpdateTpfWarehouseTrackingStatusResponse
    CheckPolygonUpdateStatusResponse
    CreateBookingShippingDocumentResponse
    CreateShippingDocumentJobResponse
    CreateShippingDocumentResponse
    DeleteAddressResponse
    DeleteAddressResponseData
    DeleteSpecialOperatingHourResponse
    DeleteSpecialOperatingHourResponseData
    DownloadBookingShippingDocumentResponse
    DownloadShippingDocumentJobResponse
    DownloadShippingDocumentResponse
    DownloadToLabelResponse
    GetAddressListRequest
    GetAddressListResponse
    GetBookingShippingDocumentDataInfoResponse
    GetBookingShippingDocumentParameterResponse
    GetBookingShippingDocumentResultResponse
    GetBookingShippingParameterResponse
    GetBookingTrackingInfoResponse
    GetBookingTrackingNumberResponse
    GetChannelListRequest
    GetChannelListResponse
    GetMartPackagingInfoRequest
    GetMartPackagingInfoResponse
    GetMassShippingParameterResponse
    GetMassTrackingNumberResponse
    GetOperatingHourRestrictionsRequest
    GetOperatingHourRestrictionsResponse
    GetOperatingHoursRequest
    GetOperatingHoursResponse
    GetPauseStatusRequest
    GetPauseStatusResponse
    GetShippingDocumentDataInfoResponse
    GetShippingDocumentJobStatusResponse
    GetShippingDocumentParameterResponse
    GetShippingDocumentResultResponse
    GetShippingParameterResponse
    GetTrackingInfoResponse
    GetTrackingNumberResponse
    MassShipOrderResponse
    SetAddressConfigResponse
    SetAddressConfigResponseData
    SetMartPackagingInfoResponse
    SetPauseStatusResponse
    ShipBookingResponse
    ShipBookingResponseData
    ShipOrderResponse
    ShipOrderResponseData
    UpdateAddressResponse
    UpdateAddressResponseData
    UpdateChannelResponse
    UpdateOperatingHoursResponse
    UpdateSelfCollectionOrderLogisticsResponse
    UpdateSelfCollectionOrderLogisticsResponseData
    UpdateShippingOrderResponse
    UpdateShippingOrderResponseData
    UpdateTrackingStatusResponse
    UploadServiceablePolygonResponse

    Settings

    Member Visibility

    On This Page

    Enumerations
    Interfaces
    BatchShipOrderDropoffBatchShipOrderNonIntegratedBatchShipOrderOrderBatchShipOrderPickupBatchShipOrderRequestBatchShipOrderResponseDataBatchShipOrderResultBatchShipOrderWarningBatchUpdateTpfWarehouseTrackingStatusFailBatchUpdateTpfWarehouseTrackingStatusPackageBatchUpdateTpfWarehouseTrackingStatusRequestBatchUpdateTpfWarehouseTrackingStatusResponseDataBatchUpdateTpfWarehouseTrackingStatusSuccessCheckPolygonUpdateStatusRequestCheckPolygonUpdateStatusResponseDataCreateBookingShippingDocumentBookingCreateBookingShippingDocumentRequestCreateBookingShippingDocumentResponseDataCreateBookingShippingDocumentResultCreateBookingShippingDocumentWarningCreateShippingDocumentJobFailCreateShippingDocumentJobRequestCreateShippingDocumentJobResponseDataCreateShippingDocumentJobUnpackagedSkuRequestCreateShippingDocumentOrderCreateShippingDocumentRequestCreateShippingDocumentResponseDataCreateShippingDocumentResultCreateShippingDocumentWarningDeleteAddressRequestDeleteSpecialOperatingHourRequestDownloadBookingShippingDocumentBookingDownloadBookingShippingDocumentRequestDownloadBookingShippingDocumentResponseDataDownloadShippingDocumentJobRequestDownloadShippingDocumentJobResponseDataDownloadShippingDocumentOrderDownloadShippingDocumentRequestDownloadShippingDocumentResponseDataDownloadToLabelRequestDownloadToLabelResponseDataGetAddressListAddressGetAddressListResponseDataGetBookingShippingDocumentDataInfo_GetBookingShippingDocumentDataInfoRecipientAddressInfoGetBookingShippingDocumentDataInfoRecipientAddressInfoGetBookingShippingDocumentDataInfoRecipientSortCodeGetBookingShippingDocumentDataInfoRequestGetBookingShippingDocumentDataInfoResponseDataGetBookingShippingDocumentDataInfoReturnSortCodeGetBookingShippingDocumentDataInfoSenderSortCodeGetBookingShippingDocumentDataInfoShippingDocumentInfoGetBookingShippingDocumentDataInfoSpxReceiveStationGetBookingShippingDocumentDataInfoStyleGetBookingShippingDocumentParameterBookingGetBookingShippingDocumentParameterRequestGetBookingShippingDocumentParameterResponseDataGetBookingShippingDocumentParameterResultGetBookingShippingDocumentParameterWarningGetBookingShippingDocumentResultBookingGetBookingShippingDocumentResultRequestGetBookingShippingDocumentResultResponseDataGetBookingShippingDocumentResultResultGetBookingShippingDocumentResultWarningGetBookingShippingParameterAddressGetBookingShippingParameterInfoNeededGetBookingShippingParameterPickupGetBookingShippingParameterRequestGetBookingShippingParameterResponseDataGetBookingShippingParameterTimeSlotGetBookingTrackingInfoRequestGetBookingTrackingInfoResponseDataGetBookingTrackingInfoTrackingInfoGetBookingTrackingNumberRequestGetBookingTrackingNumberResponseDataGetChannelListAutoCallDriverSettingGetChannelListChannelRelationRuleGetChannelListItemMaxDimensionGetChannelListLogisticsCapabilityGetChannelListLogisticsChannelGetChannelListPreparationTimeLimitGetChannelListResponseDataGetChannelListSizeGetChannelListVolumeLimitGetChannelListWeightLimitGetMartPackagingInfoDimensionGetMartPackagingInfoPackagingFeeGetMartPackagingInfoResponseDataGetMassShippingParameterAddressGetMassShippingParameterBranchGetMassShippingParameterDropoffGetMassShippingParameterFailGetMassShippingParameterInfoNeededGetMassShippingParameterPackageGetMassShippingParameterPickupGetMassShippingParameterRequestGetMassShippingParameterResponseDataGetMassShippingParameterSuccessGetMassShippingParameterTimeSlotGetMassTrackingNumberFailGetMassTrackingNumberPackageGetMassTrackingNumberRequestGetMassTrackingNumberResponseDataGetMassTrackingNumberSuccessGetOperatingHourRestrictions_GetOperatingHourRestrictionsTuesdayGetOperatingHourRestrictionsFridayGetOperatingHourRestrictionsInstantOperatingHourRestrictionGetOperatingHourRestrictionsMondayGetOperatingHourRestrictionsPublicHolidayGetOperatingHourRestrictionsRegularOperatingHourRestrictionGetOperatingHourRestrictionsResponseDataGetOperatingHourRestrictionsSaturdayGetOperatingHourRestrictionsShopCollectionOperatingHourRestrictionGetOperatingHourRestrictionsSpecialDayGetOperatingHourRestrictionsSpecialOperatingHourRestrictionGetOperatingHourRestrictionsSundayGetOperatingHourRestrictionsThursdayGetOperatingHourRestrictionsTuesdayGetOperatingHourRestrictionsWednesdayGetOperatingHourRestrictionsWorkingDayConfigGetOperatingHoursFridayGetOperatingHoursInstantOperatingHourGetOperatingHoursMondayGetOperatingHoursOperatingHourGetOperatingHoursPublicHolidayGetOperatingHoursRegularOperatingHourGetOperatingHoursRepsonseGetOperatingHoursResponseDataGetOperatingHoursSaturdayGetOperatingHoursShopCollectionOperatingHourGetOperatingHoursSpecialOperatingHourGetOperatingHoursSundayGetOperatingHoursThursdayGetOperatingHoursTuesdayGetOperatingHoursWednesdayGetPauseStatusResponseDataGetShippingDocumentDataInfo_GetShippingDocumentDataInfoRecipientAddressInfoGetShippingDocumentDataInfoBuyerPreferDeliveryTimeGetShippingDocumentDataInfoRecipientAddressInfoGetShippingDocumentDataInfoRecipientSortCodeGetShippingDocumentDataInfoRequestGetShippingDocumentDataInfoResponseDataGetShippingDocumentDataInfoReturnSortCodeGetShippingDocumentDataInfoSenderSortCodeGetShippingDocumentDataInfoShippingDocumentInfoGetShippingDocumentDataInfoSpxReceiveStationGetShippingDocumentDataInfoStyleGetShippingDocumentDataInfoThirdPartyLogisticInfoGetShippingDocumentJobStatusRequestGetShippingDocumentJobStatusResponseDataGetShippingDocumentParameterOrderGetShippingDocumentParameterRequestGetShippingDocumentParameterResponseDataGetShippingDocumentParameterResultGetShippingDocumentParameterWarningGetShippingDocumentResultOrderGetShippingDocumentResultRequestGetShippingDocumentResultResponseDataGetShippingDocumentResultResultGetShippingDocumentResultWarningGetShippingParameterAddressGetShippingParameterBranchGetShippingParameterDropoffGetShippingParameterInfoNeededGetShippingParameterPickupGetShippingParameterRequestGetShippingParameterResponseDataGetShippingParameterSlugGetShippingParameterTimeSlotGetTrackingInfoRequestGetTrackingInfoResponseDataGetTrackingInfoReversedTrackingInfoGetTrackingInfoTrackingInfoGetTrackingNumberRequestGetTrackingNumberResponseDataMassShipOrderDropoffMassShipOrderFailMassShipOrderNonIntegratedMassShipOrderPackageMassShipOrderPickupMassShipOrderRequestMassShipOrderResponseDataMassShipOrderSuccessMassShipOrderTrackingNumberSetAddressConfigAddressTypeConfigSetAddressConfigRequestSetMartPackagingInfo_SetMartPackagingInfoDimensionSetMartPackagingInfo_SetMartPackagingInfoPackagingFeeSetMartPackagingInfoDimensionSetMartPackagingInfoPackagingFeeSetMartPackagingInfoRequestSetMartPackagingInfoResponseDataSetPauseStatusRequestSetPauseStatusResponseDataShipBookingPickupShipBookingRequestShipOrderDropoffShipOrderNonIntegratedShipOrderPickupShipOrderRequestUpdateAddressRequestUpdateChannelAutoCallDriverSettingUpdateChannelRequestUpdateChannelResponseDataUpdateChannelUnsupportWarehouseUpdateChannelUpdatedChannelUpdateOperatingHours_UpdateOperatingHoursInstantOperatingHourUpdateOperatingHours_UpdateOperatingHoursRegularOperatingHourUpdateOperatingHours_UpdateOperatingHoursShopCollectionOperatingHourUpdateOperatingHours_UpdateOperatingHoursSpecialOperatingHourUpdateOperatingHoursFridayUpdateOperatingHoursInstantOperatingHourUpdateOperatingHoursMondayUpdateOperatingHoursOperatingHourUpdateOperatingHoursPublicHolidayUpdateOperatingHoursRegularOperatingHourUpdateOperatingHoursRequestUpdateOperatingHoursResponseDataUpdateOperatingHoursResultUpdateOperatingHoursSaturdayUpdateOperatingHoursShopCollectionOperatingHourUpdateOperatingHoursSpecialOperatingHourUpdateOperatingHoursSundayUpdateOperatingHoursThrusdayUpdateOperatingHoursThursdayUpdateOperatingHoursTuesdayUpdateOperatingHoursWednesdayUpdateSelfCollectionOrderLogisticsRequestUpdateShippingOrderPickupUpdateShippingOrderRequestUpdateTrackingStatusRequestUpdateTrackingStatusResponseDataUploadServiceablePolygonRequestUploadServiceablePolygonResponseData
    Type Aliases
    BatchShipOrderResponseBatchUpdateTpfWarehouseTrackingStatusResponseCheckPolygonUpdateStatusResponseCreateBookingShippingDocumentResponseCreateShippingDocumentJobResponseCreateShippingDocumentResponseDeleteAddressResponseDeleteAddressResponseDataDeleteSpecialOperatingHourResponseDeleteSpecialOperatingHourResponseDataDownloadBookingShippingDocumentResponseDownloadShippingDocumentJobResponseDownloadShippingDocumentResponseDownloadToLabelResponseGetAddressListRequestGetAddressListResponseGetBookingShippingDocumentDataInfoResponseGetBookingShippingDocumentParameterResponseGetBookingShippingDocumentResultResponseGetBookingShippingParameterResponseGetBookingTrackingInfoResponseGetBookingTrackingNumberResponseGetChannelListRequestGetChannelListResponseGetMartPackagingInfoRequestGetMartPackagingInfoResponseGetMassShippingParameterResponseGetMassTrackingNumberResponseGetOperatingHourRestrictionsRequestGetOperatingHourRestrictionsResponseGetOperatingHoursRequestGetOperatingHoursResponseGetPauseStatusRequestGetPauseStatusResponseGetShippingDocumentDataInfoResponseGetShippingDocumentJobStatusResponseGetShippingDocumentParameterResponseGetShippingDocumentResultResponseGetShippingParameterResponseGetTrackingInfoResponseGetTrackingNumberResponseMassShipOrderResponseSetAddressConfigResponseSetAddressConfigResponseDataSetMartPackagingInfoResponseSetPauseStatusResponseShipBookingResponseShipBookingResponseDataShipOrderResponseShipOrderResponseDataUpdateAddressResponseUpdateAddressResponseDataUpdateChannelResponseUpdateOperatingHoursResponseUpdateSelfCollectionOrderLogisticsResponseUpdateSelfCollectionOrderLogisticsResponseDataUpdateShippingOrderResponseUpdateShippingOrderResponseDataUpdateTrackingStatusResponseUploadServiceablePolygonResponse