Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

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": 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"
 "invoice_address_company2": "example content"
 "invoice_address_company3": "example content"
 "invoice_address_title": "example content"
 "invoice_address_name": "example content"
 "invoice_address_firstname": "example content"
 "invoice_address_lastname": "example content"
 "invoice_address_phone": "example content"
 "invoice_address_street": "example content"
 "invoice_address_zip": 12345
 "invoice_address_town": "example content"
 "invoice_address_country": "example content"
 "invoice_address_country_code": "example content"
 "order_customer_user_id": 984563
 "order_user_name": "example content"
 "serviceprovider_id": 0
 "serviceprovider_x_id": 0
 "serviceprovider_status": "example content"
 "cart_table": 1
 "order_express_delivery": 0
 "order_express_delivery_surcharge": "example content"
 "order_delivery_method": "example content"
 "order_comment": "example content"
 "order_budget_before": 0.00
 "order_budget_booking": 0.00
 "order_budget_booking_after": 0.00
 "order_status": 62
 "order_delivery_date": "example content"
 "packages": 0
 "weight": 0
 "barcode": "example content"
 "order_approval": "example content"
 "approval_email": "example content"
 "order_approval_explaination": "example content"
 "pdate": "example content"
 "sdate": "example content"
 "mdate": "example content"
 "cdate": "example content"
 "status": 3
 "status_paid": 0
 "date_paid": "example content"
 "status_sendmail": 1
 "opentrans_status": 0
 "printshop": 0
 "order_type_print_job": 1
 "order_type_pdf": 0
 "emailing_name": "example content"
 "emailing_email": "example content"
 "emailing_additional_text": "example content"
 "invoice_number": 0
 "individual_order_code": "example content"
 "individual_order_item_code": 0
 "individual_invoice_number": "example content"
 "individual_order_item_code_invoice": 0
 "coupon_code": 0
 "payment_interface": 0
 "md5_order_consolidation": 0
 "md5": "example content"
 "collective_price_scale": 0
 "approved_by": "example content"
 "order_language": "example content"
 "order_budged": "example content"
 "shipping_charges": 9.99
 "vat_amount": 0.00
 "net_amount": 10.00
 "gross_amount": 10.00
 "auth_micropayment": "example content"
 "budgedgroup_discount": 0
 "budgedgroup_discount_amount": "example content"
 "position_feedback": 0
 "vat_included": 54
 "date_of_invoice": "example content"
 "cartItems":  {
  "1": {
   "id": 121314
   "client_id": 1234
   "order_id": 645135
   "parent_id": 0
   "type": 1
   "aid": 231450
   "article_type": 26
   "persdata": "example content"
   "persdata_array": "example content"
   "additional_fields_array": "example content"
   "cart_additional_fields_array": "example content"
   "article_options_remark": "example content"
   "quantity": 370169
   "quantity_value": 1
   "remark": "example content"
   "filename": "example content"
   "pdf_filenames": "example content"
   "cost_center": "example content"
   "mdate": "example content"
   "cdate": "example content"
   "rdate": "example content"
   "r_remark": "example content"
   "r_short": "example content"
   "r_email": "example content"
   "s_desc": "example content"
   "s_quantity_value": 1
   "s_cost_center": "example content"
   "s_total": "example content"
   "s_ntotal": 1
   "s_vat": 2
   "mailing_count": 0
   "status": "example content"
   "send_reminder": 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

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

...