diff --git a/docs/CHANGELOG.rst b/docs/CHANGELOG.rst index dc7e8aa..0c4a462 100644 --- a/docs/CHANGELOG.rst +++ b/docs/CHANGELOG.rst @@ -8,6 +8,13 @@ The format is based on `Keep a Changelog`_ and this project adheres to `Semantic Versioning`_. +[1.3.0] - 2021-01-07 +-------------------- +Changed +******* +* Change the argument for `query_pricing` to allow to specify any combination of code types + and keep compatibility with the old version (a list of EANs when the code type is not specified) + [1.2.0] - 2021-01-07 -------------------- Changed diff --git a/docs/_build/doctrees/api.doctree b/docs/_build/doctrees/api.doctree index 8b1146a..c818b02 100644 Binary files a/docs/_build/doctrees/api.doctree and b/docs/_build/doctrees/api.doctree differ diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle index 2837187..1db4a40 100644 Binary files a/docs/_build/doctrees/environment.pickle and b/docs/_build/doctrees/environment.pickle differ diff --git a/docs/_build/doctrees/quickstart.doctree b/docs/_build/doctrees/quickstart.doctree index 5ce8981..f35ff59 100644 Binary files a/docs/_build/doctrees/quickstart.doctree and b/docs/_build/doctrees/quickstart.doctree differ diff --git a/docs/_build/html/_sources/quickstart.rst.txt b/docs/_build/html/_sources/quickstart.rst.txt index 8823623..c6bf06c 100644 --- a/docs/_build/html/_sources/quickstart.rst.txt +++ b/docs/_build/html/_sources/quickstart.rst.txt @@ -114,7 +114,25 @@ In order to stay competitive, you have to know the offers created by the other sellers for a list of codes or at least the current best offer these products. You can get these information with `query_pricing`:: - response = manager.query_pricing(codes, code_type=code_type) + response = manager.query_pricing(codes) + +where `codes` can be: + + 1. A list of EANs. + + Example:: + + codes = ["7321900286480", "9780262510875", "5060314991222"] + + 2. A list of any code type. + + Example:: + + codes = [ + {"value": 9780262510875, "type": "Ean"}, + {"value": 2359109693, "type": "Isbn"}, + {"value": 8172119, "type": "FnacId"}, + ] The available code types are: @@ -127,9 +145,6 @@ The available code types are: - **CnetId**: The code given is the global Cnet reference of this product -Note that by default `code_type` is `"Ean"`. - - Delete offers ------------- diff --git a/docs/_build/html/api.html b/docs/_build/html/api.html index 1653280..cccc042 100644 --- a/docs/_build/html/api.html +++ b/docs/_build/html/api.html @@ -351,18 +351,26 @@

FnapyManager
-query_pricing(codes, code_type='Ean')
+query_pricing(codes)

Retrieve the best prices applied to a given product within all Fnac marketplace sellers (Fnac included)

Usage:

-
response = manager.query_pricing(codes, code_type=code_type)
+
response = manager.query_pricing(codes)
 
Parameters
-
    -
  • codes (list or tuple) – a list of codes

  • -
  • code_type (str) –

      +

      codes (list or tuple) – a list of EANs or a list of dicts with the keys value and type.

      +
      +
+

Example:

+
codes = [ean1, ean2, ...]
+
+codes = [{"value": code1, "type": "Ean"}, {"value": code2, "type": "Isbn"}, ...]
+
+
+
+
The availble code types are:
  • FnacId: The code given is the Fnac product identifier

  • PartnerId: The code given is the id from a partner, if this

    value is set, a partner id will be mandatory

    @@ -374,11 +382,11 @@

    FnapyManagerReturns -

    response

    +

    +
    +
    Returns
    +

    response

diff --git a/docs/_build/html/quickstart.html b/docs/_build/html/quickstart.html index c3f08c0..0987c55 100644 --- a/docs/_build/html/quickstart.html +++ b/docs/_build/html/quickstart.html @@ -135,9 +135,30 @@

Query the pricing
response = manager.query_pricing(codes, code_type=code_type)
+
response = manager.query_pricing(codes)
 
+

where codes can be:

+
+
    +
  1. A list of EANs.

  2. +
+

Example:

+
codes = ["7321900286480", "9780262510875", "5060314991222"]
+
+
+
    +
  1. A list of any code type.

  2. +
+

Example:

+
codes = [
+    {"value": 9780262510875, "type": "Ean"},
+    {"value": 2359109693, "type": "Isbn"},
+    {"value": 8172119, "type": "FnacId"},
+]
+
+
+

The available code types are:

    @@ -153,7 +174,6 @@

    Query the pricing

    Delete offers

    diff --git a/docs/_build/html/searchindex.js b/docs/_build/html/searchindex.js index 7c436a3..e6fb7c8 100644 --- a/docs/_build/html/searchindex.js +++ b/docs/_build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["CHANGELOG","api","index","quickstart"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,"sphinx.ext.todo":2,sphinx:56},filenames:["CHANGELOG.rst","api.rst","index.rst","quickstart.rst"],objects:{"":{connection:[1,0,0,"-"],fnapy_manager:[2,0,0,"-"],utils:[1,0,0,"-"]},"fnapy_manager.FnapyManager":{authenticate:[1,2,1,""],delete_offers:[1,2,1,""],get_batch_status:[1,2,1,""],query_batch:[1,2,1,""],query_carriers:[1,2,1,""],query_client_order_comments:[1,2,1,""],query_incidents:[1,2,1,""],query_messages:[1,2,1,""],query_offers:[1,2,1,""],query_orders:[1,2,1,""],query_pricing:[1,2,1,""],query_shop_invoices:[1,2,1,""],update_client_order_comments:[1,2,1,""],update_incidents:[1,2,1,""],update_messages:[1,2,1,""],update_offers:[1,2,1,""],update_orders:[1,2,1,""]},"utils.Message":{to_dict:[1,2,1,""]},connection:{FnapyConnection:[1,1,1,""]},fnapy_manager:{FnapyManager:[1,1,1,""]},utils:{Message:[1,1,1,""],Request:[1,1,1,""],Response:[1,1,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method"},terms:{"003ecca1yvfbw":3,"04db":3,"0711719247159":3,"07lwq6278yjui":1,"1234":3,"12345":1,"153":3,"18074":0,"2016":[1,2,3],"2017":2,"2018":2,"2019":2,"2020":2,"2021":2,"23t17":1,"26t17":1,"5030917077418":3,"75e":3,"78e0":3,"88bd9517":3,"boolean":0,"byte":0,"class":[0,1,3],"default":3,"import":[1,3],"new":[0,1,3],"return":[0,1],"true":1,For:[1,3],The:[0,1,3],Use:0,a73c:3,abl:3,about:[1,3],ac5ade1d63f6:3,accept:[0,1,3],accept_all_ord:[1,3],accept_ord:[1,3],access:3,account:[0,1,2],act:3,action1:[1,3],action2:[1,3],action:[1,3],actual:3,add:[0,3],added:0,adher:0,all:[0,1],allow:0,also:3,anoth:0,api:[2,3],appli:1,applic:2,archiv:1,ask:1,attribut:3,authent:[0,1],author:1,avail:[1,3],b067:3,b76a:3,base:0,basic:3,batch:[1,2],batch_id:[1,3],batch_statu:3,beautifulsoup:0,been:1,befor:3,behind:3,best:[1,3],between:[1,3],both:3,bs4:0,bug:0,can:[1,3],carrier:1,catalog:[1,3],caveat:0,cd5:3,cdata:3,chang:2,changelog:0,check:[0,3],client:1,client_order_com:1,client_order_comment_id:1,close:1,closed_bi:1,closed_statu:1,closed_status:1,cnet:[1,3],cnetid:[1,3],code:[0,1,3],code_typ:[1,3],com:3,comment:1,competit:3,complex:0,confirm:1,confirm_all_to_send:1,confirm_to_send:1,confus:0,connect:[0,1,2,3],constructor:0,contain:1,content:[0,1],correspond:1,creat:[0,1,3],credenti:[0,1,3],current:[1,3],custom:[1,3],cve:0,dai:3,data:[1,2],date:[1,3],datetim:3,deal:1,decid:1,defin:1,delet:[1,2],delete_off:[0,1,3],depend:0,descript:[1,3],detail:1,develop:0,dialog:3,dict:3,dictionari:[0,1],differ:[1,3],displai:0,dmax:3,dmin:3,document:[0,1],due:0,ean:[0,1,3],element:1,empti:[0,1],encod:[0,3],environ:1,error:0,especi:0,exampl:[1,3],except:[0,1],exchang:2,extract:0,extract_text:0,f0d:3,fals:[0,1],fetch:1,file:0,filter:1,find:1,first:[1,3],fixtur:0,fnac:[0,1,3],fnac_kei:1,fnac_partner_id:1,fnac_sandbox_kei:1,fnac_sandbox_partner_id:1,fnac_sandbox_shop_id:1,fnac_shop_id:1,fnacid:[1,3],fnacmarketplac:2,fnapi:[0,1,3],fnapy_manag:[1,3],fnapyconnect:[0,2,3],fnapyconnectionerror:0,fnapymanag:[0,2,3],fnapypricingerror:0,fnapyresponseerror:0,fnapyupdateoffererror:[0,1],follow:[1,3],format:[0,1],franc:3,from:[0,1,3],get:2,get_batch_statu:[1,3],give:3,given:[1,3],global:[1,3],good:3,got:3,group:1,handi:1,handl:[0,1],has:1,have:[1,3],how:3,http:3,identifi:[1,3],implement:0,improv:0,inc:3,incid:1,incident_id:1,incident_update_act:1,incidents_id:1,includ:[1,3],index:2,inform:[0,1],instanc:[0,3],integ:1,interfac:3,introduct:3,invalid:0,isbn:[1,3],isoformat:3,item:[1,3],just:3,keep:0,kei:1,know:3,last:[1,3],later:3,latest:3,ldjedeas123:1,least:[0,1,3],let:3,librari:2,limit:0,list:[0,1,3],log:2,look:3,mai:3,make:[0,3],manag:[0,1,3],mandatori:[1,3],mark_as_read:1,marketplac:[1,3],max:[1,3],messag:[0,2],message_archiv:1,message_from_typ:1,message_id:1,message_st:1,message_typ:1,method:0,min:[1,3],minor:0,miss:0,modifi:1,modul:2,moment:1,more:0,multipl:1,must:1,my_kei:1,my_partner_id:1,my_shop_id:1,need:1,no_stock:1,node:1,none:1,notabl:0,note:[1,3],now:[0,3],number:1,object:1,offer:[1,2],offer_data1:3,offer_data2:3,offer_fnac_id:1,offer_refer:[0,1,3],offer_seller_id:1,offers_data1:3,offers_data:[0,1],offers_upd:3,offers_update_request:3,offers_update_respons:3,onc:3,one:[0,1],onli:[0,1,3],open:1,opened_bi:1,option:[0,1],order:[0,1,2],order_detail:1,order_detail_id:[1,3],order_fnac_id:1,order_id:[1,3],order_inform:1,order_update_act:1,orders_fnac_id:1,orders_upd:0,other:3,our:3,own:2,packag:0,page:[1,2,3],paramet:[0,1],parse_xml:0,partner:[1,3],partner_id:[1,3],partnerid:[1,3],partnumb:[1,3],pass:0,perform:1,pipenv:0,place:3,platform:1,possibl:[0,3],post:1,prevent:0,previous:1,price:[1,2],pricing_queri:0,print:3,problem:0,process:1,product:[1,3],product_fnac_id:1,product_refer:[0,1,3],product_st:[1,3],project:0,protocol:2,provid:[0,1],python:[0,2],pytz:3,quantiti:[1,3],queri:[0,1,2],query_batch:1,query_carri:1,query_client_order_com:1,query_incid:1,query_messag:1,query_off:[1,3],query_ord:[1,3],query_pr:[0,1,3],query_shop_invoic:1,quickstart:2,rafaurl:0,rais:[0,1],rate:1,rather:0,raw:0,reach:0,read:1,readm:0,real:[0,1],realli:0,reason:1,receiv:3,refer:[1,3],refund:1,refund_reason:1,refus:[1,3],replac:3,repli:1,repres:1,request:[0,2],respect:0,respons:[0,2],rest:2,results_count:[1,3],retriev:[1,3],sai:3,sale:2,same:3,sandbox:[0,1],satisfis:3,scene:3,schema:3,search:2,second:[1,3],section:3,see:3,select:1,seller:[1,2,3],seller_com:1,sellersku:3,semant:0,send:[0,1],sent:[0,1,3],server:3,servic:[1,3],set:[1,3],share:3,ship:[1,3],shop_id:[1,3],shop_invoic:1,should:3,sku:[1,3],some:[0,3],sort_bi:1,specif:1,specifi:1,stai:3,start:3,state:[0,1],statu:[1,2],status:3,step:3,store:[0,1,3],str:1,string:0,subject:1,successfulli:3,support:0,sure:3,talk:3,test:0,text:0,than:0,thei:3,them:3,thi:[0,1,3],thing:0,to_dict:1,to_unicod:0,token:[1,3],toship:3,track:[0,1],tracking_compani:3,tracking_numb:3,tupl:1,type:[0,1,3],tzinfo:3,unicod:0,uniqu:1,updat:[0,1,2],update_al:1,update_client_order_com:1,update_incid:1,update_messag:1,update_off:[0,1,3],update_ord:[1,3],url:0,usag:1,use:3,used:1,uses:2,using:[1,2,3],utc:3,utf8:0,utf:[0,3],util:[1,3],valu:[1,3],variabl:1,version:[0,3],vulner:0,waiting_for_seller_answ:1,want:[1,3],web:3,webservic:2,were:3,what:3,when:[0,3],where:[1,3],who:1,whose:1,within:1,work:0,workflow:3,www:3,xml:[0,1,3],xmln:3,xmltodict:1,xsd:3,xxx:3,you:[1,3],your:[1,2]},titles:["Change log","API","Welcome to fnapy\u2019s documentation!","Quickstart"],titleterms:{"2016":0,"2017":0,"2018":0,"2019":0,"2020":0,"2021":0,Added:0,api:1,batch:3,chang:0,delet:3,document:2,fix:0,fnapi:2,fnapyconnect:1,fnapymanag:1,get:3,indic:2,inform:3,log:0,messag:1,offer:3,order:3,price:3,queri:3,quickstart:3,remov:0,request:[1,3],respons:[1,3],statu:3,tabl:2,todo:3,track:3,updat:3,welcom:2,your:3}}) \ No newline at end of file +Search.setIndex({docnames:["CHANGELOG","api","index","quickstart"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,"sphinx.ext.todo":2,sphinx:56},filenames:["CHANGELOG.rst","api.rst","index.rst","quickstart.rst"],objects:{"":{connection:[1,0,0,"-"],fnapy_manager:[2,0,0,"-"],utils:[1,0,0,"-"]},"fnapy_manager.FnapyManager":{authenticate:[1,2,1,""],delete_offers:[1,2,1,""],get_batch_status:[1,2,1,""],query_batch:[1,2,1,""],query_carriers:[1,2,1,""],query_client_order_comments:[1,2,1,""],query_incidents:[1,2,1,""],query_messages:[1,2,1,""],query_offers:[1,2,1,""],query_orders:[1,2,1,""],query_pricing:[1,2,1,""],query_shop_invoices:[1,2,1,""],update_client_order_comments:[1,2,1,""],update_incidents:[1,2,1,""],update_messages:[1,2,1,""],update_offers:[1,2,1,""],update_orders:[1,2,1,""]},"utils.Message":{to_dict:[1,2,1,""]},connection:{FnapyConnection:[1,1,1,""]},fnapy_manager:{FnapyManager:[1,1,1,""]},utils:{Message:[1,1,1,""],Request:[1,1,1,""],Response:[1,1,1,""]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method"},terms:{"003ecca1yvfbw":3,"04db":3,"0711719247159":3,"07lwq6278yjui":1,"1234":3,"12345":1,"153":3,"18074":0,"2016":[1,2,3],"2017":2,"2018":2,"2019":2,"2020":2,"2021":2,"2359109693":3,"23t17":1,"26t17":1,"5030917077418":3,"5060314991222":3,"7321900286480":3,"75e":3,"78e0":3,"8172119":3,"88bd9517":3,"9780262510875":3,"boolean":0,"byte":0,"class":[0,1,3],"default":[],"import":[1,3],"new":[0,1,3],"return":[0,1],"true":1,For:[1,3],The:[0,1,3],Use:0,a73c:3,abl:3,about:[1,3],ac5ade1d63f6:3,accept:[0,1,3],accept_all_ord:[1,3],accept_ord:[1,3],access:3,account:[0,1,2],act:3,action1:[1,3],action2:[1,3],action:[1,3],actual:3,add:[0,3],added:0,adher:0,all:[0,1],allow:0,also:3,ani:3,anoth:0,api:[2,3],appli:1,applic:2,archiv:1,ask:1,attribut:3,authent:[0,1],author:1,avail:[1,3],availbl:1,b067:3,b76a:3,base:0,basic:3,batch:[1,2],batch_id:[1,3],batch_statu:3,beautifulsoup:0,been:1,befor:3,behind:3,best:[1,3],between:[1,3],both:3,bs4:0,bug:0,can:[1,3],carrier:1,catalog:[1,3],caveat:0,cd5:3,cdata:3,chang:2,changelog:0,check:[0,3],client:1,client_order_com:1,client_order_comment_id:1,close:1,closed_bi:1,closed_statu:1,closed_status:1,cnet:[1,3],cnetid:[1,3],code1:1,code2:1,code:[0,1,3],code_typ:[],com:3,comment:1,competit:3,complex:0,confirm:1,confirm_all_to_send:1,confirm_to_send:1,confus:0,connect:[0,1,2,3],constructor:0,contain:1,content:[0,1],correspond:1,creat:[0,1,3],credenti:[0,1,3],current:[1,3],custom:[1,3],cve:0,dai:3,data:[1,2],date:[1,3],datetim:3,deal:1,decid:1,defin:1,delet:[1,2],delete_off:[0,1,3],depend:0,descript:[1,3],detail:1,develop:0,dialog:3,dict:[1,3],dictionari:[0,1],differ:[1,3],displai:0,dmax:3,dmin:3,document:[0,1],due:0,ean1:1,ean2:1,ean:[0,1,3],element:1,empti:[0,1],encod:[0,3],environ:1,error:0,especi:0,exampl:[1,3],except:[0,1],exchang:2,extract:0,extract_text:0,f0d:3,fals:[0,1],fetch:1,file:0,filter:1,find:1,first:[1,3],fixtur:0,fnac:[0,1,3],fnac_kei:1,fnac_partner_id:1,fnac_sandbox_kei:1,fnac_sandbox_partner_id:1,fnac_sandbox_shop_id:1,fnac_shop_id:1,fnacid:[1,3],fnacmarketplac:2,fnapi:[0,1,3],fnapy_manag:[1,3],fnapyconnect:[0,2,3],fnapyconnectionerror:0,fnapymanag:[0,2,3],fnapypricingerror:0,fnapyresponseerror:0,fnapyupdateoffererror:[0,1],follow:[1,3],format:[0,1],franc:3,from:[0,1,3],get:2,get_batch_statu:[1,3],give:3,given:[1,3],global:[1,3],good:3,got:3,group:1,handi:1,handl:[0,1],has:1,have:[1,3],how:3,http:3,identifi:[1,3],implement:0,improv:0,inc:3,incid:1,incident_id:1,incident_update_act:1,incidents_id:1,includ:[1,3],index:2,inform:[0,1],instanc:[0,3],integ:1,interfac:3,introduct:3,invalid:0,isbn:[1,3],isoformat:3,item:[1,3],just:3,keep:0,kei:1,know:3,last:[1,3],later:3,latest:3,ldjedeas123:1,least:[0,1,3],let:3,librari:2,limit:0,list:[0,1,3],log:2,look:3,mai:3,make:[0,3],manag:[0,1,3],mandatori:[1,3],mark_as_read:1,marketplac:[1,3],max:[1,3],messag:[0,2],message_archiv:1,message_from_typ:1,message_id:1,message_st:1,message_typ:1,method:0,min:[1,3],minor:0,miss:0,modifi:1,modul:2,moment:1,more:0,multipl:1,must:1,my_kei:1,my_partner_id:1,my_shop_id:1,need:1,no_stock:1,node:1,none:1,notabl:0,note:[1,3],now:[0,3],number:1,object:1,offer:[1,2],offer_data1:3,offer_data2:3,offer_fnac_id:1,offer_refer:[0,1,3],offer_seller_id:1,offers_data1:3,offers_data:[0,1],offers_upd:3,offers_update_request:3,offers_update_respons:3,onc:3,one:[0,1],onli:[0,1,3],open:1,opened_bi:1,option:[0,1],order:[0,1,2],order_detail:1,order_detail_id:[1,3],order_fnac_id:1,order_id:[1,3],order_inform:1,order_update_act:1,orders_fnac_id:1,orders_upd:0,other:3,our:3,own:2,packag:0,page:[1,2,3],paramet:[0,1],parse_xml:0,partner:[1,3],partner_id:[1,3],partnerid:[1,3],partnumb:[1,3],pass:0,perform:1,pipenv:0,place:3,platform:1,possibl:[0,3],post:1,prevent:0,previous:1,price:[1,2],pricing_queri:0,print:3,problem:0,process:1,product:[1,3],product_fnac_id:1,product_refer:[0,1,3],product_st:[1,3],project:0,protocol:2,provid:[0,1],python:[0,2],pytz:3,quantiti:[1,3],queri:[0,1,2],query_batch:1,query_carri:1,query_client_order_com:1,query_incid:1,query_messag:1,query_off:[1,3],query_ord:[1,3],query_pr:[0,1,3],query_shop_invoic:1,quickstart:2,rafaurl:0,rais:[0,1],rate:1,rather:0,raw:0,reach:0,read:1,readm:0,real:[0,1],realli:0,reason:1,receiv:3,refer:[1,3],refund:1,refund_reason:1,refus:[1,3],replac:3,repli:1,repres:1,request:[0,2],respect:0,respons:[0,2],rest:2,results_count:[1,3],retriev:[1,3],sai:3,sale:2,same:3,sandbox:[0,1],satisfis:3,scene:3,schema:3,search:2,second:[1,3],section:3,see:3,select:1,seller:[1,2,3],seller_com:1,sellersku:3,semant:0,send:[0,1],sent:[0,1,3],server:3,servic:[1,3],set:[1,3],share:3,ship:[1,3],shop_id:[1,3],shop_invoic:1,should:3,sku:[1,3],some:[0,3],sort_bi:1,specif:1,specifi:1,stai:3,start:3,state:[0,1],statu:[1,2],status:3,step:3,store:[0,1,3],str:1,string:0,subject:1,successfulli:3,support:0,sure:3,talk:3,test:0,text:0,than:0,thei:3,them:3,thi:[0,1,3],thing:0,to_dict:1,to_unicod:0,token:[1,3],toship:3,track:[0,1],tracking_compani:3,tracking_numb:3,tupl:1,type:[0,1,3],tzinfo:3,unicod:0,uniqu:1,updat:[0,1,2],update_al:1,update_client_order_com:1,update_incid:1,update_messag:1,update_off:[0,1,3],update_ord:[1,3],url:0,usag:1,use:3,used:1,uses:2,using:[1,2,3],utc:3,utf8:0,utf:[0,3],util:[1,3],valu:[1,3],variabl:1,version:[0,3],vulner:0,waiting_for_seller_answ:1,want:[1,3],web:3,webservic:2,were:3,what:3,when:[0,3],where:[1,3],who:1,whose:1,within:1,work:0,workflow:3,www:3,xml:[0,1,3],xmln:3,xmltodict:1,xsd:3,xxx:3,you:[1,3],your:[1,2]},titles:["Change log","API","Welcome to fnapy\u2019s documentation!","Quickstart"],titleterms:{"2016":0,"2017":0,"2018":0,"2019":0,"2020":0,"2021":0,Added:0,api:1,batch:3,chang:0,delet:3,document:2,fix:0,fnapi:2,fnapyconnect:1,fnapymanag:1,get:3,indic:2,inform:3,log:0,messag:1,offer:3,order:3,price:3,queri:3,quickstart:3,remov:0,request:[1,3],respons:[1,3],statu:3,tabl:2,todo:3,track:3,updat:3,welcom:2,your:3}}) \ No newline at end of file diff --git a/docs/quickstart.rst b/docs/quickstart.rst index 8823623..c6bf06c 100644 --- a/docs/quickstart.rst +++ b/docs/quickstart.rst @@ -114,7 +114,25 @@ In order to stay competitive, you have to know the offers created by the other sellers for a list of codes or at least the current best offer these products. You can get these information with `query_pricing`:: - response = manager.query_pricing(codes, code_type=code_type) + response = manager.query_pricing(codes) + +where `codes` can be: + + 1. A list of EANs. + + Example:: + + codes = ["7321900286480", "9780262510875", "5060314991222"] + + 2. A list of any code type. + + Example:: + + codes = [ + {"value": 9780262510875, "type": "Ean"}, + {"value": 2359109693, "type": "Isbn"}, + {"value": 8172119, "type": "FnacId"}, + ] The available code types are: @@ -127,9 +145,6 @@ The available code types are: - **CnetId**: The code given is the global Cnet reference of this product -Note that by default `code_type` is `"Ean"`. - - Delete offers -------------