Documentation ¶
Index ¶
- Constants
- type Logistics
- func (l *Logistics) BatchShipOrder(orderList *entity.BatchShipOrderRequestOrderListEntity, ...) entity.BatchShipOrderResult
- func (l *Logistics) CreateShippingDocument(orderList *entity.CreateShippingDocumentRequestOrderListEntity) entity.CreateShippingDocumentResult
- func (l *Logistics) DeleteAddress(addressID int64) entity.DeleteAddressResult
- func (l *Logistics) DownloadShippingDocument(orderList *entity.DownloadShippingDocumentRequestOrderListEntity) entity.DownloadShippingDocumentResult
- func (l *Logistics) GetAddressList() entity.GetAddressListResult
- func (l *Logistics) GetChannelList() entity.GetChannelListResult
- func (l *Logistics) GetShippingDocumentInfo(orderSn, packageNumber string) entity.GetShippingDocumentInfoResult
- func (l *Logistics) GetShippingDocumentParameter(orderList *entity.ShippingDocumentParameterRequestOrderListEntity) entity.GetShippingDocumentParameterResult
- func (l *Logistics) GetShippingDocumentResult(orderList *entity.GetShippingDocumentResultRequestOrderListEntity) entity.GetShippingDocumentResult
- func (l *Logistics) GetShippingParameter(orderSn string) entity.GetShippingParameterResult
- func (l *Logistics) GetTrackingInfo(orderSn, packageNumber string) entity.GetTrackingInfoResult
- func (l *Logistics) GetTrackingNumber(orderSn, packageNumber string, responseOptionalFields ...string) entity.GetTrackingNumberResult
- func (l *Logistics) SetAddressConfig(showPickupAddress bool, AddressTypeConfig entity.AddressTypeConfigEntity) entity.SetAddressConfigResult
- func (l *Logistics) ShipOrder(orderSn, packageNumber string, pickup *entity.ShipOrderRequestPickupEntity, ...) entity.ShipOrderResult
- func (l *Logistics) UpdateChannel(logisticsChannelID int64, enabled, preferred, codEnabled bool) entity.UpdateChannelResult
- func (l *Logistics) UpdateShippingOrder(orderSn, packageNumber string, ...) entity.UpdateShippingOrderResult
- type ShippingDocumentStatus
- type ShippingDocumentType
Constants ¶
const ( NORMAL_AIR_WAYBILL ShippingDocumentType = "NORMAL_AIR_WAYBILL" THERMAL_AIR_WAYBILL ShippingDocumentType = "THERMAL_AIR_WAYBILL" NORMAL_JOB_AIR_WAYBILL ShippingDocumentType = "NORMAL_JOB_AIR_WAYBILL" THERMAL_JOB_AIR_WAYBILL ShippingDocumentType = "THERMAL_JOB_AIR_WAYBILL" READY ShippingDocumentStatus = "READY" FAILED ShippingDocumentStatus = "FAILED" PROCESSING ShippingDocumentStatus = "PROCESSING" )
常量
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Logistics ¶
type Logistics struct {
Config *shopeeConfig.Config
}
Logistics
func (*Logistics) BatchShipOrder ¶
func (l *Logistics) BatchShipOrder(orderList *entity.BatchShipOrderRequestOrderListEntity, pickup *entity.BatchShipOrderRequestPickupEntity, dropoff *entity.BatchShipOrderRequestDropoffEntity, nonIntegrated *entity.BatchShipOrderRequestNonIntegratedEntity) entity.BatchShipOrderResult
BatchShipOrder @Title Use this api to batch initiate logistics including arrange pickup, dropoff or shipment for non-integrated logistic channels. Should call v2.logistics.get_shipping_parameter to fetch all required param first. It's recommended to initiate logistics one hour after the orders were placed since there is one-hour window buyer can cancel any order without request to seller. @Description https://open.shopee.com/documents?module=95&type=1&id=688&version=2
func (*Logistics) CreateShippingDocument ¶
func (l *Logistics) CreateShippingDocument(orderList *entity.CreateShippingDocumentRequestOrderListEntity) entity.CreateShippingDocumentResult
CreateShippingDocument @Title Use this api to create shipping document task for each order or package @Description https://open.shopee.com/documents?module=95&type=1&id=547&version=2
func (*Logistics) DeleteAddress ¶
func (l *Logistics) DeleteAddress(addressID int64) entity.DeleteAddressResult
DeleteAddress @Title Use this api to delete address. @Description https://open.shopee.com/documents?module=95&type=1&id=598&version=2
func (*Logistics) DownloadShippingDocument ¶
func (l *Logistics) DownloadShippingDocument(orderList *entity.DownloadShippingDocumentRequestOrderListEntity) entity.DownloadShippingDocumentResult
DownloadShippingDocument @Title Use this api to download shipping_document. You have to call v2.logistics.create_shipping_document to create a new shipping document task first and call v2.logistics.get_shipping_document_resut to get the task status second. If the task is READY, you can download this shipping document. @Description https://open.shopee.com/documents?module=95&type=1&id=548&version=2
func (*Logistics) GetAddressList ¶
func (l *Logistics) GetAddressList() entity.GetAddressListResult
GetAddressList @Title For integrated logistics channel, use this call to get pickup address for pickup mode order. @Description https://open.shopee.com/documents?module=95&type=1&id=558&version=2
func (*Logistics) GetChannelList ¶
func (l *Logistics) GetChannelList() entity.GetChannelListResult
GetChannelList @Title Use this api to get all supported logistic channels. @Description https://open.shopee.com/documents?module=95&type=1&id=559&version=2
func (*Logistics) GetShippingDocumentInfo ¶
func (l *Logistics) GetShippingDocumentInfo(orderSn, packageNumber string) entity.GetShippingDocumentInfoResult
GetShippingDocumentInfo @Title Use this api to fetch the logistics information of an order, these info can be used for airwaybill printing. Dedicated for crossborder SLS order airwaybill. May not be applicable for local channel airwaybill. @Description https://open.shopee.com/documents?module=95&type=1&id=560&version=2
func (*Logistics) GetShippingDocumentParameter ¶
func (l *Logistics) GetShippingDocumentParameter(orderList *entity.ShippingDocumentParameterRequestOrderListEntity) entity.GetShippingDocumentParameterResult
GetShippingDocumentParameter @Title Use this api to get the selectable shipping_document_type and suggested shipping_document_type. @Description https://open.shopee.com/documents?module=95&type=1&id=549&version=2
func (*Logistics) GetShippingDocumentResult ¶
func (l *Logistics) GetShippingDocumentResult(orderList *entity.GetShippingDocumentResultRequestOrderListEntity) entity.GetShippingDocumentResult
GetShippingDocumentResult @Title Use this api to get the shipping_document of each order or package status. @Description https://open.shopee.com/documents?module=95&type=1&id=561&version=2
func (*Logistics) GetShippingParameter ¶
func (l *Logistics) GetShippingParameter(orderSn string) entity.GetShippingParameterResult
GetShippingParameter @Title Use this api to get shipping parameter. @Description https://open.shopee.com/documents?module=95&type=1&id=550&version=2
func (*Logistics) GetTrackingInfo ¶
func (l *Logistics) GetTrackingInfo(orderSn, packageNumber string) entity.GetTrackingInfoResult
GetTrackingInfo @Title Use this api to get the logistics tracking information of an order. @Description https://open.shopee.com/documents?module=95&type=1&id=551&version=2
func (*Logistics) GetTrackingNumber ¶
func (l *Logistics) GetTrackingNumber(orderSn, packageNumber string, responseOptionalFields ...string) entity.GetTrackingNumberResult
GetTrackingNumber @Title Use this api to get tracking_number when you hava shipped order. @Description https://open.shopee.com/documents?module=95&type=1&id=552&version=2
func (*Logistics) SetAddressConfig ¶
func (l *Logistics) SetAddressConfig(showPickupAddress bool, AddressTypeConfig entity.AddressTypeConfigEntity) entity.SetAddressConfigResult
SetAddressConfig @Title Use this API to set address config of your shop. @Description https://open.shopee.com/documents?module=95&type=1&id=556&version=2
func (*Logistics) ShipOrder ¶
func (l *Logistics) ShipOrder(orderSn, packageNumber string, pickup *entity.ShipOrderRequestPickupEntity, dropoff *entity.ShipOrderRequestDropoffEntity, nonIntegrated *entity.ShipOrderRequestNonIntegratedEntity) entity.ShipOrderResult
ShipOrder @Title Use this api to initiate logistics including arrange pickup, dropoff or shipment for non-integrated logistic channels. Should call v2.logistics.get_shipping_parameter to fetch all required param first. It's recommended to initiate logistics one hour after the orders were placed since there is one-hour window buyer can cancel any order without request to seller. @Description https://open.shopee.com/documents?module=95&type=1&id=553&version=2
func (*Logistics) UpdateChannel ¶
func (l *Logistics) UpdateChannel(logisticsChannelID int64, enabled, preferred, codEnabled bool) entity.UpdateChannelResult
UpdateChannel @Title Use this api to update shop level logistics channel's configuration. @Description https://open.shopee.com/documents?module=95&type=1&id=554&version=2
func (*Logistics) UpdateShippingOrder ¶
func (l *Logistics) UpdateShippingOrder(orderSn, packageNumber string, pickup *entity.UpdateShippingOrderRequestPickupEntity) entity.UpdateShippingOrderResult
UpdateShippingOrder @Title Use this api to update pickup address and pickup time for shipping order. @Description https://open.shopee.com/documents?module=95&type=1&id=555&version=2