ozon-api-client/ozon/fbs.go

package ozon

import (
	"net/http"
	"time"

	core "github.com/diphantxm/ozon-api-client"
)

type FBS struct {
	client *core.Client
}

type ListUnprocessedShipmentsParams struct {
	Direction string                         `json:"dir"`
	Filter    ListUnprocessedShipmentsFilter `json:"filter"`
	Limit     int64                          `json:"limit"`
	Offset    int64                          `json:"offset"`
	With      ListUnprocessedShipmentsWith   `json:"with"`
}

type ListUnprocessedShipmentsFilter struct {
	CutoffFrom         time.Time `json:"cutoff_from"`
	CutoffTo           time.Time `json:"cutoff_to"`
	DeliveringDateFrom time.Time `json:"delivering_date_from"`
	DeliveringDateTo   time.Time `json:"delivering_date_to"`
	DeliveryMethodId   []int64   `json:"deliveryMethodId"`
	ProviderId         []int64   `json:"provider_id"`
	Status             string    `json:"status"`
	WarehouseId        []int64   `json:"warehouse_id"`
}

type ListUnprocessedShipmentsWith struct {
	AnalyticsData bool `json:"analytics_data"`
	Barcodes      bool `json:"barcodes"`
	FinancialData bool `json:"financial_data"`
	Translit      bool `json:"translit"`
}

type ListUnprocessedShipmentsResponse struct {
	core.CommonResponse

	Result ListUnprocessedShipmentsResult `json:"result"`
}

type ListUnprocessedShipmentsResult struct {
	Count    int64        `json:"count"`
	Postings []FBSPosting `json:"postings"`
}

type FBSPosting struct {
	Addressee struct {
		Name  string `json:"name"`
		Phone string `json:"phone"`
	} `json:"addressee"`

	AnalyticsData struct {
		City                 string    `json:"city"`
		DeliveryDateBegin    time.Time `json:"delivery_date_begin"`
		DeliveryDateEnd      time.Time `json:"delivery_date_end"`
		DeliveryType         string    `json:"delivery_type"`
		IsLegal              bool      `json:"is_legal"`
		IsPremium            bool      `json:"is_premium"`
		PaymentTypeGroupName string    `json:"payment_type_group_name"`
		Region               string    `json:"region"`
		TPLProvider          string    `json:"tpl_provider"`
		TPLProviderId        int64     `json:"tpl_provider_id"`
		Warehouse            string    `json:"warehouse"`
		WarehouseId          int64     `json:"warehouse_id"`
	} `json:"analytics_data"`

	Barcodes FBSBarcode `json:"barcodes"`

	Cancellation FBSCancellation `json:"cancellation"`

	Customer FBSCustomer `json:"customer"`

	DeliveringDate time.Time `json:"delivering_date"`

	DeliveryMethod FBSDeliveryMethod `json:"delivery_method"`

	FinancialData FBSFinancialData `json:"financial_data"`

	InProccessAt        time.Time `json:"in_process_at"`
	IsExpress           bool      `json:"is_express"`
	IsMultibox          bool      `json:"is_multibox"`
	MultiBoxQuantity    int32     `json:"multi_box_qty"`
	OrderId             int64     `json:"order_id"`
	OrderNumber         string    `json:"order_number"`
	ParentPostingNumber string    `json:"parent_posting_number"`
	PostingNumber       string    `json:"posting_number"`

	Products []PostingProduct `json:"products"`

	Requirements FBSRequirements `json:"requirements"`

	ShipmentDate       time.Time `json:"shipment_date"`
	Status             string    `json:"status"`
	TPLIntegrationType string    `json:"tpl_integration_type"`
	TrackingNumber     string    `json:"tracking_number"`
}

type FBSBarcode struct {
	LowerBarcode string `json:"lower_barcode"`
	UpperBarcode string `json:"upper_barcode"`
}

type FBSCancellation struct {
	AffectCancellationRating bool   `json:"affect_cancellation_rating"`
	CancelReason             string `json:"cancel_reason"`
	CancelReasonId           int64  `json:"cancel_reason_id"`
	CancellationInitiator    string `json:"cancellation_initiator"`
	CancellationType         string `json:"cancellation_type"`
	CancelledAfterShip       bool   `json:"cancelled_after_ship"`
}

type FBSDeliveryMethod struct {
	Id            int64  `json:"id"`
	Name          string `json:"name"`
	TPLProvider   string `json:"tpl_provider"`
	TPLProviderId int64  `json:"tpl_provider_id"`
	Warehouse     string `json:"warehouse"`
	WarehouseId   int64  `json:"warehouse_id"`
}

type FBSFinancialData struct {
	ClusterFrom     string                 `json:"cluster_from"`
	ClusterTo       string                 `json:"cluster_to"`
	PostingServices MarketplaceServices    `json:"posting_services"`
	Products        []FinancialDataProduct `json:"products"`
}

type FBSRequirements struct {
	ProductsRequiringGTD           []string `json:"products_requiring_gtd"`
	ProductsRequiringCountry       []string `json:"products_requiring_country"`
	ProductsRequiringMandatoryMark []string `json:"products_requiring_mandatory_mark"`
	ProductsRequiringRNPT          []string `json:"products_requiring_rnpt"`
}

type PostingProduct struct {
	MandatoryMark []string `json:"mandatory_mark"`
	Name          string   `json:"name"`
	OfferId       string   `json:"offer_id"`
	CurrencyCode  string   `json:"currency_code"`
	Price         string   `json:"price"`
	Quantity      int32    `json:"quantity"`
	SKU           int64    `json:"sku"`
}

type FBSCustomer struct {
	Address struct {
		AddressTail     string  `json:"address_tail"`
		City            string  `json:"city"`
		Comment         string  `json:"comment"`
		Country         string  `json:"country"`
		District        string  `json:"district"`
		Latitude        float64 `json:"latitude"`
		Longitude       float64 `json:"longitude"`
		ProviderPVZCode string  `json:"provider_pvz_code"`
		PVZCode         int64   `json:"pvz_code"`
		Region          string  `json:"region"`
		ZIPCode         string  `json:"zip_code"`
	} `json:"customer"`

	CustomerEmail string `json:"customer_email"`
	CustomerId    int64  `json:"customer_id"`
	Name          string `json:"name"`
	Phone         string `json:"phone"`
}

type MarketplaceServices struct {
	DeliveryToCustomer            float64 `json:"marketplace_service_item_deliv_to_customer"`
	DirectFlowTrans               float64 `json:"marketplace_service_item_direct_flow_trans"`
	DropoffFF                     float64 `json:"marketplace_service_item_item_dropoff_ff"`
	DropoffPVZ                    float64 `json:"marketplace_service_item_dropoff_pvz"`
	DropoffSC                     float64 `json:"marketplace_service_item_dropoff_sc"`
	Fulfillment                   float64 `json:"marketplace_service_item_fulfillment"`
	Pickup                        float64 `json:"marketplace_service_item_pickup"`
	ReturnAfterDeliveryToCustomer float64 `json:"marketplace_service_item_return_after_deliv_to_customer"`
	ReturnFlowTrans               float64 `json:"marketplace_service_item_return_flow_trans"`
	ReturnNotDeliveryToCustomer   float64 `json:"marketplace_service_item_return_not_deliv_to_customer"`
	ReturnPartGoodsCustomer       float64 `json:"marketplace_service_item_return_part_goods_customer"`
}

type FinancialDataProduct struct {
	Actions                 []string            `json:"actions"`
	ClientPrice             string              `json:"client_price"`
	CommissionAmount        float64             `json:"commission_amount"`
	CommissionPercent       int64               `json:"commission_percent"`
	CommissionsCurrencyCode string              `json:"commissions_currency_code"`
	ItemServices            MarketplaceServices `json:"item_services"`
	CurrencyCode            string              `json:"currency_code"`
	OldPrice                float64             `json:"old_price"`
	Payout                  float64             `json:"payout"`
	Picking                 struct {
		Amount float64   `json:"amount"`
		Moment time.Time `json:"moment"`
		Tag    string    `json:"tag"`
	} `json:"picking"`
	Price                float64 `json:"price"`
	ProductId            int64   `json:"product_id"`
	Quantity             int64   `json:"quantity"`
	TotalDiscountPercent float64 `json:"total_discount_percent"`
	TotalDiscountValue   float64 `json:"total_discount_value"`
}

func (c FBS) ListUnprocessedShipments(params *ListUnprocessedShipmentsParams) (*ListUnprocessedShipmentsResponse, error) {
	url := "/v3/posting/fbs/unfulfilled/list"

	resp := &ListUnprocessedShipmentsResponse{}

	response, err := c.client.Request(http.MethodPost, url, params, resp)
	if err != nil {
		return nil, err
	}
	response.CopyCommonResponse(&resp.CommonResponse)

	return resp, nil
}

type GetFBSShipmentsListParams struct {
	// Sorting direction
	Direction string `json:"direction"`

	//Filter
	Filter GetFBSShipmentsListFilter `json:"filter"`

	// Number of shipments in the response:
	//   - maximum is 50,
	//   - minimum is 1.
	Limit int64 `json:"limit"`

	// Number of elements that will be skipped in the response. For example, if offset=10, the response will start with the 11th element found
	Offset int64 `json:"offset"`

	// Additional fields that should be added to the response
	With GetFBSShipmentsListWith `json:"with"`
}

type GetFBSShipmentsListFilter struct {
	// Delivery method identifier
	DeliveryMethodId []int64 `json:"delivery_method_id"`

	// Order identifier
	OrderId int64 `json:"order_id"`

	// Delivery service identifier
	ProviderId []int64 `json:"provider_id"`

	// Start date of the period for which a list of shipments should be generated.
	//
	// Format: YYYYY-MM-DDTHH:MM:SSZ.
	//
	// Example: 2019-08-24T14:15:22Z
	Since time.Time `json:"since"`

	// End date of the period for which a list of shipments should be generated.
	//
	// Format: YYYYY-MM-DDTHH:MM:SSZ.
	//
	// Example: 2019-08-24T14:15:22Z.
	To time.Time `json:"to"`

	// Shipment status
	Status string `json:"status"`

	// Warehouse identifier
	WarehouseId []int64 `json:"warehouse_id"`
}

type GetFBSShipmentsListWith struct {
	// Add analytics data to the response
	AnalyticsData bool `json:"analytics_data"`

	// Add the shipment barcodes to the response
	Barcodes bool `json:"barcodes"`

	// Add financial data to the response
	FinancialData bool `json:"financial_data"`

	// Transliterate the return values
	Translit bool `json:"translit"`
}

type GetFBSShipmentsListResponse struct {
	core.CommonResponse

	// Array of shipments
	Result struct {
		// Indicates that the response returned not the entire array of shipments:
		//
		//   - true — it is necessary to make a new request with a different offset value to get information on the remaining shipments;
		//   - false — the entire array of shipments for the filter specified in the request was returned in the response
		HasNext bool `json:"has_next"`

		// Shipment details
		Postings []FBSPosting `json:"postings"`
	} `json:"result"`
}

// Returns a list of shipments for the specified time period: it shouldn't be longer than one year.
//
// You can filter shipments by their status. The list of available statuses is specified in the description of the filter.status parameter.
//
// The true value of the has_next parameter in the response means there is not the entire array of shipments in the response. To get information on the remaining shipments, make a new request with a different offset value.
func (c FBS) GetFBSShipmentsList(params *GetFBSShipmentsListParams) (*GetFBSShipmentsListResponse, error) {
	url := "/v3/posting/fbs/list"

	resp := &GetFBSShipmentsListResponse{}

	response, err := c.client.Request(http.MethodPost, url, params, resp)
	if err != nil {
		return nil, err
	}
	response.CopyCommonResponse(&resp.CommonResponse)

	return resp, nil
}

type PackOrderParams struct {
	// List of packages. Each package contains a list of shipments that the order was divided into
	Packages []PackOrderPackage `json:"packages"`

	// Shipment number
	PostingNumber string `json:"posting_number"`

	// Additional information
	With PackOrderWith `json:"with"`
}

type PackOrderPackage struct {
	Products []PackOrderPackageProduct `json:"products"`
}

type PackOrderPackageProduct struct {
	// Product identifier
	ProductId int64 `json:"product_id"`

	// Product items quantity
	Quantity int32 `json:"quantity"`
}

type PackOrderWith struct {
	// Pass true to get additional information
	AdditionalData bool `json:"additional_data"`
}

type PackOrderResponse struct {
	core.CommonResponse

	// Additional information about shipments
	AdditionalData []struct {
		// Shipment number
		PostingNumber string `json:"posting_number"`

		// List of products in the shipment
		Products []PostingProduct `json:"products"`
	} `json:"additional_data"`

	// Order packaging result
	Result []string `json:"result"`
}

// Divides the order into shipments and changes its status to awaiting_deliver.
//
// Each element of the packages may contain several instances of the products. One instance of the products is one shipment. Each element of the products is a product included into the shipment.
//
// It is necessary to split the order if:
//
// the products do not fit in one package,
// the products cannot be put in one package.
// Differs from /v2/posting/fbs/ship by the presence of the field exemplar_info in the request.
//
// If necessary, specify the number of the cargo customs declaration in the gtd parameter. If it is missing, pass the value is_gtd_absent = true
func (c FBS) PackOrder(params *PackOrderParams) (*PackOrderResponse, error) {
	url := "/v4/posting/fbs/ship"

	resp := &PackOrderResponse{}

	response, err := c.client.Request(http.MethodPost, url, params, resp)
	if err != nil {
		return nil, err
	}
	response.CopyCommonResponse(&resp.CommonResponse)

	return resp, nil
}

type ValidateLabelingCodesParams struct {
	// Shipment number
	PostingNumber string `json:"posting_number"`

	// Products list
	Products []ValidateLabelingCodesProduct `json:"products"`
}

type ValidateLabelingCodesProduct struct {
	// Product items data
	Exemplars []ValidateLabelingCodesExemplar `json:"exemplars"`

	// Product identifier
	ProductId int64 `json:"product_id"`
}

type ValidateLabelingCodesExemplar struct {
	// Сustoms cargo declaration (CCD) number
	GTD string `json:"gtd"`

	// Mandatory “Chestny ZNAK” labeling
	MandatoryMark string `json:"mandatory_mark"`

	// Product batch registration number
	RNPT string `json:"rnpt"`
}

type ValidateLabelingCodesResponse struct {
	core.CommonResponse

	// Method result
	Result struct {
		// Products list
		Products []struct {
			// Error code
			Error string `json:"error"`

			// Product items data
			Exemplars []struct {
				// Product item validation errors
				Errors []string `json:"errors"`

				// Сustoms cargo declaration (CCD) number
				GTD string `json:"gtd"`

				// Mandatory “Chestny ZNAK” labeling
				MandatoryMark string `json:"mandatory_mark"`

				// Check result. true if the labeling code of product item meets the requirements
				Valid bool `json:"valid"`

				// Product batch registration number
				RNPT string `json:"rnpt"`
			} `json:"exemplars"`

			// Product identifier
			ProductId int64 `json:"product_id"`

			// Check result. true if the labeling codes of all product items meet the requirements
			Valid bool `json:"valid"`
		} `json:"products"`
	} `json:"result"`
}

// Method for checking whether labeling codes meet the "Chestny ZNAK" system requirements on length and symbols.
//
// If you don't have the customs cargo declaration (CCD) number, you don't have to specify it
func (c FBS) ValidateLabelingCodes(params *ValidateLabelingCodesParams) (*ValidateLabelingCodesResponse, error) {
	url := "/v4/fbs/posting/product/exemplar/validate"

	resp := &ValidateLabelingCodesResponse{}

	response, err := c.client.Request(http.MethodPost, url, params, resp)
	if err != nil {
		return nil, err
	}
	response.CopyCommonResponse(&resp.CommonResponse)

	return resp, nil
}

type GetShipmentDataByBarcodeParams struct {
	// Shipment barcode
	Barcode string `json:"barcode"`
}

type GetShipmentDataByBarcodeResponse struct {
	core.CommonResponse

	// Method result
	Result struct {
		// Analytical data
		AnalyticsData struct {
			// Delivery city
			City string `json:"city"`

			// Delivery method
			DeliveryType string `json:"delivery_type"`

			// Indication that the recipient is a legal entity:
			//   - true — a legal entity
			//   - false — a natural person
			IsLegal bool `json:"is_legal"`

			// Premium subscription availability
			IsPremium bool `json:"is_premium"`

			// Payment method
			PaymentTypeGroupName string `json:"payment_type_group_name"`

			// Delivery region
			Region string `json:"region"`
		} `json:"analytics_data"`

		// Shipment barcodes
		Barcodes FBSBarcode `json:"barcodes"`

		// Cancellation reason identifier
		CancelReasonId int64 `json:"cancel_reason_id"`

		// Date and time when the shipment was created
		CreatedAt time.Time `json:"created_at"`

		// Financial data
		FinancialData struct {
			// Identifier of the cluster, where the shipment is sent from
			ClusterFrom string `json:"cluster_from"`

			// Identifier of the cluster, where the shipment is delivered to
			ClusterTo string `json:"cluster_to"`

			// Services
			PostingServices []MarketplaceServices `json:"posting_services"`

			// Products list
			Products []FinancialDataProduct `json:"products"`
		} `json:"financial_data"`

		// Start date and time of shipment processing
		InProcessAt time.Time `json:"in_process_at"`

		// Order identifier to which the shipment belongs
		OrderId int64 `json:"order_id"`

		// Order number to which the shipment belongs
		OrderNumber string `json:"order_number"`

		// Shipment number
		PostingNumber string `json:"posting_number"`

		// List of products in the shipment
		Products []PostingProduct `json:"products"`

		// Date and time before which the shipment must be packaged.
		// If the shipment is not packaged by this date, it will be canceled automatically
		ShipmentDate time.Time `json:"shipment_date"`

		// Shipment status
		Status string `json:"status"`
	} `json:"result"`
}

// Method for getting shipments data by barcode
func (c FBS) GetShipmentDataByBarcode(params *GetShipmentDataByBarcodeParams) (*GetShipmentDataByBarcodeResponse, error) {
	url := "/v2/posting/fbs/get-by-barcode"

	resp := &GetShipmentDataByBarcodeResponse{}

	response, err := c.client.Request(http.MethodPost, url, params, resp)
	if err != nil {
		return nil, err
	}
	response.CopyCommonResponse(&resp.CommonResponse)

	return resp, nil
}

type GetShipmentDataByIdentifierParams struct {
	// Shipment identifier
	PostingNumber string `json:"posting_number"`

	// Additional fields that should be added to the response
	With GetShipmentDataByIdentifierWith `json:"with"`
}

type GetShipmentDataByIdentifierWith struct {
	// Add analytics data to the response
	AnalyticsData bool `json:"analytics_data"`

	// Add the shipment barcodes to the response
	Barcodes bool `json:"barcodes"`

	// Add financial data to the response
	FinancialData bool `json:"financial_data"`

	// Add data on products and their instances to the response
	ProductExemplars bool `json:"product_exemplars"`

	// Add related shipment numbers to the response.
	// Related shipments are ones into which the parent shipment was split during packaging
	RelatedPostings bool `json:"related_postings"`

	// Transliterate the return values
	Translit bool `json:"translit"`
}

type GetShipmentDataByIdentifierResponse struct {
	core.CommonResponse

	// Method result
	Result struct {
		// Additional Data Key-Value
		AdditionalData []struct {
			// Key
			Key string `json:"key"`

			// value
			Value string `json:"value"`
		} `json:"additional_data"`

		// Recipient details
		Addressee struct {
			// Recipient name
			Name string `json:"name"`

			// Recipient phone number
			Phone string `json:"phone"`
		} `json:"addressee"`

		// Analytics data
		AnalyticsData struct {
			// Delivery city
			City string `json:"city"`

			// Delivery start date and time
			DeliveryDateBegin time.Time `json:"delivery_date_begin"`

			// Delivery end date and time
			DeliveryDateEnd time.Time `json:"delivery_date_end"`

			// Delivery method
			DeliveryType string `json:"delivery_type"`

			// Indication that the recipient is a legal entity:
			//   - true — a legal entity,
			//   - false — a natural person
			IsLegal bool `json:"is_legal"`

			// Premium subscription availability
			IsPremium bool `json:"is_premium"`

			// Payment method
			PaymentTypeGroupName string `json:"payment_type_group_name"`

			// Delivery region
			Region string `json:"region"`

			// Delivery service
			TPLProvider string `json:"tpl_provider"`

			// Delivery service identifier
			TPLProviderId int64 `json:"tpl_provider_id"`

			// Order shipping warehouse name
			Warehouse string `json:"warehouse"`

			// Warehouse identifier
			WarehouseId int64 `json:"warehouse_id"`
		} `json:"analytics_data"`

		// Shipment barcodes
		Barcodes FBSBarcode `json:"barcodes"`

		// Cancellation details
		Cancellation FBSCancellation `json:"calcellation"`

		// Courier information
		Courier struct {
			// Car model
			CarModel string `json:"car_model"`

			// Car number
			CarNumber string `json:"car_number"`

			// Courier's full name
			Name string `json:"name"`

			// Courier's phone number
			Phone string `json:"phone"`
		} `json:"courier"`

		// Customer details
		Customer FBSCustomer `json:"customer"`

		// Date when the shipment was transferred for delivery
		DeliveringDate time.Time `json:"delivering_date"`

		// Delivery method
		DeliveryMethod FBSDeliveryMethod `json:"delivery_method"`

		// Delivery cost
		DeliveryPrice string `json:"delivery_type"`

		// Data on the product cost, discount amount, payout and commission
		FinancialData FBSFinancialData `json:"financial_date"`

		// Start date and time of shipment processing
		InProcessAt time.Time `json:"in_process_at"`

		// If Ozon Express fast delivery was used—true
		IsExpress bool `json:"is_express"`

		// Indication that there is a multi-box product in the shipment and you need to pass the number of boxes for it:
		//   - true — before packaging pass the number of boxes using the /v3/posting/multiboxqty/set method.
		//   - false — you packed the shipment specifying the number of boxes in the multi_box_qty parameter, or there is no multi-box product in the shipment
		IsMultibox bool `json:"is_multibox"`

		// Number of boxes in which the product is packed
		MultiBoxQuantity int32 `json:"multi_box_qty"`

		// Order identifier to which the shipment belongs
		OrderId int64 `json:"order_id"`

		// Order number to which the shipment belongs
		OrderNumber string `json:"order_number"`

		// Number of the parent shipment which split resulted in the current shipment
		ParentPostingNumber string `json:"parent_posting_number"`

		// Shipment number
		PostingNumber string `json:"posting_number"`

		// Information on products and their instances.
		//
		// The response contains the field product_exemplars, if the attribute with.product_exemplars = true is passed in the request
		ProductExemplars struct {
			// Products
			Products []struct {
				// Product identifier in the Ozon system, SKU
				SKU int64 `json:"sku"`

				// Array of exemplars
				Exemplars []FBSProductExemplar `json:"exemplars"`
			} `json:"products"`
		} `json:"product_exemplars"`

		// Array of products in the shipment
		Products []struct {
			PostingProduct

			// Product dimensions
			Dimensions struct {
				// Package height
				Height string `json:"height"`

				// Product length
				Length string `json:"length"`

				// Weight of product in the package
				Weight string `json:"weight"`

				// Package width
				Width string `json:"width"`
			} `json:"dimensions"`
		} `json:"products"`

		// Delivery service status
		ProviderStatus string `json:"provider_status"`

		// Related shipments
		RelatedPostings struct {
			RelatedPostingNumbers []string `json:"related_posting_numbers"`
		} `json:"related_postings"`

		// Array of Ozon Product IDs (SKU) for which you need to pass the customs cargo declaration (CCD) number, the manufacturing country,
		// product batch registration number, or "Chestny ZNAK" labeling to change the shipment status to the next one
		Requirements FBSRequirements `json:"requirements"`

		// Date and time before which the shipment must be packaged.
		// If the shipment is not packaged by this date, it will be canceled automatically
		ShipmentDate time.Time `json:"shipment_date"`

		// Shipment status
		Status string `json:"status"`

		// Type of integration with the delivery service:
		//   - ozon — delivery by the Ozon logistics.
		//   - aggregator — delivery by a third-party service, Ozon registers the order.
		//   - 3pl_tracking — delivery by a third-party service, the seller registers the order.
		//   - non_integrated — delivery by the seller
		TPLIntegrationType string `json:"tpl_integration_type"`

		// Shipment tracking number
		TrackingNumber string `json:"tracking_number"`
	} `json:"result"`
}

type FBSProductExemplar struct {
	// Mandatory “Chestny ZNAK” labeling
	MandatoryMark string `json:"mandatory_mark"`

	// Сustoms cargo declaration (CCD) number
	GTD string `json:"gtd"`

	// Indication that a сustoms cargo declaration (CCD) number hasn't been specified
	IsGTDAbsest bool `json:"is_gtd_absent"`

	// Product batch registration number
	RNPT string `json:"rnpt"`

	// Indication that a product batch registration number hasn't been specified
	IsRNPTAbsent bool `json:"is_rnpt_absent"`
}

// Method for getting shipment details by identifier
func (c FBS) GetShipmentDataByIdentifier(params *GetShipmentDataByIdentifierParams) (*GetShipmentDataByIdentifierResponse, error) {
	url := "/v3/posting/fbs/get"

	resp := &GetShipmentDataByIdentifierResponse{}

	response, err := c.client.Request(http.MethodPost, url, params, resp)
	if err != nil {
		return nil, err
	}
	response.CopyCommonResponse(&resp.CommonResponse)

	return resp, nil
}

type AddTrackingNumbersParams struct {
	// An array with shipment identifier—tracking number pairs
	TrackingNumbers []FBSTrackingNumbersParams `json:"tracking_numbers"`
}

type FBSTrackingNumbersParams struct {
	// Shipment identifier
	PostingNumber string `json:"posting_number"`

	// Shipment tracking number
	TrackingNumber string `json:"tracking_number"`
}

type AddTrackingNumbersResponse struct {
	core.CommonResponse

	// Method result
	Result []struct {
		// Error when processing the request
		Error []string `json:"error"`

		// Shipment number
		PostingNumber string `json:"posting_number"`

		// If the request is executed without errors — true
		Result bool `json:"result"`
	} `json:"result"`
}

// Add tracking numbers to shipments
func (c FBS) AddTrackingNumbers(params *AddTrackingNumbersParams) (*AddTrackingNumbersResponse, error) {
	url := "/v2/fbs/posting/tracking-number/set"

	resp := &AddTrackingNumbersResponse{}

	response, err := c.client.Request(http.MethodPost, url, params, resp)
	if err != nil {
		return nil, err
	}
	response.CopyCommonResponse(&resp.CommonResponse)

	return resp, nil
}

type ListOfShipmentCertificatesParams struct {
	// Filter parameters
	Filter ListOfShipmentCertificates `json:"filter"`

	// Maximum number of certificates in the response
	Limit int64 `json:"limit"`
}

type ListOfShipmentCertificates struct {
	// Initial date of shipment creation
	DateFrom string `json:"date_from"`

	// Final date of shipment creation
	DateTo string `json:"date_to"`

	// Type of integration with the delivery service:
	//   - ozon — delivery by the Ozon service,
	//   - 3pl_tracking — delivery by the integrated service,
	//   - non_integrated — delivery by a third-party service,
	//   - aggregator — delivery by Ozon partner delivery
	IntegrationType string `json:"integration_type"`

	// Freight statuses
	Status []string `json:"status"`
}

type ListOfShipmentCertificatesResponse struct {
	core.CommonResponse

	// Request result
	Result []struct {
		// Shipment identifier
		Id int64 `json:"id"`

		// Delivery method identifier
		DeliveryMethodId int64 `json:"delivery_method_id"`

		// Delivery method name
		DeliveryMethodName string `json:"delivery_method_name"`

		// Type of integration with the delivery service:
		//   - ozon — delivery by the Ozon service,
		//   - 3pl — delivery by the integrated service
		IntegrationType string `json:"integration_type"`

		// Number of package units
		ContainersCount int32 `json:"container_count"`

		// Shipping status
		Status string `json:"status"`

		// Shipping date
		DepartureDate string `json:"departure_date"`

		// Shipping record creation date
		CreatedAt time.Time `json:"created_at"`

		// Shipping record update date
		UpdatedAt time.Time `json:"updated_at"`

		// Acceptance certificate type for FBS sellers
		ActType string `json:"act_type"`

		// Indication of a partial freight. true if the freigth is partial.
		//
		// Partial freigt means that the shipment was splitted into several parts
		// and for each of them you need to generate separate acts
		IsPartial bool `json:"is_partial"`

		// Indication that there are shipments subject to shipping that are not in the current freight.
		// true if there are such shipments
		HasPostingsForNextCarriage bool `json:"has_postings_for_next_carriage"`

		// Serial number of the partial freight
		PartialNum int64 `json:"partial_num"`

		// Information about shipment certificates
		RelatedDocs struct {
			// Information about acceptance certificate
			ActOfAcceptance FBSAct `json:"act_of_acceptance"`

			// Information about discrepancy certificate
			ActOfMismatch FBSAct `json:"act_of_mismatch"`

			// Information about surplus certificate
			ActOfExcess FBSAct `json:"act_of_excess"`
		} `json:"related_docs"`
	} `json:"result"`
}

type FBSAct struct {
	// Certificate creation date
	CreatedAt time.Time `json:"created_at"`

	// Certificate status:
	//   - FORMING — not ready yet
	//   - FORMED — formed
	//   - CONFIRMED — signed by Ozon
	//   - CONFIRMED_WITH_MISMATCH — signed with discrepancies by Ozon
	//   - ACCEPTED_BY_CARGO_PLACES — accepted by package units
	//   - PRINTED_CARRIAGE — digital signature not required
	//   - ERROR, UNKNOWN_ERROR — error
	DocumentStatus string `json:"document_status"`
}

// Returns a list of shipment certificates allowing to filter them by time period, status, and integration type
func (c FBS) ListOfShipmentCertificates(params *ListOfShipmentCertificatesParams) (*ListOfShipmentCertificatesResponse, error) {
	url := "/v2/posting/fbs/act/list"

	resp := &ListOfShipmentCertificatesResponse{}

	response, err := c.client.Request(http.MethodPost, url, params, resp)
	if err != nil {
		return nil, err
	}
	response.CopyCommonResponse(&resp.CommonResponse)

	return resp, nil
}

type SignShipmentCertificateParams struct {
	// Certificate identifier
	Id int64 `json:"id"`

	// Type of shipment certificate:
	//   - act_of_mismatch — discrepancy certificate,
	//   - act_of_excess — surplus certificate
	DocType string `json:"doc_type"`
}

type SignShipmentCertificateResponse struct {
	core.CommonResponse

	// Request processing
	Result string `json:"result"`
}

// Signs shipment certificates electronically via the electronic documents (ED) system of Ozon logistics
func (c FBS) SignShipmentCertificate(params *SignShipmentCertificateParams) (*SignShipmentCertificateResponse, error) {
	url := "/v2/posting/fbs/digital/act/document-sign"

	resp := &SignShipmentCertificateResponse{}

	response, err := c.client.Request(http.MethodPost, url, params, resp)
	if err != nil {
		return nil, err
	}
	response.CopyCommonResponse(&resp.CommonResponse)

	return resp, nil
}

type ChangeStatusToParams struct {
	// Shipment identifier
	PostingNumber []string `json:"posting_number"`
}

type ChangeStatusToResponse struct {
	core.CommonResponse

	// Method result
	Result []struct {
		// Error when processing the request
		Error []string `json:"error"`

		// Shipment number
		PostingNumber string `json:"posting_number"`

		// If the request is executed without errors — true
		Result bool `json:"result"`
	} `json:"result"`
}

// Changes the shipment status to "Delivering" if a third-party delivery service is being used
func (c FBS) ChangeStatusToDelivering(params *ChangeStatusToParams) (*ChangeStatusToResponse, error) {
	url := "/v2/fbs/posting/delivering"

	resp := &ChangeStatusToResponse{}

	response, err := c.client.Request(http.MethodPost, url, params, resp)
	if err != nil {
		return nil, err
	}
	response.CopyCommonResponse(&resp.CommonResponse)

	return resp, nil
}

// Changes the shipment status to "Last mile" if a third-party delivery service is being used
func (c FBS) ChangeStatusToLastMile(params *ChangeStatusToParams) (*ChangeStatusToResponse, error) {
	url := "/v2/fbs/posting/last-mile"

	resp := &ChangeStatusToResponse{}

	response, err := c.client.Request(http.MethodPost, url, params, resp)
	if err != nil {
		return nil, err
	}
	response.CopyCommonResponse(&resp.CommonResponse)

	return resp, nil
}

// Changes the shipment status to "Delivered" if a third-party delivery service is being used
func (c FBS) ChangeStatusToDelivered(params *ChangeStatusToParams) (*ChangeStatusToResponse, error) {
	url := "/v2/fbs/posting/delivered"

	resp := &ChangeStatusToResponse{}

	response, err := c.client.Request(http.MethodPost, url, params, resp)
	if err != nil {
		return nil, err
	}
	response.CopyCommonResponse(&resp.CommonResponse)

	return resp, nil
}

// Change shipment status to "Sent by seller". Status is only available to sellers with a first mile selling from abroad
func (c FBS) ChangeStatusToSendBySeller(params *ChangeStatusToParams) (*ChangeStatusToResponse, error) {
	url := "/v2/fbs/posting/sent-by-seller"

	resp := &ChangeStatusToResponse{}

	response, err := c.client.Request(http.MethodPost, url, params, resp)
	if err != nil {
		return nil, err
	}
	response.CopyCommonResponse(&resp.CommonResponse)

	return resp, nil
}

type PassShipmentToShippingParams struct {
	// Shipment identifier
	PostingNumber []string `json:"posting_number"`
}

type PassShipmentToShippingResponse struct {
	core.CommonResponse

	// Request processing result. true, if the request was executed without errors
	Result bool `json:"result"`
}

// Transfers disputed orders to shipping. The shipment status will change to `awaiting_deliver`
func (c FBS) PassShipmentToShipping(params *PassShipmentToShippingParams) (*PassShipmentToShippingResponse, error) {
	url := "/v2/posting/fbs/awaiting-delivery"

	resp := &PassShipmentToShippingResponse{}

	response, err := c.client.Request(http.MethodPost, url, params, resp)
	if err != nil {
		return nil, err
	}
	response.CopyCommonResponse(&resp.CommonResponse)

	return resp, nil
}

type CancelShipmentParams struct {
	// Shipment cancellation reason identifier
	CancelReasonId int64 `json:"cancel_reason_id"`

	// Additional information on cancellation. If `cancel_reason_id` = 402, the parameter is required
	CancelReasonMessage string `json:"cancel_reason_message"`

	// Shipment identifier
	PostingNumber string `json:"posting_number"`
}

type CancelShipmentResponse struct {
	core.CommonResponse

	// Request processing result. true, if the request was executed without errors
	Result bool `json:"result"`
}

// Change shipment status to cancelled.
//
// If you are using the rFBS scheme, you have the following cancellation reason identifiers (cancel_reason_id) available:
//   - 352 — product is out of stock;
//   - 400 — only defective products left;
//   - 401 — cancellation from arbitration;
//   - 402 — other reason;
//   - 665 — the customer did not pick the order;
//   - 666 — delivery is not available in the region;
//   - 667 — order was lost by the delivery service.
// For presumably delivered orders only the last 3 reasons are available.
//
// If cancel_reason_id parameter value is 402, fill the cancel_reason_message field
func (c FBS) CancelShipment(params *CancelShipmentParams) (*CancelShipmentResponse, error) {
	url := "/v2/posting/fbs/cancel"

	resp := &CancelShipmentResponse{}

	response, err := c.client.Request(http.MethodPost, url, params, resp)
	if err != nil {
		return nil, err
	}
	response.CopyCommonResponse(&resp.CommonResponse)

	return resp, nil
}

type CreateActParams struct {
	// Number of package units.
	//
	// Use this parameter if you have trusted acceptance enabled and ship orders by package units.
	// If you do not have trusted acceptance enabled, skip it
	ContainersCount int32 `json:"containers_count"`

	// Delivery method identifier
	DeliveryMethodId int64 `json:"delivery_method_id"`

	// Shipping date.
	//
	// To make documents printing available before the shipping day,
	// enable Printing the acceptance certificate in advance in your personal account under the method settings.
	// The time for packaging (packaging SLA) should be more than 13 hours
	DepartureDate time.Time `json:"departure_date"`
}

type CreateActResponse struct {
	core.CommonResponse

	// Method result
	Result struct {
		// Document generation task number
		Id int64 `json:"id"`
	} `json:"result"`
}

// Launches the procedure for generating the transfer documents: acceptance and transfer certificate and the waybill.
//
// To generate and receive transfer documents, transfer the shipment to the `awaiting_deliver` status
func (c FBS) CreateAct(params *CreateActParams) (*CreateActResponse, error) {
	url := "/v2/posting/fbs/act/create"

	resp := &CreateActResponse{}

	response, err := c.client.Request(http.MethodPost, url, params, resp)
	if err != nil {
		return nil, err
	}
	response.CopyCommonResponse(&resp.CommonResponse)

	return resp, nil
}

type GetLabelingParams struct {
	// Task identifier for labeling generation from the /v1/posting/fbs/package-label/create method response
	TaskId int64 `json:"task_id"`
}

type GetLabelingResponse struct {
	core.CommonResponse

	// Method result
	Result struct {
		// Error code
		Error string `json:"error"`

		// Link to a labeling file
		FileUrl string `json:"file_url"`

		// Status of labeling generation:
		//   - pending — task is in the queue.
		//   - in_progress — being generated.
		//   - completed — labeling file is ready.
		//   - error — error occurred during file generation
		Status string `json:"status"`
	} `json:"result"`
}

// Method for getting labeling after using the /v1/posting/fbs/package-label/create method
func (c FBS) GetLabeling(params *GetLabelingParams) (*GetLabelingResponse, error) {
	url := "/v1/posting/fbs/package-label/get"

	resp := &GetLabelingResponse{}

	response, err := c.client.Request(http.MethodPost, url, params, resp)
	if err != nil {
		return nil, err
	}
	response.CopyCommonResponse(&resp.CommonResponse)

	return resp, nil
}

type PrintLabelingParams struct {
	// Shipment identifier
	PostingNumber []string `json:"posting_number"`
}

type PrintLabelingResponse struct {
	core.CommonResponse

	// Order content
	Content string `json:"content"`
}

// Generates a PDF file with a labeling for the specified shipments. You can pass a maximum of 20 identifiers in one request.
// If an error occurs for at least one shipment, the labeling will not be generated for all shipments in the request.
//
// We recommend requesting the label 45-60 seconds after the shipments were packed.
//
// The next postings are not ready error means that the label is not ready. Try again later
func (c FBS) PrintLabeling(params *PrintLabelingParams) (*PrintLabelingResponse, error) {
	url := "/v2/posting/fbs/package-label"

	resp := &PrintLabelingResponse{}

	response, err := c.client.Request(http.MethodPost, url, params, resp)
	if err != nil {
		return nil, err
	}
	response.CopyCommonResponse(&resp.CommonResponse)

	return resp, nil
}

type CreateTaskForGeneratingLabelParams struct {
	// Numbers of shipments that need labeling
	PostingNumber []string `json:"posting_number"`
}

type CreateTaskForGeneratingLabelResponse struct {
	core.CommonResponse

	// Method result
	Result struct {
		// Task identifier for labeling generation
		TaskId int64 `json:"task_id"`
	} `json:"result"`
}

// Method for creating a task for asynchronous labeling generation.
//
// To get labels created as a result of the method, use the /v1/posting/fbs/package-label/get method
func (c FBS) CreateTaskForGeneratingLabel(params *CreateTaskForGeneratingLabelParams) (*CreateTaskForGeneratingLabelResponse, error) {
	url := "/v2/posting/fbs/package-label"

	resp := &CreateTaskForGeneratingLabelResponse{}

	response, err := c.client.Request(http.MethodPost, url, params, resp)
	if err != nil {
		return nil, err
	}
	response.CopyCommonResponse(&resp.CommonResponse)

	return resp, nil
}

type GetDropOffPointRestrictionsParams struct {
	// The number of shipment for which you want to determine the restrictions
	PostingNumber string `json:"posting_number"`
}

type GetDropOffPointRestrictionsResponse struct {
	core.CommonResponse

	// Method result
	Result struct {
		// Shipment number
		PostingNumber string `json:"posting_number"`

		// Maximum weight limit in grams
		MaxPostingWeight float64 `json:"max_posting_weight"`

		// Minimum weight limit in grams
		MinPostingWeight float64 `json:"min_posting_weight"`

		// Width limit in centimeters
		Width float64 `json:"width"`

		// Length limit in centimeters
		Length float64 `json:"length"`

		// Height limit in centimeters
		Height float64 `json:"height"`

		// Maximum shipment cost limit in rubles
		MaxPostingPrice float64 `json:"max_posting_price"`

		// Minimum shipment cost limit in rubles
		MinPostingPrice float64 `json:"min_posting_price"`
	} `json:"result"`
}

// Method for getting dimensions, weight, and other restrictions of the drop-off point by the shipment number.
// The method is applicable only for the FBS scheme
func (c FBS) GetDropOffPointRestrictions(params *GetDropOffPointRestrictionsParams) (*GetDropOffPointRestrictionsResponse, error) {
	url := "/v1/posting/fbs/restrictions"

	resp := &GetDropOffPointRestrictionsResponse{}

	response, err := c.client.Request(http.MethodPost, url, params, resp)
	if err != nil {
		return nil, err
	}
	response.CopyCommonResponse(&resp.CommonResponse)

	return resp, nil
}

type CheckProductItemsDataParams struct {
	// Shipment number
	PostingNumber string `json:"posting_number"`

	Products CheckProductItemsDataProduct `json:"products"`
}

type CheckProductItemsDataProduct struct {
	// Product items data
	Exemplars []FBSProductExemplar `json:"exemplars"`

	// SKU, FBS product identifier in the Ozon system
	ProductId int64 `json:"product_id"`
}

type CheckProductItemsDataResponse struct {
	core.CommonResponse

	// Method result. true if the request was processed successfully
	Result bool `json:"result"`
}

// Asynchronous method:
//   - for checking the availability of product items in the “Chestny ZNAK” labeling system
//   - for saving product items data
// To get the checks results, use the `/v4/fbs/posting/product/exemplar/status method`
//
// If necessary, specify the number of the cargo customs declaration in the gtd parameter. If it is missing, pass the value `is_gtd_absent` = true
//
// If you have multiple identical products in a shipment, specify one `product_id` and `exemplars` array for each product in the shipment
//
// Always pass a complete set of product items data
//
// For example, you have 10 product items in your system.
// You have passed them for checking and saving. Then they added another 60 product items to your system.
// When you pass product items for checking and saving again, pass all of them: both old and newly added
func (c FBS) CheckproductItemsData(params *CheckProductItemsDataParams) (*CheckProductItemsDataResponse, error) {
	url := "/v4/fbs/posting/product/exemplar/set"

	resp := &CheckProductItemsDataResponse{}

	response, err := c.client.Request(http.MethodPost, url, params, resp)
	if err != nil {
		return nil, err
	}
	response.CopyCommonResponse(&resp.CommonResponse)

	return resp, nil
}

type GetProductItemsCheckStatusesParams struct {
	// Shipment number
	PostingNumber string `json:"posting_number"`
}

type GetProductItemsCheckStatusesResponse struct {
	core.CommonResponse

	// Shipment number
	PostingNumber string `json:"posting_number"`

	// Products list
	Products []CheckProductItemsDataProduct `json:"products"`

	// Product items check statuses and order collection availability:
	//   - ship_available — order collection is available,
	//   - ship_not_available — order collection is unavailable,
	//   - validation_in_process — product items validation is in progress
	Status string `json:"status"`
}

// Method for getting check statuses of product items that were passed in the `/fbs/posting/product/exemplar/set` method.
// Also returns data on these product items.
func (c FBS) GetProductItemsCheckStatuses(params *GetProductItemsCheckStatusesParams) (*GetProductItemsCheckStatusesResponse, error) {
	url := "/v4/fbs/posting/product/exemplar/status"

	resp := &GetProductItemsCheckStatusesResponse{}

	response, err := c.client.Request(http.MethodPost, url, params, resp)
	if err != nil {
		return nil, err
	}
	response.CopyCommonResponse(&resp.CommonResponse)

	return resp, nil
}