Versionen im Vergleich

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

Inhalt

Einführung

Die API-Schnittstelle der Print Lounge ermöglicht einen automatisierten, maschinengeeigneten Zugriff auf Daten aus der Print Lounge. Dies ermöglicht eine Integration in interne Prozesse und Tools. Die API ist ein zusätzliches Modul und kann für jeden Mandanten aktiviert werden. Für die Nutzung sind keine speziellen Pakete oder Optionen erforderlich. Die verfügbaren Daten entsprechen den Daten aus der Print Lounge. Auf dieser Seite werden generelle API-Informationen bereitgestellt. Der Abruf von Print Lounge-Daten geschieht über die URL.

API-Authentifizierung

Die Authentifizierung erfolgt durch eine Basic-Authentication. Hierfür werden API-Benutzer und API-Key übermittelt.

Der API-Benutzer/API-Key kann in der Administration unter Verwaltung → Shops → bearbeiten → API gesetzt werden. Beim Passwort wird die Passwortrichtlinie angewendet.

Der API-Benutzer/API-Key muss bei allen Abfragen übermittelt werden. Geschieht dieses nicht oder werden ungültige API-Daten verwendet, meldet die API den Fehlercode „401 Unauthorized“. Um API-Daten zu erhalten, kontaktieren Sie bitte Ihren Shopbetreiber.

Wird bei der Authentifizierung mehrfach ein falsches Passwort verwendet, wird der Zugriff für 15 Minuten gesperrt. Nach der Sperrzeit ist keine manuelle Freischaltung notwendig, dies passiert automatisch und kann anschließend wieder verwendet werden.

Artikel

Verfügbare Daten

Über die API kann auf folgende Daten zugegriffen werden.

...

status = 1|0

offset

limit

sortby

sort = ASC|DESC

format = json|serialize|print

...

Array

(

    [data] => Array

        (

            [39336] => Array

                (

                    [name] => Artikelbezeichung

                    [name_internal] => Artikelbezeichung Intern

                    [created] => 2016-03-01T15:19:41+0100

                    [changed] => 2016-04-13T12:19:27+0200

                )

        )

    [error] =>

)

Ausgabeformat

Alle Anfragen und Rückgabewerte sind UTF-8 kodiert. Standardmäßig erfolgt die Rückgabe der API-Schnittstelle im Json-Format. Alternativ kann eine serialisierte Rückgabe oder zu Testzwecken auf Ausgabe umgestellt werden. Dafür ist der Parameter „format“ mit dem Wert „json“,  „serialize“ oder „print“ an jede URL anzuhängen.

REST-API

Jedes Kommando für die API – Schnittstelle ist eine HTTP Anfrage.

In der URL wird das Ziel, das gewünschte Datenobjekt angegeben und die HTTP Methode (GET, POST, PUT, DELETE) gibt an, was gemacht werden soll.

  • GET: Liefert einen oder mehrere Datenobjekte.
  • POST: Erstellt ein neues Datenobjekt.
  • PUT: Ändert ein bestehendes Datenobjekt.
  • DELETE: Löscht ein bestehendes Datenobjekt.

Artikel

...

HTTP Methode

...

Pfad

...

Parameter

...

Request-Body

...

Beispiel

...

Inhalt

Einführung

Die API-Schnittstelle der Print Lounge ermöglicht einen automatisierten, maschinengeeigneten Zugriff auf Daten aus der Print Lounge. Dies ermöglicht eine Integration in interne Prozesse und Tools. Die API ist ein zusätzliches Modul und kann für jeden Mandanten aktiviert werden. Für die Nutzung sind keine speziellen Pakete oder Optionen erforderlich. Die verfügbaren Daten entsprechen den Daten aus der Print Lounge. Auf dieser Seite werden generelle API-Informationen bereitgestellt. Der Abruf von Print Lounge-Daten geschieht über die URL.

API-Authentifizierung

Die Authentifizierung erfolgt durch eine Basic-Authentication. Hierfür werden API-Benutzer und API-Key übermittelt.

Der API-Benutzer/API-Key kann in der Administration unter Verwaltung → Shops → bearbeiten → API gesetzt werden. Beim Passwort wird die Passwortrichtlinie angewendet.

Der API-Benutzer/API-Key muss bei allen Abfragen übermittelt werden. Geschieht dieses nicht oder werden ungültige API-Daten verwendet, meldet die API den Fehlercode „401 Unauthorized“. Um API-Daten zu erhalten, kontaktieren Sie bitte Ihren Shopbetreiber.

Wird bei der Authentifizierung mehrfach ein falsches Passwort verwendet, wird der Zugriff für 15 Minuten gesperrt. Nach der Sperrzeit ist keine manuelle Freischaltung notwendig, dies passiert automatisch und kann anschließend wieder verwendet werden.

Artikel

Verfügbare Daten

Über die API kann auf folgende Daten zugegriffen werden.

URLDatenParameterRückgabe
{*}.print-server.net/api/article.phpArtikel

status = 1|0

offset

limit

sortby

sort = ASC|DESC

format = json|serialize|print

Array

(

    [data] => Array

        (

            [39336] => Array

                (

                    [name] => Artikelbezeichung

                    [name_internal] => Artikelbezeichung Intern

                    [created] => 2016-03-01T15:19:41+0100

                    [changed] => 2016-04-13T12:19:27+0200

                )

        )

    [error] =>

)






Ausgabeformat

Alle Anfragen und Rückgabewerte sind UTF-8 kodiert. Standardmäßig erfolgt die Rückgabe der API-Schnittstelle im Json-Format. Alternativ kann eine serialisierte Rückgabe oder zu Testzwecken auf Ausgabe umgestellt werden. Dafür ist der Parameter „format“ mit dem Wert „json“,  „serialize“ oder „print“ an jede URL anzuhängen.

REST-API

Jedes Kommando für die API – Schnittstelle ist eine HTTP Anfrage.

In der URL wird das Ziel, das gewünschte Datenobjekt angegeben und die HTTP Methode (GET, POST, PUT, DELETE) gibt an, was gemacht werden soll.

  • GET: Liefert einen oder mehrere Datenobjekte.
  • POST: Erstellt ein neues Datenobjekt.
  • PUT: Ändert ein bestehendes Datenobjekt.
  • DELETE: Löscht ein bestehendes Datenobjekt.

Artikel

HTTP Methode

Pfad

Parameter

Request-Body

Beispiel

Rückgabeformat
GET/api/article -
http://shop.printlounge.local
/api/article
[  
   {  
      "id":"39293",
      "name":"Handelsware",
      "nameIntern":"intern",
      "fullDescription":"<p>full<\/p>\r\n",
      "detailedDescription":"<p>detailed<\/p>\r\n",
      "additionalInformation":"<p>additional<\/p>\r\n",
      "articleType":"25",
      "articleSapNumber":"sap",
      "productionTime":"1",
      "deliveryTime":"2"
   },
   {  
      "id":"39294",
      "name":"PrintOnDemand",
      "nameIntern":"",
      "fullDescription":"",
      "detailedDescription":"",
      "additionalInformation":"",
      "articleType":"26",
      "articleSapNumber":"SAP-Nummer12",
      "productionTime":"0",
      "deliveryTime":"0"
   }
]

Wobei articleType sein kann:

25: Handelsware
80: Handeslware mit Upload
27: Handelsware Plus
26: Print on Demand
139: Mietartikel
100: Artikelpaket
152: Mailing
106: Global

GET/api/article/{article-id}
-

http://shop.printlounge.local
/api/article/4711
[  
   {  
      "id":"39293",
      "name":"Handelsware",
      "nameIntern":"intern",
      "fullDescription":"<p>full<\/p>\r\n",
      "detailedDescription":"<p>detailed<\/p>\r\n",
      "additionalInformation":"<p>additional<\/p>\r\n",
      "articleType":"25",
      "articleSapNumber":"sap",
      "productionTime":"1",
      "deliveryTime":"2"
   },
   {  
      "id":"39294",
      "name":"PrintOnDemand",
      "nameIntern":"",
      "fullDescription":"",
      "detailedDescription":"",
      "additionalInformation":"",
      "articleType":"26",
      "articleSapNumber":"SAP-Nummer12",
      "productionTime":"0",
      "deliveryTime":"0"
   }
]
Wobei articleType sein kann:

25: Handelsware
80: Handeslware mit Upload
27: Handelsware Plus
26: Print on Demand
139: Mietartikel
100: Artikelpaket
152: Mailing
106: Global

GET/api/article/{article-id}
-
http
}


Verfügbare Daten

Bestellung


article4711

HTTP Methode

Pfad

Parameter

Request-Body

Beispiel

Rückgabeformat




Fürs eine Auflistung der aktuellsten Bestellungen, siehe Bestellstatus:
/api/order/
[
{
"id": 1235,
"internalOrderCode": "ABCDEG",
"orderCode": "MY4720",
"status": 1,
"orderStatus": 61,
"statusPaid": 1,
"lastModified": "2021-11-11 11:11:11",
"createDate": "2021-11-11 11:11:11"
},
{
"id": 1234,
"internalOrderCode": "ABCDEF",
"orderCode": "MY4710",
"status": 1,
"orderStatus": 61,
"statusPaid": 0,
"lastModified": "2020-11-11 11:11:11",
"createDate": "2020-11-11 11:11:11"
}
]
GET/api/cart/{order-code}-
https://shop.printlounge.local/api/cart/XABCDE
{  
    "id":"39293",
   "name":"Handelsware",
   "nameIntern":"intern",
   "fullDescription":"<p>full<\/p>\r\n",
   "detailedDescription":"<p>detailed<\/p>\r\n",
   "additionalInformation":"<p>additional<\/p>\r\n",
   "articleType":"25",
   "articleSapNumber":"sap",
   "productionTime":"1",
   "deliveryTime":"2"
}

Verfügbare Daten

Bestellung

HTTP Methode

Pfad

Parameter

Request-Body

Beispiel

Rückgabeformat
Fürs eine Auflistung der aktuellsten Bestellungen, siehe Bestellstatus:
/api/order/
[
{
"id": 1235,
"internalOrderCode": "ABCDEG",
"orderCode": "MY4720",
"status": 1,
"orderStatus": 61,
"statusPaid": 1,
"lastModified": "2021-11-11 11:11:11",
"createDate": "2021-11-11 11:11:11"
},
{
"id": 1234,
"internalOrderCode": "ABCDEF",
"orderCode": "MY4710",
"status": 1,
"orderStatus": 61,
"statusPaid": 0,
"lastModified": "2020-11-11 11:11:11",
"createDate": "2020-11-11 11:11:11"
}
]
GET/api/cart/{order-code}-https://shop.printlounge.local/api/cart/XABCDE

...

{
 "order_code": "XABCDE"
 "order_status": 61
}

...

Die folgende Tabelle stellt alle möglichen Statuswerte dar: 

warte auf Kostenfreigabe
StatusBezeichnung
61in Produktion
62im Versand
63geliefert
69Storno
73auf Freigabe warten
74Freigabe abgelehnt
88Freigabe erteilt
117erledigt
137abgerechnet
140warte auf Zahlungsanbieter
144
{
 "id": 645135
 "client_id": 1234
 "order_customer_id": 3124
 "order_budgetgroup_user_id": 564231
 "order_budgetgruppe 645135
 "client_id": 1234
 "order_customer_id": 3124
 "order_budgetgroup_user_id": 564231
 "order_budgetgruppe": "example content"
 "order_code": "example content"
 "order_number": 231
 "order_desc": "example content"
 "order_total": 0
 "order_deliver_address_company": "example content"
 "order_deliver_address_company2": "example content"
 "order_deliver_address_name": "example content"
 "order_deliver_address_firstname": "example content"
 "order_deliver_address_lastname": "example content"
 "order_deliver_address_title": "example content"
 "order_deliver_address_street": "example content"
 "order_deliver_address_zip": 12345
 "order_deliver_address_town": "example content"
 "order_deliver_address_country_code": "example content"
 "order_deliver_address_email": "example content"
 "order_deliver_address_email2": "example content"
 "order_payment_method": 0
 "order_deliver_address_department": "example content"
 "order_deliver_address_cost_center": "example content"
 "order_deliver_address_customer_order_number": "example content"
 "order_deliver_address_phone": "example content"
 "order_deliver_address_fax": "example content"
 "order_deliver_address_country": "example content"
 "order_bank_code": "example content"
 "order_bank_name": "example content"
 "order_depositor": "example content"
 "order_tax_id": "example content"
 "invoice_address_company1": "example content"
 "orderinvoice_address_codecompany2": "example content"
 "orderinvoice_address_numbercompany3": 231"example content"
 "orderinvoice_address_desctitle": "example content"
 "orderinvoice_address_totalname": 0"example content"
 "order_deliverinvoice_address_firstname": "example content"
 "invoice_address_companylastname": "example content"
 "order_deliverinvoice_address_phone": "example content"
 "invoice_address_company2street": "example content"
 "order_deliverinvoice_address_zip": 12345
 "invoice_address_nametown": "example content"
 "order_deliverinvoice_address_firstnamecountry": "example content"
 "orderinvoice_deliveraddress_addresscountry_lastnamecode": "example content"
 "order_delivercustomer_addressuser_titleid": "example984563
content"  "order_deliveruser_address_streetname": "example content"
 "order_deliver_address_zipserviceprovider_id": 0
 "serviceprovider_x_id": 123450
 "order_deliver_address_townserviceprovider_status": "example content"
 "order_deliver_address_country_codecart_table": "example1
content"
 "order_deliverexpress_address_emaildelivery": "example content"0
 "order_deliverexpress_addressdelivery_email2surcharge": "example content"
 "order_paymentdelivery_method": 0"example content"
 "order_deliver_address_departmentcomment": "example content"
 "order_deliver_address_cost_centerbudget_before": 0.00
 "order_budget_booking": "example content"
0.00
 "order_deliverbudget_address_customer_order_numberbooking_after": "example content"
0.00
 "order_deliver_address_phonestatus": "example content"62
 "order_deliverdelivery_address_faxdate": "example content"
 "order_deliver_address_countrypackages": 0
 "example content"weight": 0
 "order_bank_codebarcode": "example content"
 "order_bank_nameapproval": "example content"
 "orderapproval_depositoremail": "example content"
 "order_taxapproval_idexplaination": "example content"
 "invoice_address_company1pdate": "example content"
 "invoice_address_company2sdate": "example content"
 "invoice_address_company3mdate": "example content"
 "invoice_address_titlecdate": "example content"
 "invoice_address_namestatus": 3
 "status_paid"example: content"0
 "invoicedate_address_firstnamepaid": "example content"
 "invoicestatus_address_lastnamesendmail": "example1
content"  "invoiceopentrans_address_phonestatus": 0
 "printshop"example: content"0
 "invoiceorder_type_addressprint_streetjob": "example content"1
 "invoiceorder_addresstype_zippdf": 123450
 "invoiceemailing_address_townname": "example content"
 "invoiceemailing_address_countryemail": "example content"
 "invoiceemailing_addressadditional_country_codetext": "example content"
 "order_customer_user_idinvoice_number": 9845630
 "individual_order_user_namecode": "example content"
 "serviceprovider_id": 0
 "serviceprovider_x_idindividual_order_item_code": 0
 "serviceproviderindividual_invoice_statusnumber": "example content"
 "cart_tableindividual_order_item_code_invoice": 10
 "ordercoupon_express_deliverycode": 0
 "order_express_delivery_surchargepayment_interface": "example content"0
 "md5_order_delivery_methodconsolidation": "example0
content"  "order_commentmd5": "example content"
 "ordercollective_budgetprice_beforescale": 0.00
 "orderapproved_budget_bookingby": 0.00"example content"
 "order_budget_booking_afterlanguage": 0.00"example content"
 "order_statusbudged": "example 62content"
 "ordershipping_delivery_datecharges": "example content"9.99
 "packagesvat_amount": 0.00
 "weightnet_amount": 010.00
 "barcodegross_amount": "example content"
 "order_approval10.00
 "auth_micropayment": "example content"
 "approvalbudgedgroup_emaildiscount": "example content"0
 "orderbudgedgroup_approvaldiscount_explainationamount": "example content"
 "pdateposition_feedback": "example0
content"  "sdatevat_included": "example54
content"  "mdatedate_of_invoice": "example content"
 "cdatecartItems": "example {
content"  "status1": {
 3  "status_paidid": 0121314
   "dateclient_paidid": 1234
"example content"  "statusorder_sendmailid": 1645135
   "opentransparent_statusid": 0
   "printshoptype": 01
   "order_type_print_jobaid": 231450
1   "orderarticle_type_pdf": 026
   "emailing_namepersdata": "example content"
   "emailingpersdata_emailarray": "example content"
   "emailingadditional_additionalfields_textarray": "example content"
 "invoice_number": 0  "individualcart_additional_orderfields_codearray": "example content"
 "individual_order_item_code": 0  "individualarticle_invoiceoptions_numberremark": "example content"
 "individual_order_item_code_invoice  "quantity": 0370169
   "couponquantity_codevalue": 01
   "payment_interfaceremark": 0"example  "md5_order_consolidation": 0content"
   "md5filename": "example content"
   "collectivepdf_price_scalefilenames": 0"example content"
   "approvedcost_bycenter": "example content"
   "order_languagemdate": "example content"
   "order_budgedcdate": "example content"
   "shipping_chargesrdate": 9.99
 "vat_amount": 0.00"example content"
   "netr_amountremark": 10.00
 "gross_amount": 10.00"example content"
   "authr_micropaymentshort": "example content"
   "budgedgroupr_discountemail": 0"example content"
   "budgedgroups_discount_amountdesc": "example content"
   "positions_quantity_feedbackvalue": 01
   "vats_cost_includedcenter": 54 "example content"
   "dates_of_invoicetotal": "example content"
   "cartItemss_ntotal": 1
{   "1s_vat": {2
   "idmailing_count": 1213140
   "client_idstatus": 1234"example content"
   "ordersend_idreminder": 6451350
   "parent_idprintshop": 0
   "typepayment_interface": 10
   "aidmd5": 231450"example content"
   "article_typeshow": 261
   "persdatajobname": "example content"
   "persdatapremium_interactive_arrayeditor": "example content"0
   "additionalpremium_fieldsimage_arrayupload": "example content"0
   "page_count": 1
   "cart_additional_fields_arraydownload_count": "example content"0
   "article_options_remark": "example content"
   "quantitypdf_download_only": 3701690
   "quantity_valuelocal_order_workflow_step_id": 10
   "remarkuploadpath": "example content"
   "filenamedirect_download": 0
   "example content""cart_addresses_array": 0
   "pdfserviceprovider_filenamesid": "example0
content"    "costserviceprovider_centerstatus": "example content"
   "mdateorder_number": 133
   "example content""do_not_calculate": 0
   "cdatepostage_graduation": "example content"0
   "rdateftp_checksum": "example content"
   "rftp_remarkdownload": "example0
content"    "rftp_shorterror": "example0
content"    "rdata_emailid": "example0
content"    "sstatus_descsendmail": "example1
content"    "s_quantity_valuereorder": 10
   "sarticle_cost_centerreorder": "example0
content"    "s_totalvoucher": "example0
content"    "svoucher_ntotalid": 10
   "svoucher_vatarray": 2"example content"
   "mailingapproval_address_countid": 0
   "statusmailing": "example content"0
   "sendreport_group_reminderid": 0
  }
 }
 "printshop": 0
   "payment_interface": 0
   "md5": "example content"
   "show": 1
   "jobname": "example content"
   "premium_interactive_editor": 0
   "premium_image_upload": 0
   "page_count": 1
   "download_count": 0
   "article_options": "example content"
   "pdf_download_only": 0
   "local_order_workflow_step_id": 0
   "uploadpath": "example content"
   "direct_download": 0
   "cart_addresses_array": 0
   "serviceprovider_id": 0
   "serviceprovider_status": "example content"
   "order_number": 133
   "do_not_calculate": 0
   "postage_graduation": 0
   "ftp_checksum": "example content"
   "ftp_download": 0
   "ftp_error": 0
   "data_id": 0
   "status_sendmail": 1
   "reorder": 0
   "article_reorder": 0
   "voucher": 0
   "voucher_id": 0
   "voucher_array": "example content"
   "approval_address_id": 0
   "mailing": 0
   "report_group_id": 0
  }
 }
}
Wobei type sein kann:

1: Article
2: Versand
3: Handling
4: Dienstleisterversand
5: Artikeloption
6: Artikel freies Kontingent
7: Artikel Lagerrückführung
8: Zusätzliche Gebühr für kleine Mengen
9: credit fpr handling cost
10: Kundendiscount
11: Payment
12: Artikeldiscpount
13: Kostenlose Position durch Admin hinzugefügt
14: Artikelbestellgebühr
15: Artikel dynamische Option
16: Postaktuell Artikel
17: Kostenübernahme
18: Werbezuschüsse
19: Zusätzlicher Aufpreis
101: Externer Artikel über OCI-Punchout empfangen

Bestellstatus

...

HTTP Methode

...

Pfad

...

Parameter

...

Request-Body

...

Beispiel

...

Zum Blättern:

  • limit
  • lastSeenId

Zum Filtern:

  • orderStatus
  • status
  • statusPaid

...

[
{
"id": 1235,
"internalOrderCode": "ABCDEG",
"orderCode": "MY4720",
"status": 1,
"orderStatus": 62,
"statusPaid": 1,
"lastModified": "2021-11-11 11:11:11",
"createDate": "2021-11-11 11:11:11"
},
{
"id": 1234,
"internalOrderCode": "ABCDEF",
"orderCode": "MY4710",
"status": 1,
"orderStatus": 61,
"statusPaid": 0,
"lastModified": "2020-11-11 11:11:11",
"createDate": "2020-11-11 11:11:11"
}
]
}

Wobei type sein kann:

1: Article
2: Versand
3: Handling
4: Dienstleisterversand
5: Artikeloption
6: Artikel freies Kontingent
7: Artikel Lagerrückführung
8: Zusätzliche Gebühr für kleine Mengen
9: credit fpr handling cost
10: Kundendiscount
11: Payment
12: Artikeldiscpount
13: Kostenlose Position durch Admin hinzugefügt
14: Artikelbestellgebühr
15: Artikel dynamische Option
16: Postaktuell Artikel
17: Kostenübernahme
18: Werbezuschüsse
19: Zusätzlicher Aufpreis
101: Externer Artikel über OCI-Punchout empfangen

Bestellstatus

HTTP Methode

Pfad

Parameter

Request-Body

Beispiel

Rückgabeformat
GET/api/order/

Zum Blättern:

  • limit
  • lastSeenId

Zum Filtern:

  • orderStatus
  • status
  • statusPaid

/api/order/?limit=20&lastSeenId=4711&orderStatus=61&status=1&statusPaid=1
[
{
"id": 1235,
"internalOrderCode": "ABCDEG",
"orderCode": "MY4720",
"status": 1,
"orderStatus": 62,
"statusPaid": 1,
"lastModified": "2021-11-11 11:11:11",
"createDate": "2021-11-11 11:11:11"
},
{
"id": 1234,
"internalOrderCode": "ABCDEF",
"orderCode": "MY4710",
"status": 1,
"orderStatus": 61,
"statusPaid": 0,
"lastModified": "2020-11-11 11:11:11",
"createDate": "2020-11-11 11:11:11"
}
]
GET/api/order/{order-code}-
https://shop.printlounge.local/api/order
{
 "order_code": "XABCDE"
 "order_status": 61
}
PUT/PATCH/api/order/{order-code}-{"order_status":"137"}http://shop.printlounge.local/api/order/39293

Die folgende Tabelle stellt alle möglichen Statuswerte dar: 

StatusBezeichnung
61in Produktion
62im Versand
63geliefert
69Storno
73auf Freigabe warten
74Freigabe abgelehnt
88Freigabe erteilt
117erledigt
137abgerechnet
140warte auf Zahlungsanbieter
144warte auf Kostenfreigabe

Addressen

HTTP Methode

Pfad

Parameter

Request-Body

Beispiel

Rückgabeformat
GET

/api/order/{{OrderCode}}/addresses/deliver

/api/order/{{OrderCode}}/addresses/invoice

-


/api/order/RQREJC/addresses/deliver

/api/order/RQREJC/addresses/invoice

{
"company1": "Firma",
"company2": "Firma2",
"company3": null,
"name": "Ansprechpartner",
"firstName": "",
"lastName": "",
"title": "",
"street": "Street",
"zip": "12345",
"town": "Stadt",
"country": "Deutschland",
"countryCode": "DE",
"email": "mail@lead-print.com",
"department": null,
"telephone": "",
"fax": null
}

PUT/PATCH

/api/order/{{OrderCode}}/addresses/deliver

/api/order/{{OrderCode}}/addresses/invoice

-{
"company1": "Firma",
"company2": "Firma2",
"company3": null,
"name": "Ansprechpartner",
"firstName": "",
"lastName": "",
"title": "",
"street": "Street",
"zip": "12345",
"town": "Stadt",
"country": "Deutschland",
"countryCode": "DE",
"email": "mail@lead-print.com",
"department": null,
"telephone": "",
"fax": null
}

/api/order/RQREJC/addresses/deliver

/api/order/RQREJC/addresses/invoice

true



Wenn die Daten nicht valide sind:

{
    "success": false,
    "message": "Validation errors",
    "data": {
        "countryCode": [
            "validation.size.string"
         ]
    }
}



Wenn keine Daten übermittelt wurden:

{
    "success": false,
    "message": "no data to found",
    "data": []
}


Tracking/Sendungsverfolgung

...

HTTP Methode

Pfad

Parameter

Request-Body

Beispiel

Rückgabeformat
GET/api/cart-item/{cart-item-id}

http://shop.printlounge.local
/api/cart-item/4711
{
"id": "4711",
"client_id": "42",
"order_id": "123",
"parent_id": "4710",
"type": "5",
"aid": "0",
"article_type": "0",
"persdata": "",
"persdata_array": "",
"additional_fields_array": "",
"cart_additional_fields_array": "",
"article_options_remark": "",
"quantity": "1",
"quantity_value": "1",
"remark": "",
"filename": "",
"pdf_filenames": "",
"cost_center": "",
"mdate": "2021-08-12 16:09:08",
"cdate": "2021-08-10 11:18:18",
"rdate": "0000-00-00 00:00:00",
"r_remark": null,
"r_short": "",
"r_email": "",
"s_desc": "B-Option: Eins",
"s_quantity_value": "1 St\u00fcck",
"s_cost_center": "",
"s_total": "\u00a3 1,00",
"s_ntotal": "100",
"s_vat": "1",
"mailing_count": "0",
"status": "OK",
"send_reminder": "0",
"printshop": "0",
"payment_interface": "0",
"md5": "4b0c123b9ae682cd9b57224e90a651bf",
"show": "1",
"jobname": "",
"premium_interactive_editor": "0",
"premium_image_upload": "0",
"page_count": "0",
"download_count": "0",
"article_options": "",
"pdf_download_only": "0",
"local_order_workflow_step_id": "0",
"uploadpath": "",
"direct_download": "0",
"cart_addresses_array": "0",
"serviceprovider_id": "80882",
"serviceprovider_status": "new",
"order_number": "0",
"do_not_calculate": "0",
"postage_graduation": "0",
"ftp_checksum": "",
"ftp_download": "0",
"ftp_error": "0",
"data_id": "0",
"status_sendmail": "1",
"reorder": "0",
"article_reorder": "0",
"voucher": "0",
"voucher_id": "0",
"voucher_array": "",
"approval_address_id": "0",
"mailing": "0",
"report_group_id": "0"
}

Infos

HTTP Methode

Pfad

Parameter

Request-Body

Beispiel

Rückgabeformat
GET/api/cart-item/{cart-item-id}/info

https://dev.localhost/api/cart-item/4711/info
[
{
"name": "articleOptionId",
"value": 5692
},
{
"name": "sapNumber",
"value": "mySAP-1"
}
]
GET/api/cart-item/{cart-item-id}/info/sapNumber

https://dev.localhost/api/cart-item/4711/info/sapNumber
"mySAP-1"

DHL Mailoptimizer/Portooptimierung

...

HTTP MethodePfadParameterBeispielRückgabeformat
GET/api/article-option/printfile/{option_id}
http://shop.printlounge.local/api/article-option/printfile/56269

{
"link": "shop.printlounge.local",
"file": "56269_test.pdf"
}

POST/api/article-option/printfile/{option_id}

link

file

http://t.printlounge.local/api/article-option/printfile/56269

{
"status": "OK"
}

Rückgabewerte/Response codes

...