Get FBO shipments list

Gets a list of active shipments with or without filtering

Function GetFBOShipmentsList(Val ClientID, Val APIKey, Val Filter = Undefined, Val AddFields = Undefined, Val Indent = 0, Val Traslit = False) Export

Parameter	CLI option	Type	Required	Description
ClientID	--clientid	String	✔	Client identifier
APIKey	--apikey	String	✔	API key
Filter	--filter	Structure Of KeyAndValue	✖	Shipments filter. See GetShipmentsFilterStructure
AddFields	--with	Structure Of KeyAndValue	✖	Include additional fields in the response. See GetShipmentAdditionalFields
Indent	--offset	Number	✖	Offset of the result items
Traslit	--trlt	Boolean	✖	If Cyrillic to Latin address transliteration is enabled > True

Returns: Map Of KeyAndValue - serialized JSON response from Ozon Seller API

tip

Method at API documentation: post /v2/posting/fbo/list

1C:Enterprise/OneScript code example

    ClientID = "2479669";
    APIKey   = "09f65e9f-262d-4aca...";

    AddFields = New Structure;
    AddFields.Insert("analytics_data", True);
    AddFields.Insert("financial_data", True);

    Filter = New Structure;
    Filter.Insert("since", XMLString('20230101') + "Z");
    Filter.Insert("to"   , XMLString('20240101') + "Z");

    Result = OPI_Ozon.GetFBOShipmentsList(ClientID, APIKey, Filter, AddFields);

Bash

    # JSON data can also be passed as a path to a .json file
    
    oint ozon GetFBOShipmentsList \
     --clientid "***" \
     --apikey "***" \
     --filter "{'since':'2023-01-01T00:00:00Z','to':'2024-01-01T00:00:00Z'}" \
     --with "{'analytics_data':true,'financial_data':true}"

CMD/Bat

    :: JSON data can also be passed as a path to a .json file
    
    oint ozon GetFBOShipmentsList ^
     --clientid "***" ^
     --apikey "***" ^
     --filter "{'since':'2023-01-01T00:00:00Z','to':'2024-01-01T00:00:00Z'}" ^
     --with "{'analytics_data':true,'financial_data':true}"

Result

{
 "result": []
}