rms

Documentation

Index

• func GetOrdersReq(ctx context.Context, cfg GetOrdersConfig) error
• func InitClient(cfg *ClientConfig) *req.Client
• func ReqInventory(ctx context.Context, cfg InventoryConfig) error
• func SearchItemReq(ctx context.Context, cfg SearchItemConfig) error
• func SearchOrderReq(ctx context.Context, cfg SearchOrderConfig) error
• func UpdateOrderShippingReq(ctx context.Context, cfg UpdateOrderShippingConfig) error
• type BasketIdModel
• type ChangeReasonModel
• type ChangeReasonModelList
• type ClientConfig
• type CouponModel
• type CouponModelList
• type DeliveryModel
• type DueDateModel
• type DueDateModelList
• type GetOrderDeliveryCvsModel
• type GetOrderRequestBody
• type GetOrderResponseBody
• type GetOrderShippingModel
• type GetOrdersConfig
• type Inventories
• type InventoriesErrorDetail
• type InventoriesErrorRespBody
• type InventoriesMetadata
• type InventoriesReqBody
• type InventoriesRespBody
• type InventoryBody
• type InventoryConfig
• type ItemBody
• type ItemCategory
• type ItemErrorDetail
• type ItemErrorRespBody
• type ItemModel
• type ItemRespBody
• type ItemResults
• type ItemReview
• type ItemType
• type ItemVariant
• type MessageModel
• type MessageModelList
• type OperationLeadTime
• type OrderModel
• type OrdererModel
• type PackageModel
• type PackageModelList
• type PaginationRequestModel
• type PaginationResponseModel
• type PointModel
• type QueryParameters
• type SearchItemConfig
• type SearchOrderConfig
• type SearchOrderRequestBody
• type SearchOrderResponse
• type SenderModel
• type SettlementModel
• type ShippingModel
• type SkuModel
• type SkuModelList
• type SortKey
• type SortModel
• type SortOrder
• type TaxSummaryModel
• type TaxSummaryModelList
• type UpdateOrderShippingConfig
• type UpdateOrderShippingReqBody
• type UpdateOrderShippingRespBody
• type WrappingModel

Functions

func GetOrdersReq

func GetOrdersReq(ctx context.Context, cfg GetOrdersConfig) error

func InitClient

func InitClient(cfg *ClientConfig) *req.Client

func ReqInventory

func ReqInventory(ctx context.Context, cfg InventoryConfig) error

func SearchItemReq

func SearchItemReq(ctx context.Context, cfg SearchItemConfig) error

func SearchOrderReq

func SearchOrderReq(ctx context.Context, cfg SearchOrderConfig) error

func UpdateOrderShippingReq

func UpdateOrderShippingReq(ctx context.Context, cfg UpdateOrderShippingConfig) error

Types

type BasketIdModel

type BasketIdModel struct {
	BasketId int64 `json:"basketId"`
	// Maximum number of shipping models that can be registered is 20.
	ShippingModelList []ShippingModel `json:"ShippingModelList"`
}

type ChangeReasonModel

type ChangeReasonModel struct {
	// ChangeID は変更IDです。
	ChangeID int `json:"changeId"`

	// ChangeType は変更種別です。以下のいずれかが入力されます。
	// 0: キャンセル申請
	// 1: キャンセル確定
	// 2: キャンセル完了
	// 3: キャンセル取消
	// 4: 変更申請
	// 5: 変更確定
	// 6: 変更完了
	// 7: 変更取消
	// 8: 注文確認
	// 9: 再決済手続き
	ChangeType *int `json:"changeType,omitempty"`

	// ChangeTypeDetail は変更種別(詳細)です。以下のいずれかが入力されます。
	// 0: 減額
	// 1: 増額
	// 2: その他
	// 10: 支払方法変更
	// 11: 支払方法変更・減額
	// 12: 支払方法変更・増額
	// ※その他は後払い決済選択注文で金額以外の変更が行われた場合のみ
	ChangeTypeDetail int `json:"changeTypeDetail,omitempty"`

	// ChangeReason は変更理由です。以下のいずれかが入力されます。
	// 0: 店舗様都合
	// 1: お客様都合
	ChangeReason *int `json:"changeReason,omitempty"`

	// ChangeReasonDetail は変更理由(小分類)です。以下のいずれかが入力されます。
	// 1: キャンセル
	// 2: 受取後の返品
	// 3: 長期不在による受取拒否
	// 4: 未入金
	// 5: 代引決済の受取拒否
	// 6: お客様都合 - その他
	// 8: 欠品
	// 10: 店舗様都合 - その他
	// 13: 発送遅延
	// 14: 顧客・配送対応注意表示
	// 15: 返品(破損・品間違い)
	ChangeReasonDetail *int `json:"changeReasonDetail,omitempty"`

	// ChangeApplyDatetime は変更申請日です。
	ChangeApplyDatetime *types.JpTime `json:"changeApplyDatetime,omitempty"`

	// ChangeFixDatetime は変更確定日です。
	ChangeFixDatetime *types.JpTime `json:"changeFixDatetime,omitempty"`

	// ChangeCompleteDatetime は変更完了日です。
	ChangeCompleteDatetime *types.JpTime `json:"changeCmplDatetime,omitempty"`
}

type ChangeReasonModelList

type ChangeReasonModelList []ChangeReasonModel

type ClientConfig

type ClientConfig struct {
	CondFunc   req.RetryConditionFunc
	RetryFunc  req.GetRetryIntervalFunc
	Timeout    time.Duration
	MaxRetries int
}

type CouponModel

type CouponModel struct {
	// CouponCode はクーポンコードです。
	CouponCode string `json:"couponCode"`

	// ItemID はクーポン対象の商品IDです。該当する商品がない場合は0が指定されます。
	ItemID int `json:"itemId"`

	// CouponName はクーポン名です。
	CouponName string `json:"couponName"`

	// CouponSummary はクーポン効果(サマリー)です。
	CouponSummary string `json:"couponSummary"`

	// CouponCapital はクーポン原資です。以下のいずれかが入力されます。
	// ・ショップ
	// ・メーカー
	// ・サービス
	CouponCapital string `json:"couponCapital"`

	// CouponCapitalCode はクーポン原資コードです。以下のいずれかが入力されます。
	// 1: ショップ
	// 2: メーカー
	// 3: サービス
	CouponCapitalCode int `json:"couponCapitalCode"`

	// ExpiryDate は有効期限です。日付のみ取得可能です。
	ExpiryDate types.JpDate `json:"expiryDate"`

	// CouponPrice はクーポン割引単価です。
	CouponPrice int `json:"couponPrice"`

	// CouponUnit はクーポン利用数です。
	CouponUnit int `json:"couponUnit"`

	// CouponTotalPrice はクーポン利用金額です。クーポン割引単価またはクーポン利用数がnullの場合、-9999になります。
	CouponTotalPrice int `json:"couponTotalPrice"`

	// 商品指定クーポン以外の場合：0
	ItemDetailId int `json:"itemDetailId"`
}

type CouponModelList

type CouponModelList []CouponModel

type DeliveryModel

type DeliveryModel struct {
	// DeliveryName は配送方法です。店舗設定で設定した配送方法が入力されます。
	DeliveryName string `json:"deliveryName"`

	// DeliveryClass は配送区分です。以下のいずれかが入力されます。
	// 0: 選択なし
	// 1: 普通
	// 2: 冷蔵
	// 3: 冷凍
	// 4: その他１
	// 5: その他２
	// 6: その他３
	// 7: その他４
	// 8: その他５
	DeliveryClass *int `json:"deliveryClass"`
}

type DueDateModel

type DueDateModel struct {
	// 0: 支払い期限日
	// 1: 支払い方法変更期限日
	// 2: 返金手続き期限日
	DueDateType int          `json:"dueDateType"`
	DueDate     types.JpDate `json:"dueDate"`
}

type DueDateModelList

type DueDateModelList []DueDateModel

type GetOrderDeliveryCvsModel

type GetOrderDeliveryCvsModel struct {
	// CvsCode はコンビニコードです。以下のいずれかが入力されます。
	// 1: ファミリーマート
	// 20: ミニストップ
	// 40: サークルK
	// 41: サンクス
	// 50: ローソン
	// 60: 郵便局
	// 70: スリーエフ
	// 71: エブリワン
	// 72: ココストア
	// 74: セーブオン
	// 80: デイリーヤマザキ
	// 81: ヤマザキデイリーストア
	// 82: ニューヤマザキデイリーストア
	// 85: ニューデイズ
	// 90: ポプラ
	// 91: くらしハウス
	// 92: スリーエイト
	// 93: 生活彩家
	CvsCode *int `json:"cvsCode"`

	// StoreGenreCode はストア分類コードです。APIのバージョンが2以降の場合入力されます。
	StoreGenreCode *string `json:"storeGenreCode"`

	// StoreCode はストアコードです。APIのバージョンが2以降の場合入力されます。
	StoreCode *string `json:"storeCode"`

	// StoreName はストア名称です。APIのバージョンが2以降の場合入力されます。
	StoreName *string `json:"storeName"`

	// StoreZip は郵便番号です。APIのバージョンが2以降の場合入力されます。
	StoreZip *string `json:"storeZip"`

	// StorePrefecture は都道府県です。APIのバージョンが2以降の場合のみ入力されます。
	StorePrefecture *string `json:"storePrefecture"`

	// StoreAddress はその他住所です。APIのバージョンが2以降の場合入力されます。
	StoreAddress *string `json:"storeAddress"`

	// AreaCode は発注エリアコードです。APIのバージョンが2以降の場合入力されます。
	AreaCode *string `json:"areaCode"`

	// Depo はセンターデポコードです。APIのバージョンが2以降の場合入力されます。
	Depo *string `json:"depo"`

	// OpenTime は開店時間です。APIのバージョンが2以降の場合入力されます。
	OpenTime *string `json:"openTime"`

	// CloseTime は閉店時間です。APIのバージョンが2以降の場合のみ入力されます。
	CloseTime *string `json:"closeTime"`

	// CvsRemarks は特記事項です。APIのバージョンが2以降の場合のみ入力されます。
	CvsRemarks *string `json:"cvsRemrks"`
}

type GetOrderRequestBody

type GetOrderRequestBody struct {
	// OrderNumberList は注文番号リストです。最大100件まで指定可能で、過去2年分の注文が対象です。
	// この項目は必須です。
	OrderNumberList []string `json:"orderNumberList"`

	// Version はバージョン番号です。現在は必須ではありませんが、今後は必須化される予定です。
	// 次のいずれかが入力されます。
	// 3: 消費税増税対応
	// 4: 共通の送料込みライン対応
	// 5: 領収書、前払い期限版
	// 6: 顧客・配送対応注意表示詳細対応
	// 7: SKU対応
	Version int `json:"version"`
}

GetOrderRequest は楽天ペイ受注APIの注文情報取得時の検索条件です。

type GetOrderResponseBody

type GetOrderResponseBody struct {
	// GetOrderMessageModelList はメッセージモデルリストです。
	MessageModelList []MessageModel `json:"MessageModelList"`

	// OrderModelList は受注モデルリストです。
	OrderModelList *[]OrderModel `json:"OrderModelList,omitempty"`

	// version バージョン番号
	Version int `json:"version"`
}

type GetOrderShippingModel

type GetOrderShippingModel struct {
	// ShippingDetailID は発送明細IDです。このIDは楽天が発行したもので、更新・削除の場合に使用します。
	ShippingDetailID int `json:"shippingDetailId"`

	// ShippingNumber はお荷物伝票番号です。
	ShippingNumber *string `json:"shippingNumber"`

	// DeliveryCompany は配送会社です。以下のいずれかが入力されます。
	// 1000: その他
	// 1001: ヤマト運輸
	// 1002: 佐川急便
	// 1003: 日本郵便
	// 1004: 西濃運輸
	// 1005: セイノースーパーエクスプレス
	// 1006: 福山通運
	// 1007: 名鉄運輸
	// 1008: トナミ運輸
	// 1009: 第一貨物
	// 1010: 新潟運輸
	// 1011: 中越運送
	// 1012: 岡山県貨物運送
	// 1013: 久留米運送
	// 1014: 山陽自動車運送
	// 1015: 日本トラック
	// 1016: エコ配
	// 1017: EMS
	// 1018: DHL
	// 1019: FedEx
	// 1020: UPS
	// 1021: 日本通運
	// 1022: TNT
	// 1023: OCS
	// 1024: USPS
	// 1025: SFエクスプレス
	// 1026: Aramex
	// 1027: SGHグローバル・ジャパン
	// 1028: Rakuten EXPRESS
	DeliveryCompany *string `json:"deliveryCompany"`

	// DeliveyCompanyName は配送会社名です。
	DeliveyCompanyName *string `json:"deliveryCompanyName"`

	// ShippingDate は発送日です。
	ShippingDate *types.JpDate `json:"shippingDate"`
}

type GetOrdersConfig

type GetOrdersConfig struct {
	Auth     *types.AuthParameter
	ReqBody  *GetOrderRequestBody
	RespBody *GetOrderResponseBody

	ClientConfig
}

type Inventories

type Inventories struct {
	ManageNumber      string             `json:"manageNumber"`
	VariantId         string             `json:"variantId"`
	Quantity          int                `json:"quantity"`
	OperationLeadTime *OperationLeadTime `json:"operationLeadTime,omitempty"`
	ShipFromIds       *types.Slice[int]  `json:"shipFromIds,omitempty"`
	Created           string             `json:"created"`
	Updated           string             `json:"updated"`
}

type InventoriesErrorDetail

type InventoriesErrorDetail struct {
	Code     string               `json:"code"`
	Message  string               `json:"message"`
	Metadata *InventoriesMetadata `json:"metadata"`
}

type InventoriesErrorRespBody

type InventoriesErrorRespBody struct {
	Errors []InventoriesErrorDetail `json:"errors"`
}

error respbody

type InventoriesMetadata

type InventoriesMetadata struct {
	PropertyPath *string `json:"propertyPath"`
}

type InventoriesReqBody

type InventoriesReqBody struct {
	Inventories []InventoryBody `json:"inventories"`
}

reqbody

type InventoriesRespBody

type InventoriesRespBody struct {
	Inventories []Inventories `json:"inventories"`
}

success respbody

type InventoryBody

type InventoryBody struct {
	ManageNumber string `json:"manageNumber"`
	VariantId    string `json:"variantId"`
}

type InventoryConfig

type InventoryConfig struct {
	Auth      *types.AuthParameter
	ReqBody   *InventoriesReqBody
	RespBody  *InventoriesRespBody
	RespError *InventoriesErrorRespBody

	ClientConfig
}

type ItemBody

type ItemBody struct {
	ManageNumber           string                         `json:"manageNumber"`
	ItemNumber             *string                        `json:"itemNumber,omitempty"`
	Title                  string                         `json:"title"`
	Tagline                *string                        `json:"tagline,omitempty"`
	ProductDescription     *types.Map[string, any]        `json:"productDescription,omitempty"`
	SalesDescription       *string                        `json:"salesDescription,omitempty"`
	Precautions            *types.Map[string, any]        `json:"precautions,omitempty"`
	ItemType               string                         `json:"itemType"`
	Images                 *types.Maps[string, any]       `json:"images,omitempty"`
	WhiteBgImage           *types.Map[string, any]        `json:"whiteBgImage,omitempty"`
	Video                  *types.Map[string, any]        `json:"video,omitempty"`
	GenreId                string                         `json:"genreId"`
	Tags                   *types.Slice[int]              `json:"tags,omitempty"`
	HideItem               bool                           `json:"hideItem"`
	UnlimitedInventoryFlag bool                           `json:"unlimitedInventoryFlag"`
	CustomizationOptions   *types.Maps[string, any]       `json:"customizationOptions,omitempty"`
	ReleaseDate            *string                        `json:"releaseDate,omitempty"`
	PurchasablePeriod      *types.Map[string, any]        `json:"purchasablePeriod,omitempty"`
	Subscription           *types.Map[string, any]        `json:"subscription,omitempty"`
	Features               types.Map[string, any]         `json:"features"`
	AccessControl          *types.Map[string, any]        `json:"accessControl,omitempty"`
	Payment                types.Map[string, any]         `json:"payment"`
	PointCampaign          *types.Map[string, any]        `json:"pointCampaign,omitempty"`
	ItemDisplaySequence    int                            `json:"itemDisplaySequence"`
	Layout                 types.Map[string, any]         `json:"layout"`
	VariantSelectors       *types.Maps[string, any]       `json:"variantSelectors,omitempty"`
	Variants               types.Map[string, ItemVariant] `json:"variants"`
	Created                string                         `json:"created"`
	Updated                string                         `json:"updated"`
}

type ItemCategory

type ItemCategory struct {
	CategoryIds *types.Slice[string] `json:"categoryIds"`
}

type ItemErrorDetail

type ItemErrorDetail struct {
	Code    string `json:"code"`
	Message string `json:"message"`
}

type ItemErrorRespBody

type ItemErrorRespBody struct {
	Errors []ItemErrorDetail `json:"errors"`
}

error respbody

type ItemModel

type ItemModel struct {
	// ItemDetailID は商品明細IDです。
	ItemDetailID int `json:"itemDetailId"`

	// ItemName は商品名です。
	ItemName string `json:"itemName"`

	// ItemID は商品IDです。
	ItemID int `json:"itemId"`

	// ItemNumber は商品番号です。項目選択肢別在庫が指定された商品の場合、以下のルールで値が表示されます。
	// 商品番号 + 項目選択肢ID(横軸) + 項目選択肢ID(縦軸)
	ItemNumber *string `json:"itemNumber"`

	// ManageNumber は商品管理番号です。
	ManageNumber string `json:"manageNumber"`

	// Price は単価です。
	Price int `json:"price"`

	// Units は個数です。
	Units int `json:"units"`

	// IncludePostageFlag は送料込別です。以下のいずれかが入力されます。
	// 0: 送料別
	// 1: 送料込みもしくは送料無料
	IncludePostageFlag int `json:"includePostageFlag"`

	// IncludePostageFlag は税込み別です。以下のいずれかが入力されます。
	// 0: 税別
	// 1: 税込み
	IncludeTaxFlag int `json:"includeTaxFlag"`

	// IncludeCashOnDeliveryPostageFlag は代引き手数料込別です。以下のいずれかが入力されます。
	// 0: 代引き手数料別
	// 1: 代引き手数料込み
	IncludeCashOnDeliveryPostageFlag int `json:"includeCashOnDeliveryPostageFlag"`

	// SelectedChoice は項目・選択肢です。注文種別が通常購入、共同購入、定期購入、頒布会、予約商品の場合入力されます。
	// 表示形式は"横軸項目名:横軸選択肢 縦軸項目名:縦軸選択肢" で、HTMLタグは除去されます。
	SelectedChoice *string `json:"selectedChoice,omitempty"`

	// PointRate はポイント倍率です。
	PointRate int `json:"pointRate"`

	// PointType はポイントタイプです。APIのバージョンが2以降の場合入力されます。以下のいずれかが入力されます。
	// 0: 変倍なし
	// 1: 店舗別変倍
	// 2: 商品別変倍
	PointType int `json:"pointType"`

	// InventoryType は在庫タイプです。以下のいずれかが入力されます。
	// 0: 在庫設定無し
	// 1: 通常在庫設定
	// 2: 項目選択肢在庫設定
	InventoryType int `json:"inventoryType"`

	// DelvdateInfo は納期情報です。
	DelvdateInfo *string `json:"delvdateInfo,omitempty"`

	// RestoreInventoryFlag は在庫連動オプションです。以下のいずれかが入力されます。
	// 0: 商品の設定に従う
	// 1: 在庫連動する
	// 2: 在庫連動しない
	RestoreInventoryFlag int `json:"restoreInventoryFlag"`

	// DealFlag hあ楽天スーパーDEAL商品フラグです。APIのバージョンが2以降の場合入力されます。以下のいずれかが入力されます。
	// 0: 楽天スーパーDEAL商品ではない
	// 1: 楽天スーパーDEAL商品である
	DealFlag int `json:"dealFlag"`

	// DrugFlag は医薬品フラグです。APIのバージョンが2以降の場合入力されます。以下のいずれかが入力されます。
	// 0: 医薬品ではない。
	// 1: 医薬品である。
	DrugFlag int `json:"drugFlag"`

	// DeleteItemFlag は商品削除フラグです。以下のいずれかが入力されます。
	// 0: 商品を削除しない
	// 1: 商品を削除する
	DeleteItemFlag int `json:"deleteItemFlag"`

	// TaxRate は商品税率です。APIのバージョンが3以降の場合入力されます。店舗で税率が更新されていない注文の場合NULLとなります。
	TaxRate float64 `json:"TaxRate"`

	// PriceTaxIncl は商品毎税込価格です。APIのバージョンが3以降の場合入力されます。
	// 税込商品の場合、商品単価は商品毎税込価格となります。
	// 税別商品の場合、税込価格(商品単価 * (1 + 税率))です。端数処理は店舗設定に準じます。
	PriceTaxIncl int `json:"priceTaxIncl"`

	// IsSingleItemShipping は単品配送フラグです。APIのバージョンが4以降の場合入力されます。以下のいずれかが入力されます。
	// 0: 単品配送ではない
	// 1: 単品配送である
	IsSingleItemShipping int `json:"isSingleItemShipping"`

	SkuModelList *SkuModelList `json:"SkuModelList,omitempty"`
}

type ItemRespBody

type ItemRespBody struct {
	NumFound       int           `json:"numFound"`
	Offset         int           `json:"offset"`
	NextCursorMark string        `json:"nextCursorMark"`
	Results        []ItemResults `json:"results"`
}

success respbody

type ItemResults

type ItemResults struct {
	Item      ItemBody                `json:"item"`
	Category  *ItemCategory           `json:"category"`
	Review    *ItemReview             `json:"review"`
	Inventory *types.Map[string, any] `json:"inventory"`
}

type ItemReview

type ItemReview struct {
	Count         *int     `json:"count"`
	AverageRating *float64 `json:"averageRating"`
}

type ItemType

type ItemType string

const (
	NORMAL       ItemType = "NORMAL"
	PRE_ORDER    ItemType = "PRE_ORDER"
	SUBSCRIPTION ItemType = "SUBSCRIPTION"
)

type ItemVariant

type ItemVariant struct {
	MerchantDefinedSkuId    *string                  `json:"merchantDefinedSkuId,omitempty"`
	SelectorValues          *types.Map[string, any]  `json:"selectorValues,omitempty"`
	Images                  *types.Maps[string, any] `json:"images,omitempty"`
	RestockOnCancel         *bool                    `json:"restockOnCancel,omitempty"`
	BackOrderFlag           *bool                    `json:"backOrderFlag,omitempty"`
	NormalDeliveryDateId    *int                     `json:"normalDeliveryDateId,omitempty"`
	BackOrderDeliveryDateId *int                     `json:"backOrderDeliveryDateId,omitempty"`
	OrderQuantityLimit      *int                     `json:"orderQuantityLimit,omitempty"`
	ReferencePrice          *types.Map[string, any]  `json:"referencePrice,omitempty"`
	Features                *types.Map[string, any]  `json:"features,omitempty"`
	Hidden                  *bool                    `json:"hidden,omitempty"`
	StandardPrice           *string                  `json:"standardPrice,omitempty"`
	SubscriptionPrice       *types.Map[string, any]  `json:"subscriptionPrice,omitempty"`
	ArticleNumberForSet     *types.Slice[string]     `json:"articleNumberForSet,omitempty"`
	ArticleNumber           *types.Map[string, any]  `json:"articleNumber,omitempty"`
	Shipping                *types.Map[string, any]  `json:"shipping,omitempty"`
	AsurakuDeliveryId       *int                     `json:"asurakuDeliveryId,omitempty"`
	Specs                   *types.Maps[string, any] `json:"specs,omitempty"`
	Attributes              *types.Maps[string, any] `json:"attributes,omitempty"`
}

type MessageModel

type MessageModel struct {
	// CommonMessageModelResponse はエラー情報が含まれます。
	types.CommonMessageModelResponse

	// OrderNumber は注文番号です。
	OrderNumber *string `json:"orderNumber,omitempty"`
}

type MessageModelList

type MessageModelList struct {
	MessageType      string `json:"messageType"` // INFO, ERROR
	MessageCode      string `json:"messageCode"`
	Message          string `json:"message"`
	DataNumber       *int64 `json:"dataNumber"`
	ShippingDetailId *int64 `json:"shippingDetailId"`
}

type OperationLeadTime

type OperationLeadTime struct {
	NormalDeliveryTimeId    int `json:"normalDeliveryTimeId"`
	BackOrderDeliveryTimeId int `json:"backOrderDeliveryTimeId"`
}

type OrderModel

type OrderModel struct {
	// OrderNumber は注文番号です。
	OrderNumber string `json:"orderNumber"`
	// OrderProgress はステータスです。以下のいずれかが入力されます。
	// 100: 注文確認待ち
	// 200: 楽天処理中
	// 300: 発送待ち
	// 400: 変更確定待ち
	// 500: 発送済
	// 600: 支払手続き中
	// 700: 支払手続き済
	// 800: キャンセル確定待ち
	// 900: キャンセル確定
	OrderProgress int `json:"orderProgress"`

	// SubStatusID はサブステータスIDです。
	SubStatusID *int `json:"subStatusId,omitempty"`

	// SubStatusName はサブステータスです。
	SubStatusName *string `json:"subStatusName,omitempty"`

	// OrderDatetime は注文日時です。
	OrderDatetime types.JpTime `json:"orderDatetime"`

	// ShopOrderConfirmDatetime は注文確認日時です。
	ShopOrderConfirmDatetime *types.JpTime `json:"shopOrderCfmDatetime,omitempty"`

	// OrderFixDatetime は注文確定日時です。
	OrderFixDatetime *types.JpTime `json:"orderFixDatetime,omitempty"`

	// ShippingInstDatetime は発送指示日時です。
	ShippingInstDatetime *types.JpTime `json:"shippingInstDatetime,omitempty"`

	// ShippingCompleteReportDatetime は発送完了報告日時です。
	ShippingCompleteReportDatetime *types.JpTime `json:"shippingCmplRptDatetime,omitempty"`

	// CancelDueDate はキャンセル期限日です。
	CancelDueDate *types.JpDate `json:"cancelDueDate,omitempty"`

	// DeliveryDate はお届け日指定です。
	DeliveryDate *types.JpDate `json:"deliveryDate,omitempty"`

	// ShippingTerm はお届け時間帯です。以下のいずれかが入力されます。
	// 0: なし
	// 1: 午前
	// 2: 午後
	// 9: その他
	// h1h2: h1時-h2時(h1は7~24, h2は07-24まで任意の数値で指定可能)
	ShippingTerm *int `json:"shippingTerm,omitempty"`

	// Remarks はコメントです。備考欄に入るデータのことです。
	Remarks *string `json:"remarks"`

	// GiftCheckFlag はギフト配送希望フラグです。以下のいずれかが入力されます。
	// 0: ギフト注文ではない
	// 1: ギフト注文である
	GiftCheckFlag int `json:"giftCheckFlag"`

	// SeveralSenderFlag は複数送付先フラグです。以下のいずれかが入力されます。
	// 0: 複数配送先なし
	// 1: 複数配送先あり
	SeveralSenderFlag int `json:"severalSenderFlag"`

	// EqualSenderFlag は送付先一致フラグです。以下のいずれかが入力されます。
	// 0: 注文者と送付者の住所が同じではない。
	// 1: 注文が単数で注文者と送付先の住所が同じ
	EqualSenderFlag int `json:"equalSenderFlag"`

	// IsolatedIslandFlag は離島フラグです。以下のいずれかが入力されます。
	// 0: 送付先に離島が含めれていない。
	// 1: 送付先に離島あ含まれている。
	IsolatedIslandFlag int `json:"isolatedIslandFlag"`

	// RakutenMemberFlag は楽天会員フラグです。以下のいずれかが入力されます。
	// 0: 楽天会員ではない。
	// 1: 楽天会員である。
	RakutenMemberFlag int `json:"rakutenMemberFlag"`

	// CarrieCode は利用端末です。以下のいずれかが入力されます。
	// 0: PC (Windows系のスマートフォン、タブレットを含む)
	// 1: モバイル(docomo) フィーチャーフォン
	// 2: モバイル(KDDI) フィーチャーフォン
	// 3: モバイル(Softbank) フィーチャーフォン
	// 5: モバイル(WILLCOM) フィーチャーフォン
	// 11: スマートフォン（iPhone系）
	// 12: スマートフォン（Android系）
	// 19: スマートフォン（その他）
	// 21: タブレット（iPad系）
	// 22: タブレット（Android系）
	// 29: タブレット（その他）
	// 99: その他　不明な場合も含む
	CarrieCode int `json:"carrierCode"`

	// EmailCarrierCode はメールキャリアコードです。以下のいずれかが入力されます。
	// 0: PC ("@i.softbank.jp"を含む)
	// 1: DoCoMo
	// 2: au
	// 3: SoftBank
	// 5: WILLCOM
	// 99: その他
	EmailCarrierCode int `json:"emailCarrierCode"`

	// OrderType は注文種別です。以下のいずれかが入力されます。
	// 1: 通常購入
	// 4: 定期購入
	// 5: 頒布会
	// 6: 予約商品
	OrderType int `json:"orderType"`

	// ReserveNumber は申込番号です。定期購入、頒布会、予約商品に付与されます。
	ReserveNumber *string `json:"reserveNumber,omitempty"`

	// ReserveDeliveryCount は申込お届け回数です。予約商品は常に1、定期購入、頒布会は確定した回数が入力されます。
	ReserveDeliveryCount *int `json:"reserveDeliveryCount,omitempty"`

	// CautionDisplayType は警告表示タイプです。以下のいずれかが入力されます。
	// 0: 表示なし
	// 1: 表示あり 注意喚起
	// 2: 表示あり キャンセル確定
	CautionDisplayType int `json:"cautionDispalyType,omitempty"`

	// RakutenConfirmFlag は楽天確認中フラグです。以下のいずれかが入力されます。
	// 0: 楽天確認中ではない
	// 1: 楽天確認中
	RakutenConfirmFlag int `json:"rakutenConfirmFlag"`

	// GoodsPrice は商品合計金額です。商品金額 + ラッピング料です。
	GoodsPrice int `json:"goodsPrice"`

	// GoodsTax は外税合計です。税込商品の場合は0、未確定の場合は-9999です。APIのバージョンが3以降の場合、この値ではなく請求金額に対する税額(reqPriceTax)をご使用ください。
	GoodsTax int `json:"goodsTax"`

	// PostagePrice は送料合計です。送付先が複数ある場合、その合計です。未確定の場合、-9999です。
	PostagePrice int `json:"postagePrice"`

	// DeliveryPrice は代引料合計です。代引手数料がかからない決済手段の場合は0、未確定の場合は-9999です。
	DeliveryPrice int `json:"deliveryPrice"`

	// PaymentCharge は決済手数料合計です。決済手数料がかからない決済手段の場合は0、未確定の場合は-9999です。APIのバージョンが2以降の場合のみ入力されます。
	PaymentCharge int `json:"paymentCharge"`

	// PaymentChargeTaxRate は決済手数料税率です。APIのバージョンが3以降の場合のみ入力されます。
	PaymentChargeTaxRate float64 `json:"paymentChargeTaxRate"`

	// TotalPrice は合計金額です。商品金額 + 送料 + ラッピング料です。未確定の場合は-9999です。
	TotalPrice int `json:"totalPrice"`

	// RequestPrice は請求金額です。商品金額 + 送料 + ラッピング料 + 決済手数料 + 注文者負担金 - クーポン利用総額 - ポイント利用額です。未確定の場合は-9999です。
	RequestPrice int `json:"requestPrice"`

	// CouponAllTotalPrice はクーポン利用総額です。
	CouponAllTotalPrice int `json:"couponAllTotalPrice"`

	// CouponShopPrice は店舗発行クーポン利用額です。クーポン原資コードが1のクーポンが対象です。未確定の場合は-9999です。
	CouponShopPrice int `json:"couponShopPrice"`

	// CouponOtherPrice は楽天発行クーポン利用額です。クーポン原資コードが1以外のクーポンが対象です。未確定の場合は-9999です。
	CouponOtherPrice int `json:"couponOtherPrice"`

	// AdditionalFeeOccurAmountToUser は注文者負担金合計です。負担金がない場合は0、未確定の場合は-9999です。APIのバージョンが2以降の場合のみ入力されます。
	AdditionalFeeOccurAmountToUser int `json:"additionalFeeOccurAmountToUser"`

	// AdditionalFeeOccurAmountToShop は店舗負担金合計です。負担金がない場合は0、未確定の場合は-9999です。APIのバージョンが2以降の場合のみ入力されます。
	AdditionalFeeOccurAmountToShop int `json:"additionalFeeOccurAmountToShop"`

	// AsurakuFlag はあす楽希望フラグです。以下のいずれかが入力されます。
	// 0: あす楽希望無し注文
	// 1: あす楽希望有り注文
	AsurakuFlag int `json:"asurakuFlag"`

	// DrugFlag は医薬品受注フラグです。以下のいずれかが入力されます。
	// 0: 医薬品を含む注文ではない
	// 1: 医薬品を含む注文である
	DrugFlag int `json:"drugFlag"`

	// DealFlag は楽天スーパーDEAL商品受注フラグです。以下のいずれかが入力されます。
	// 0: 楽天スーパーディール商品を含む受注ではない
	// 1: 楽天スーパーディール商品を含む受注である
	DealFlag int `json:"dealFlag"`

	// MembershipType はメンバーシッププログラム受注タイプです。以下のいずれかが入力されます。
	// 0: 楽天プレミアムでも楽天学割対象受注でもない
	// 1: 楽天プレミアム対象受注である
	// 2: 楽天学割対象受注である
	MembershipType int `json:"membershipType"`

	// Memo はひとことメモです。
	Memo *string `json:"Memo,omitempty"`

	// Operator は担当者です。
	Operator *string `json:"operator,omitempty"`

	// MailPlugSentence はメール差し込み文(お客様へのメッセージ)です
	MailPlugSentence *string `json:"mailPlugSentence,omitempty"`

	// ModifyFlag は購入履歴修正有無フラグです。以下のいずれかが入力されます。
	// 0: 修正なし
	// 1: 修正あり
	ModifyFlag int `json:"modifyFlag"`

	// IsTaxRecalc は消費税再計算フラグです。APIのバージョンが3以降の場合のみ入力されます。以下のいずれかが入力されます。
	// 0: 再計算しない
	// 1: 再計算する
	IsTaxRecalc *int `json:"isTaxRecalc,omitempty"`

	ReceiptIssueCount int `json:"receiptIssueCount"`

	ReceiptIssueHistoryList *types.Slice[types.JpTime] `json:"receiptIssueHistoryList,omitempty"`

	// GetOrderOrdererModel は注文者モデルです。
	OrdererModel `json:"OrdererModel"`

	// GetOrderSettlementModel は支払い方法モデルです。
	SettlementModel *SettlementModel `json:"SettlementModel,omitempty"`

	// GetOrderDeliveryModel は配送方法モデルです。
	DeliveryModel `json:"DeliveryModel"`

	// GetOrderPointModel はポイントモデルです。
	PointModel *PointModel `json:"PointModel,omitempty"`

	// WrappingModel1 はラッピングモデル1です。
	WrappingModel1 *WrappingModel `json:"WrappingModel1,omitempty"`

	// WrappingModel2 はラッピングモデル2です。
	WrappingModel2 *WrappingModel `json:"WrappingModel2,omitempty"`

	// PackageModelList は送付先モデルリストです。
	PackageModelList PackageModelList `json:"PackageModelList"`

	// CouponModelList はクーポンモデルリストです。
	CouponModelList *CouponModelList `json:"CouponModelList,omitempty"`

	// ChangeReasonModelList は変更・キャンセルモデルリストです。
	ChangeReasonModelList *ChangeReasonModelList `json:"ChangeReasonModelList,omitempty"`

	// TaxSummaryModelList は税情報モデルリストです。APIのバージョンが3以降の場合のみ入力されます。2019/7/30以前の注文の場合、空のモデルが返却されます。
	TaxSummaryModelList *TaxSummaryModelList `json:"TaxSummaryModelList,omitempty"`

	DueDateModelList *DueDateModelList `json:"DueDateModelList,omitempty"`
}

type OrdererModel

type OrdererModel struct {
	// ZipCode1 は郵便番号1です。3桁の数値です。(0はじまりがあるため文字列です。)
	ZipCode1 string `json:"zipCode1"`

	// ZipCode2 は郵便番号2です。4桁の数値です。(0はじまりがあるため文字列です。)
	ZipCode2 string `json:"zipCode2"`

	// Prefecture は都道府県です。
	Prefecture string `json:"prefecture"`

	// City は郡市区です。
	City string `json:"city"`

	// SubAddress はCity以降の住所です。
	SubAddress string `json:"subAddress"`

	// FamilyName は姓です。
	FamilyName string `json:"familyName"`

	// FirstName は名です。
	FirstName string `json:"firstName"`

	// FamilyNameKana は姓カナです。
	FamilyNameKana *string `json:"familyNameKana,omitempty"`

	// FirstNameKana は名カナです。
	FirstNameKana *string `json:"firstNameKana,omitempty"`

	// PhoneNumber1 は電話暗号1です。電話番号3までのうち、1つまでがnullの可能性があります。
	PhoneNumber1 *string `json:"phoneNumber1,omitempty"`

	// PhoneNumber2 は電話暗号2です。電話番号3までのうち、1つまでがnullの可能性があります。
	PhoneNumber2 *string `json:"phoneNumber2,omitempty"`

	// PhoneNumber3 は電話暗号3です。電話番号3までのうち、1つまでがnullの可能性があります。
	PhoneNumber3 *string `json:"phoneNumber3,omitempty"`

	// EmailAddress はメールアドレスです。マスキングされたものが取得されます。
	EmailAddress string `json:"emailAddress"`

	// Sex は性別です。
	Sex *string `json:"sex,omitempty"`

	// BirthYear は誕生日(年)です。
	BirthYear *int `json:"birthYear,omitempty"`

	// BirthMonth は誕生日(月)です。
	BirthMonth *int `json:"birthMonth,omitempty"`

	// BirthDay は誕生日(日)です。
	BirthDay *int `json:"birthDay,omitempty"`
}

GetOrderOrdererModel は楽天ペイ受注APIの注文情報の取得で得られる注文者の情報です。

type PackageModel

type PackageModel struct {
	// BascketID は送付先IDです。
	BasketId int `json:"basketId"`

	// PostagePrice は送料です。未設定の場合、-9999になります。
	PostagePrice int `json:"postagePrice"`

	// PostageTaxRate は送料税率です。APIのバージョンが3以降の場合のみ入力されます。
	PostageTaxRate float64 `json:"postageTaxRate"`

	// DeliveryPrice は代引料です。未設定の場合、-9999になります。
	DeliveryPrice int `json:"deliveryPrice"`

	// DeliveryTaxRate は代引料税率です。APIのバージョンが3以降の場合のみ入力されます。
	DeliveryTaxRate float64 `json:"deliveryTaxRate"`

	// GoodsTax は送付先外税合計です。税込商品の場合は0、未設定の場合は-9999が入力されます。APIのバージョンが3以降の場合のみ入力されます。
	GoodsTax int `json:"goodsTax"`

	// GoodsPrice は商品合計金額です。商品金額 + ラッピング料です。
	GoodsPrice int `json:"goodsPrice"`

	// TotalPrice は合計金額です。 商品金額 + 送料 + ラッピング料です。未確定の場合は-9999になります。APIのバージョンが1を指定すると代引手数料が含まれます。
	TotalPrice int `json:"totalPrice"`

	// Noshi はのしです。
	Noshi *string `json:"noshi,omitempty"`

	// PackageDeleteFlag は送付先モデル削除フラグです。以下のいずれかが入力されます。
	// 0: 送付先モデルを削除しない
	// 1: 送付先モデルを削除する
	PackageDeleteFlag int `json:"packageDeleteFlag"`

	// GetOrderSenderModel は送付者モデルです。
	SenderModel `json:"senderModel"`

	// ItemModelList は商品モデルリストです。
	ItemModelList []ItemModel `json:"ItemModelList"`

	// ShippingModelList は発送モデルリストです。
	ShippingModelList []GetOrderShippingModel `json:"ShippingModelList"`

	// GetOrderDeliveryCvsModel はコンビニ配送モデルです。
	GetOrderDeliveryCvsModel `json:"DeliveryCvsModel"`

	// DefaultDeliveryCompanyCode は購入時配送会社です。APIのバージョンが4以降の場合のみ入力されます。以下のいずれかが入力されます。
	// 1000: その他
	// 1001: ヤマト運輸
	// 1002: 佐川急便
	// 1003: 日本郵便
	// 1004: 西濃運輸
	// 1005: セイノースーパーエクスプレス
	// 1006: 福山通運
	// 1007: 名鉄運輸
	// 1008: トナミ運輸
	// 1009: 第一貨物
	// 1010: 新潟運輸
	// 1011: 中越運送
	// 1012: 岡山県貨物運送
	// 1013: 久留米運送
	// 1014: 山陽自動車運送
	// 1015: 日本トラック
	// 1016: エコ配
	// 1017: EMS
	// 1018: DHL
	// 1019: FedEx
	// 1020: UPS
	// 1021: 日本通運
	// 1022: TNT
	// 1023: OCS
	// 1024: USPS
	// 1025: SFエクスプレス
	// 1026: Aramex
	// 1027: SGHグローバル・ジャパン
	// 1028: Rakuten EXPRESS
	DefaultDeliveryCompanyCode string `json:"defaultDeliveryCompanyCode"`
}

type PackageModelList

type PackageModelList []PackageModel

type PaginationRequestModel

type PaginationRequestModel struct {
	// RequestRecordsAmount は1ページあたりの取得結果数です。最大1,000件まで取得可能です。
	RequestRecordsAmount int `json:"requestRecordsAmount"`

	// RequestPage はリクエストページ番号です。
	RequestPage int `json:"requestPage"`

	// SortModelList はソート条件です。
	SortModelList []SortModel `json:"SortModelList,omitempty"`
}

SearchOrderPaginationRequestModel は楽天ペイ受注APIで注文検索の検索条件のうち、ページングに関する条件です。

type PaginationResponseModel

type PaginationResponseModel struct {
	// TotalRecordsAmount は総結果数です。
	TotalRecordsAmount int `json:"totalRecordsAmount"`

	// TotalPages は総ページ数です。
	TotalPages int `json:"totalPages"`

	// RequestPage はリクエストページ番号です。
	RequestPage int `json:"requestPage"`
}

search order response SearchOrderPaginationResponseModel は楽天ペイ受注APIの注文検索時に取得したデータ数、ページ数が入力されます。

type PointModel

type PointModel struct {
	// UsedPoint はポイント利用額です。
	UsedPoint int `json:"usedPoint"`
}

type QueryParameters

type QueryParameters struct {
	Title                     *string       `json:"title,omitempty"`
	Tagline                   *string       `json:"tagline,omitempty"`
	ManageNumber              *string       `json:"manageNumber,omitempty"`
	ItemNumber                *string       `json:"itemNumber,omitempty"`
	ArticleNumber             *string       `json:"articleNumber,omitempty"`
	VariantId                 *string       `json:"variantId,omitempty"`
	MerchantDefinedSkuId      *string       `json:"merchantDefinedSkuId,omitempty"`
	GenreId                   *string       `json:"genreId,omitempty"`
	ItemType                  *ItemType     `json:"itemType,omitempty"`
	IsAsuraku                 *bool         `json:"isAsuraku,omitempty"`
	StandardPriceFrom         *int          `json:"standardPriceFrom,omitempty"`
	StandardPriceTo           *int          `json:"standardPriceTo,omitempty"`
	IsVariantStockout         *bool         `json:"isVariantStockout,omitempty"`
	IsItemStockout            *bool         `json:"isItemStockout,omitempty"`
	PurchasablePeriodFrom     *types.JpDate `json:"purchasablePeriodFrom,omitempty"`
	PurchasablePeriodTo       *types.JpDate `json:"purchasablePeriodTo,omitempty"`
	IsHiddenItem              *bool         `json:"isHiddenItem,omitempty"`
	IsHiddenVariant           *bool         `json:"isHiddenVariant,omitempty"`
	IsSearchable              *bool         `json:"isSearchable,omitempty"`
	IsYamiichi                *bool         `json:"isYamiichi,omitempty"`
	PointApplicablePeriodFrom *types.JpDate `json:"pointApplicablePeriodFrom,omitempty"`
	PointApplicablePeriodtTo  *types.JpDate `json:"pointApplicablePeriodTo,omitempty"`
	IsOptimizedPoint          *bool         `json:"isOptimizedPoint,omitempty"`
	PointRate                 *int          `json:"pointRate,omitempty"`
	MaxPointRate              *int          `json:"maxPointRate,omitempty"`
	CategoryId                *string       `json:"categoryId,omitempty"`
	IsBackOrder               *bool         `json:"isBackOrder,omitempty"`
	IsPostageIncluded         *bool         `json:"isPostageIncluded,omitempty"`
	CreatedFrom               *types.JpDate `json:"createdFrom,omitempty"`
	CreatedTo                 *types.JpDate `json:"createdTo,omitempty"`
	UpdatedFrom               *types.JpDate `json:"updatedFrom,omitempty"`
	UpdatedTo                 *types.JpDate `json:"updatedTo,omitempty"`
	SortKey                   *SortKey      `json:"sortKey,omitempty"`
	SortOrder                 *SortOrder    `json:"sortOrder,omitempty"`
	Offset                    *int          `json:"offset,omitempty"`
	Hits                      *int          `json:"hits,omitempty"`
	CursorMark                *string       `json:"cursorMark,omitempty"`
	IsCategoryIncluded        *bool         `json:"isCategoryIncluded,omitempty"`
	IsReviewIncluded          *bool         `json:"isReviewIncluded,omitempty"`
	IsInventoryIncluded       *bool         `json:"isInventoryIncluded,omitempty"`
}

paramters

type SearchItemConfig

type SearchItemConfig struct {
	Auth      *types.AuthParameter
	ReqParams *QueryParameters
	RespBody  *ItemRespBody
	RespError *ItemErrorRespBody

	ClientConfig
}

type SearchOrderConfig

type SearchOrderConfig struct {
	Auth     *types.AuthParameter
	ReqBody  *SearchOrderRequestBody
	RespBody *SearchOrderResponse

	ClientConfig
}

type SearchOrderRequestBody

type SearchOrderRequestBody struct {
	// OrderProgressList はステータスリストです。
	// ステータスは以下のいずれかが入ります。
	// 100: 注文確認待ち
	// 200: 楽天処理中
	// 300: 発送待ち
	// 400: 変更確定待ち
	// 500: 発送済
	// 600: 支払手続き中
	// 700: 支払手続き済
	// 800: キャンセル確定待ち
	// 900: キャンセル確定
	OrderProgressList *[]int `json:"orderProgressList,omitempty"`

	// SubStatusIdList はサブステータスIDリストです。
	// ユーザが作成したサブステータスを指定することができます。
	SubStatusIDList *[]int `json:"subStatusIdList,omitempty"`

	// DateType は期間検索種別です。
	// この項目は必須です。
	// 種別は以下のいずれかが入ります。
	// 1: 注文日
	// 2: 注文確認日
	// 3: 注文確定日
	// 4: 発送日
	// 5: 発送完了報告日
	// 6: 決済確定日
	DateType int `json:"dateType"`

	// StartDatetime は期間検索開始日時です。過去2年以内の注文を指定することが可能です。
	// この項目は必須です。
	StartDatetime types.JpTime `json:"startDatetime"`

	// EndDatetime は期間検索終了日時です。開始日から63日以内を指定することができます。
	// この項目は必須です。
	EndDatetime types.JpTime `json:"endDatetime"`

	// OrderTypeList は販売種別リストです。以下のいずれかを指定することができます。
	// 1: 通常購入
	// 4: 定期購入
	// 5: 頒布会
	// 6: 予約商品
	OrderTypeList *[]int `json:"orderTypeList,omitempty"`

	// SettlementMethod は支払い方法名です。以下のいずれかを指定することができます。
	// 1: クレジットカード
	// 2: 代金引換
	// 3: 後払い
	// 4: ショッピングクレジット／ローン
	// 5: オートローン
	// 6: リース
	// 7: 請求書払い
	// 9: 銀行振込
	// 12: Apple Pay
	// 13: セブンイレブン（前払）
	// 14: ローソン、郵便局ATM等（前払）
	// 16: Alipay
	// 17: PayPal
	// 21: 後払い決済（楽天市場の共通決済）
	// 27: Alipay（支付宝）
	SettlementMethod *int `json:"settlementMethod,omitempty"`

	// DeliveryName は配送方法です。
	DeliveryName *string `json:"deliveryName,omitempty"`

	// ShippingDateBlankFlag は発送日未指定有無フラグです。以下のいずれかを指定することができます。
	// 0: 発送日の指定の有無によらず取得
	// 1: 発送日が未指定のものだけを取得
	ShippingDateBlankFlag *int `json:"shippingDateBlankFlag,omitempty"`

	// ShippingNumberBlankFlag はお荷物伝票番号未指定有無フラグです。以下のいずれかを指定することができます。
	// 0: お荷物伝票番号の指定の有無によらず取得
	// 1: お荷物伝票番号が未指定のものだけを取得
	ShippingNumberBlankFlag *int `json:"shippingNumberBlankFlag,omitempty"`

	// SearchKeywordType は検索キーワード種別です。次のいずれかを指定することができます。
	// 0: なし
	// 1: 商品名
	// 2: 商品番号
	// 3: ひとことメモ
	// 4: 注文者氏名
	// 5: 注文者氏名フリガナ
	// 6: 送付先氏名
	// 7: SKU管理番号
	// 8: システム連携用SKU番号
	// 9: SKU情報
	SearchKeywordType *int `json:"searchKeywordType,omitempty"`

	// SearchKeyword は検索キーワードです。32文字以下の入力を受け付けます。
	// 1: 商品名：1024 文字以下
	// 2: 商品番号：127文字以下
	// 3: ひとことメモ：1000文字以下
	// 4: 注文者氏名：254文字以下
	// 5: 注文者氏名フリガナ：254文字以下
	// 6: 送付先氏名：254文字以下
	// 7: SKU管理番号：40文字以下
	// 8: システム連携用SKU番号：96文字以下
	// 9: SKU情報：400文字以下
	SearchKeyword *string `json:"searchKeyword,omitempty"`

	// MailSendType は注文メールアドレス種別です。以下のいずれかを指定することができます。
	// 0: PC/モバイル
	// 1: PC
	// 2: モバイル
	MailSendType *int `json:"mailSendType,omitempty"`

	// OrdererMailAddress は注文者メールアドレスです。完全一致である必要があります。
	OrdererMailAddress *string `json:"ordererMailAddress,omitempty"`

	// PhoneNumberType は電話番号種別です。以下のいずれかを指定することができます。
	// 0: 注文者
	// 1: 送付先
	PhoneNumberType *int `json:"phoneNumberType,omitempty"`

	// PhoneNumber は電話番号です。完全一致である必要があります。
	PhoneNumber *string `json:"phoneNumber,omitempty"`

	// ReserveNumber は申込番号です。完全一致である必要があります。
	ReserveNumber *string `json:"reserveNumber,omitempty"`

	// PurchaseSiteType は購入サイトリストです。以下のいずれかを指定することがあります。
	// 0: すべて
	// 1: PCで注文
	// 2: モバイルで注文
	// 3: スマートフォンで注文
	// 4: タブレットで注文
	PurchaseSiteType *int `json:"purchaseSiteType,omitempty"`

	// AsurakuFlag はあす楽希望フラグです。以下のいずれかを指定することができます。
	// 0: あす楽希望の有無にかかわらず取得
	// 1: あす楽希望のものだけを取得
	AsurakuFlag *int `json:"asurakuFlag,omitempty"`

	// CouponUseFlag はクーポン利用有無フラグです。以下のいずれかを指定することができます。
	// 0: クーポン利用の有無にかかわらず取得
	// 1: クーポン利用のものだけを取得
	CouponUseFlag *int `json:"couponUseFlag,omitempty"`

	// DrugFlag は医薬品受注フラグです。以下のいずれかを指定することができます。
	// 0: 医薬品の有無にかかわらず取得
	// 1: 医薬品を含む注文だけを取得
	DrugFlag *int `json:"drugFlag,omitempty"`

	// OverseasFlag は海外カゴ注文フラグです。以下のいずれかを指定することができます。
	// 0: 海外カゴ注文の有無にかかわらず取得
	// 1: 海外カゴ注文のみ取得
	OverseasFlag *int `json:"overseasFlag,omitempty"`

	// SearchOrderPaginationRequestModel はページングに関する情報です。
	PaginationRequestModel `json:"PaginationRequestModel,omitempty"`
}

type SearchOrderResponse

type SearchOrderResponse struct {
	// CommonMessageModelResponseList はメッセージモデルリストです。ここにはエラー情報が含まれます。
	CommonMessageModelResponseList []types.CommonMessageModelResponse `json:"MessageModelList"`

	// OrderNumberList は注文番号リストです。該当する注文番号の一覧が取得できます。
	OrderNumberList []string `json:"orderNumberList"`

	// SearchOrderPaginationResponseModel はページングレスポンスモデルです。ページングに関する情報を取得することができます。
	PaginationResponseModel `json:"PaginationResponseModel"`
}

SearchOrderResponse は楽天ペイ受注APIの注文検索時に取得できるデータです。

type SenderModel

type SenderModel struct {
	// ZipCode1 は郵便番号1です。3桁の数値が入力されます。(0始まりがあるため文字列です。)
	ZipCode1 string `json:"zipCode1"`

	// ZipCode2 は郵便番号2です。4桁の数値が入力されます。(0始まりがあるため文字列です。)
	ZipCode2 string `json:"zipCode2"`

	// Prefecture は都道府県です。
	Prefecture string `json:"prefecture"`

	// City は郡市区です。
	City string `json:"city"`

	// SubAddress はCity以降の住所です。
	SubAddress string `json:"subAddress"`

	// FamilyName は姓です。
	FamilyName *string `json:"familyName,omitempty"`

	// FirstName は名です。
	FirstName *string `json:"firstName,omitempty"`

	// FamilyNameKana は姓カナです。
	FamilyNameKana *string `json:"familyNameKana,omitempty"`

	// FirstNameKana は名カナです。
	FirstNameKana *string `json:"firstNameKana,omitempty"`

	// PhoneNumber1 は電話番号1です。電話番号3までのうち1つだけnullの場合があります
	PhoneNumber1 *string `json:"phoneNumber1,omitempty"`

	// PhoneNumber2 は電話番号2です。電話番号3までのうち1つだけnullの場合があります
	PhoneNumber2 *string `json:"phoneNumber2,omitempty"`

	// PhoneNumber3 は電話番号3です。電話番号3までのうち1つだけnullの場合があります
	PhoneNumber3 *string `json:"phoneNumber3,omitempty"`

	// IsolatedIslandFlag は離島フラグです。APIのバージョンが2以降の場合取得可能です。以下のいずれかが入力されます。
	// 0: 離島ではない
	// 1: 離島である
	IsolatedIslandFlag int `json:"isolatedIslandFlag"`
}

type SettlementModel

type SettlementModel struct {
	// 1: クレジットカード
	// 2: 代金引換
	// 4: ショッピングクレジット／ローン
	// 5: オートローン
	// 6: リース
	// 7: 請求書払い
	// 8: ポイント
	// 9: 銀行振込
	// 12: Apple Pay
	// 13: セブンイレブン（前払）
	// 14: ローソン、郵便局ATM等（前払）
	// 16: Alipay
	// 17: PayPal
	// 21: 後払い決済
	// 27: Alipay（支付宝）
	SettlementMethodCode int `json:"settlementMethodCode"`
	// SettlementMethod は支払い方法名です。
	SettlementMethod string `json:"settlementMethod"`

	// RpaySettlementFlag は楽天市場の共通決済手段フラグです。APIのバージョンが2以降の場合取得することができます。以下のいずれかが含まれます。
	// 0: 選択制決済
	// 1: 楽天市場の共通決済手段
	RpaySettlementFlag int `json:"rpaySettlementFlag"`

	// CardName はクレジットカード種類です。SettlementMethod がクレジットカードの場合のみ値が入力されます。
	CardName *string `json:"cardName,omitempty"`

	// CardNumber はクレジットカード番号です。SettlementMethod がクレジットカードの場合のみ値が入力されます。
	CardNumber *string `json:"cardNumber,omitempty"`

	// CardOwner はクレジットカード名義人です。SettlementMethod がクレジットカードの場合のみ値が入力されます。
	CardOwner *string `json:"cardOwner,omitempty"`

	// CardYm はクレジットカード有効期限です。SettlementMethod がクレジットカードの場合のみ値が入力されます。
	CardYm *string `json:"cardYm,omitempty"`

	// CardPayType はクレジットカード支払い方法です。SettlementMethod がクレジットカードの場合のみ値が入力されます。以下のいずれかが入力されます。
	// 0: 一括払い
	// 1: リボ払い
	// 2: 分割払い
	// 3: その他払い
	// 4: ボーナス一括払い
	CardPayType *int `json:"cardPayType,omitempty"`

	// CardInstallmentDesc はクレジットカードの支払回数です。SettlementMethod がクレジットカードの場合かつ、CardPayType が分割払いの場合のみ値が入力されます。以下のいずれかが入力されます。
	// 103: 3回払い
	// 105: 5回払い
	// 106: 6回払い
	// 110: 10回払い
	// 112: 12回払い
	// 115: 15回払い
	// 118: 18回払い
	// 120: 20回払い
	// 124: 24回払い
	CardInstallmentDesc *string `json:"cardInstallmentDesc,omitempty"`
}

type ShippingModel

type ShippingModel struct {
	// ・Add shipping information when not specified.
	//・Update or delete shipping information when specified.
	ShippingDetailId *int64 `json:"shippingDetailId"`

	// 1000: Other
	// 1001: Yamato Transport Co., Ltd.
	// 1002: Sagawa Express Co.,Ltd.
	// 1003: Japan Post Co., Ltd.
	// 1004: Seino Transportation Co., Ltd.
	// 1005: Seino Super Express Co., Ltd.
	// 1006: Fukuyama Transporting Co.,Ltd.
	// 1007: Meitetsu Transportation Co., Ltd.
	// 1008: Tonami Transportation Co., Ltd.
	// 1009: Daiichi Freight System, Inc
	// 1010: Niigata Unyu Co., Ltd.
	// 1011: Chuetsu Transport Co.,Ltd.
	// 1012: Okayamaken Freight Transportation Co., Ltd.
	// 1013: KURUME-TRANS Co.,Ltd.
	// 1014: Sanyo Jidosha Unso Co.,Ltd.
	// 1015: NX TRANSPORT
	// 1016: Ecohai Co., Ltd.
	// 1017: EMS
	// 1018: DHL
	// 1019: FedEx
	// 1020: UPS (United States Postal Service)
	// 1021: Nippon Express Co., Ltd.
	// 1022: TNT
	// 1023: OCS
	// 1024: USPS
	// 1025: SF Express Co., Ltd.
	// 1026: Aramex
	// 1027: SGH Global Japan
	// 1028: Rakuten EXPRESS
	// *Note: In case parameter is not set: value won’t change.
	// *Note: In case parameter is set: value is mandatory.
	DeliveryCompany string `json:"deliveryCompany"`

	// ・Invalid characters such as machine-dependent characters are not allowed.
	// ・Up to 120 characters regardless of double-byte or single-byte.
	// *Note: In case parameter is not set: value won’t change.
	// *Note: In case parameter is set and value is not specified: the existing value will be deleted.
	ShippingNumber string `json:"shippingNumber"`
	// 	YYYY-MM-DD
	// *Note: In case parameter is not set: value won’t change.
	// *Note: In case parameter is set and value is not specified: the existing value will be deleted.
	ShippingDate string `json:"shippingDate"`

	// 0: Do not delete shipping information
	// 1: Delete shipping information
	ShippingDeleteFlag int `json:"shippingDeleteFlag"`
}

type SkuModel

type SkuModel struct {
	VariantId            string  `json:"variantId"`
	MerchantDefinedSkuId *string `json:"merchantDefinedSkuId,omitempty"`
	SkuInfo              *string `json:"skuInfo,omitempty"`
}

type SkuModelList

type SkuModelList []SkuModel

type SortKey

type SortKey string

const (
	UPDATED                  SortKey = "updated"
	CREATED                  SortKey = "created"
	ITEM_DISPLAY_SEQUENCE    SortKey = "itemDisplaySequence"
	MANAGE_NUMBER            SortKey = "manageNumber"
	PURCHASABLE_PERIOD_START SortKey = "purchasablePeriodStart"
	PURCHASABLE_PERIOD_END   SortKey = "purchasablePeriodEnd"
	POINT_CAMPAIGN_START     SortKey = "pointCampaignStart"
	POINT_CAMPAIGN_END       SortKey = "pointCampaignEnd"
	POINT_RATE               SortKey = "pointRate"
	REVIEW_COUNT             SortKey = "reviewCount"
	REVIEW_AVERAGE_RATING    SortKey = "reviewAverageRating"
)

type SortModel

type SortModel struct {
	// SortColumn は並び替え項目です。以下のいずれかを指定することができます。
	// 1: 注文日時
	SortColumn int `json:"sortColumn"`

	// SortDirection は並び替え方法です。以下のいずれかを指定することができます。
	// 1: 昇順
	// 2: 降順
	SortDirection int `json:"sortDirection"`
}

SearchOrderSortModel は楽天ペイ受注APIで注文検索の検索条件のうち、ソートに関する条件です。

type SortOrder

type SortOrder string

const (
	DESC SortOrder = "desc"
	ASC  SortOrder = "asc"
)

type TaxSummaryModel

type TaxSummaryModel struct {
	// TaxRate は税率です。
	TaxRate float64 `json:"taxRate"`

	// ReqPrice は請求金額です。計算式は商品金額 + 送料 + ラッピング料 + 決済手数料 + 注文者負担金 - クーポン割引額 - 利用ポイント数。
	// なお以下の場合、-9999となります。
	// ・送料未確定
	// ・代引手数料未確定
	ReqPrice int `json:"reqPrice"`

	// ReqPriceTax は請求額に対する税額です。請求金額に対する税額です。請求金額が-9999の場合、ReqPriceTaxは-9999となります。
	ReqPriceTax int `json:"reqPriceTax"`

	// TotalPrice は合計金額です。計算式は商品金額 + 送料 + ラッピング料です。送料が未確定の場合、-9999となります。
	TotalPrice int `json:"totalPrice"`

	// PaymentCharge は決済手数料です。代引手数料未確定の場合、-9999となります。
	PaymentCharge int `json:"paymentCharge"`

	// CouponPrice はクーポン割引額です。
	CouponPrice int `json:"couponPrice"`

	// Point は利用ポイント数です。
	Point int `json:"point"`
}

type TaxSummaryModelList

type TaxSummaryModelList []TaxSummaryModel

type UpdateOrderShippingConfig

type UpdateOrderShippingConfig struct {
	Auth     *types.AuthParameter
	ReqBody  *UpdateOrderShippingReqBody
	RespBody *UpdateOrderShippingRespBody
	ClientConfig
}

type UpdateOrderShippingReqBody

type UpdateOrderShippingReqBody struct {
	OrderNumber       string          `json:"orderNumber"`
	BasketidModelList []BasketIdModel `json:"BasketidModelList"`
}

type UpdateOrderShippingRespBody

type UpdateOrderShippingRespBody struct {
	MessageModelList []MessageModelList `json:"MessageModelList"`
}

type WrappingModel

type WrappingModel struct {
	// Title はラッピングタイトルです。次のいずれかが入力されます。
	// 1: 包装紙
	// 2: リボン
	Title int `json:"title"`

	// Name はラッピング名です。
	Name string `json:"name"`

	// Price は料金です。
	Price *int `json:"price"`

	// IncludeTaxFlag は税込み別です。次のいずれかが入力されます。
	// 0: 税別
	// 1: 税込
	IncludeTaxFlag int `json:"includeTaxFlag"`

	// DeleteWrappingFlag はラッピング削除フラグです。
	DeleteWrappingFlag int `json:"deleteWrappingFlag"`

	// TaxRate はラッピング税率です。APIのバージョンが3以降の場合取得可能です。
	TaxRate int `json:"taxRate"`

	// TaxPriceはラッピング税額です。APIのバージョンが3以降の場合取得可能です。
	TaxPrice int `json:"taxPrice"`
}