order

Documentation

Index

• Constants
• type CancelReason
• type Operation
• type Order
  • func (o *Order) AddInvoiceData(orderSn string, invoiceData entity.InvoiceDataEntity) entity.AddInvoiceDataResult
  • func (o *Order) CancelOrder(orderSn string, cancelReason CancelReason, ...) entity.CancelOrderResult
  • func (o *Order) GetOrderDetail(orderSnList []string, responseOptionalFields ...string) entity.GetOrderDetailResult
  • func (o *Order) GetOrderList(timeRangeField TimeRangeField, timeFrom, timeTo, pageSize int, cursor string, ...) entity.GetOrderListResult
  • func (o *Order) GetShipmentList(cursor string, pageSize int) entity.GetShipmentListResult
  • func (o *Order) HandleBuyerCancellation(orderSn string, operation Operation) entity.HandleBuyerCancellationResult
  • func (o *Order) SetNote(orderSn, note string) entity.SetNoteResult
  • func (o *Order) SplitOrder(orderSn string, packageList []entity.PackageListRequestEntity) entity.SplitOrderResult
  • func (o *Order) UnSplitOrder(orderSn string) entity.UnSplitOrderResult
• type OrderStatus
• type TimeRangeField

Constants

const (
	CREATE_TIME        TimeRangeField = "create_time"
	UPDATE_TIME        TimeRangeField = "update_time"
	UNPAID             OrderStatus    = "UNPAID"
	READY_TO_SHIP      OrderStatus    = "READY_TO_SHIP"
	PROCESSED          OrderStatus    = "PROCESSED"
	RETRY_SHIP         OrderStatus    = "RETRY_SHIP"
	SHIPPED            OrderStatus    = "SHIPPED"
	TO_CONFIRM_RECEIVE OrderStatus    = "TO_CONFIRM_RECEIVE"
	COMPLETED          OrderStatus    = "COMPLETED"
	IN_CANCEL          OrderStatus    = "IN_CANCEL"
	CANCELLED          OrderStatus    = "CANCELLED"
	TO_RETURN          OrderStatus    = "TO_RETURN"
	OUT_OF_STOCK       CancelReason   = "OUT_OF_STOCK"
	CUSTOMER_REQUEST   CancelReason   = "CUSTOMER_REQUEST"
	UNDELIVERABLE_AREA CancelReason   = "UNDELIVERABLE_AREA"
	COD_NOT_SUPPORTED  CancelReason   = "COD_NOT_SUPPORTED"
	ACCEPT             Operation      = "ACCEPT"
	REJECT             Operation      = "REJECT"
)

Types

type CancelReason

type CancelReason string

CancelReason

type Operation

type Operation string

Operation

type Order

type Order struct {
	Config *shopeeConfig.Config
}

Order

func (*Order) AddInvoiceData

func (o *Order) AddInvoiceData(orderSn string, invoiceData entity.InvoiceDataEntity) entity.AddInvoiceDataResult

AddInvoiceData @Title Use the API to add invoice data of the order when the order status is PENDING_INVOICE under some special logistics channels, such as Total Express, only for the BR local seller. @Description https://open.shopee.com/documents?module=94&type=1&id=685&version=2

func (*Order) CancelOrder

func (o *Order) CancelOrder(orderSn string, cancelReason CancelReason, itemList []entity.CancelOrderRequestEntity) entity.CancelOrderResult

CancelOrder @Title Use this api to cancel an order. @Description https://open.shopee.com/documents?module=94&type=1&id=541&version=2

func (*Order) GetOrderDetail

func (o *Order) GetOrderDetail(orderSnList []string, responseOptionalFields ...string) entity.GetOrderDetailResult

GetOrderDetail @Title Use this api to get order detail. @Description https://open.shopee.com/documents?module=94&type=1&id=557&version=2

func (*Order) GetOrderList

func (o *Order) GetOrderList(
	timeRangeField TimeRangeField,
	timeFrom, timeTo, pageSize int,
	cursor string,
	orderStatus OrderStatus,
	responseOptionalFields string) entity.GetOrderListResult

GetOrderList @Title Use this api to search orders. @Description https://open.shopee.com/documents?module=94&type=1&id=542&version=2

func (*Order) GetShipmentList

func (o *Order) GetShipmentList(cursor string, pageSize int) entity.GetShipmentListResult

GetShipmentList @Title Use this api to get order list which order_status is READY_TO_SHIP. @Description https://open.shopee.com/documents?module=94&type=1&id=543&version=2

func (*Order) HandleBuyerCancellation

func (o *Order) HandleBuyerCancellation(orderSn string, operation Operation) entity.HandleBuyerCancellationResult

HandleBuyerCancellation @Title Use this api to handle buyer's cancellation application. @Description https://open.shopee.com/documents?module=94&type=1&id=544&version=2

func (*Order) SetNote

func (o *Order) SetNote(orderSn, note string) entity.SetNoteResult

SetNote @Title Use this api to set note for an order. @Description https://open.shopee.com/documents?module=94&type=1&id=540&version=2

func (*Order) SplitOrder

func (o *Order) SplitOrder(orderSn string, packageList []entity.PackageListRequestEntity) entity.SplitOrderResult

SplitOrder @Title Use this api to split an order into multiple packages. @Description https://open.shopee.com/documents?module=94&type=1&id=545&version=2

func (*Order) UnSplitOrder

func (o *Order) UnSplitOrder(orderSn string) entity.UnSplitOrderResult

UnSplitOrder @Title Use this ai to undo split of order. After undo split, the order will have only one package. @Description https://open.shopee.com/documents?module=94&type=1&id=546&version=2

type OrderStatus

type OrderStatus string

OrderStatus

type TimeRangeField

type TimeRangeField string

TimeRangeField