{"openapi":"3.0.0","components":{"schemas":{"address_object":{"title":"Address","properties":{"street":{"description":"The street name of the address.","type":"string","maxLength":255,"example":"Pearyweg"},"house_number":{"description":"The house number of the address.","type":"integer","format":"int32","example":128,"nullable":true},"house_number_supplement":{"description":"The house number supplement of the address.","type":"string","maxLength":64,"example":"B"},"postal_code":{"description":"The postal code of the address.","type":"string","maxLength":64,"example":"4462 GT"},"city":{"description":"The city name of the address.","type":"string","maxLength":128,"example":"Goes"},"country":{"description":"The country of the address.","format":"Country","nullable":true,"allOf":[{"$ref":"#/components/schemas/country_object"}]}},"type":"object"},"article_group_object":{"title":"ArticleGroup","properties":{"external_reference":{"description":"The external (third-party) reference of the article group.","type":"string","maxLength":64,"example":"167"},"name":{"description":"The name of the article group.","type":"string","maxLength":255,"example":"GSM"}},"type":"object"},"attachment_object":{"title":"Attachment","required":["mime_type","file_name","content"],"properties":{"mime_type":{"description":"The mime type of the document.","type":"string","maxLength":255,"enum":["application/pdf","image/jpeg","image/png","text/csv"],"example":"application/pdf"},"file_name":{"description":"The file name of the document.","type":"string","maxLength":80,"example":"example.pdf"},"content":{"description":"The base64 encoded content of the document.
_Approximately 16MB in raw format (when not encoded in base64)._","type":"string","format":"byte","maxLength":22369624,"example":"SGVsbG8gd29ybGQ="}},"type":"object"},"brand_object":{"title":"Brand","properties":{"external_reference":{"description":"The external (third-party) reference of the brand.","type":"string","maxLength":64,"example":"177","nullable":true},"name":{"description":"The name of the brand.","type":"string","maxLength":255,"example":"Samsung"}},"type":"object"},"country_object":{"title":"Country","properties":{"code":{"description":"ISO 3166-1 alpha-2 country code.","type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","example":"NL"},"name":{"description":"Human-readable name for the country.","type":"string","maxLength":128,"example":"Nederland"}},"type":"object"},"customer_object":{"title":"Customer","required":["name","address","email","phoneNumber"],"properties":{"name":{"description":"The name of the customer.","type":"string","maxLength":255,"example":"John Doe"},"address":{"description":"The address of the customer.","format":"Address","allOf":[{"$ref":"#/components/schemas/address_object"}]},"email":{"description":"The email of the customer.","type":"string","maxLength":254,"example":"example@domain.com"},"phone_number":{"description":"The phone number of the customer.","type":"string","maxLength":255,"example":"+31612345678"}},"type":"object"},"document_object":{"title":"Document","required":["mime_type","file_name","content"],"properties":{"mime_type":{"description":"The mime type of the document.","type":"string","maxLength":255,"enum":["application/pdf"],"example":"application/pdf"},"file_name":{"description":"The file name of the document.","type":"string","maxLength":80,"example":"example.pdf"},"content":{"description":"The base64 encoded content of the document.
_Approximately 16MB in raw format (when not encoded in base64)._","type":"string","format":"byte","maxLength":22369624,"example":"SGVsbG8gd29ybGQ="}},"type":"object"},"language_object":{"title":"Language","properties":{"code":{"description":"ISO 3166-1 alpha-2 country code.","type":"string","maxLength":2,"minLength":2,"pattern":"^[A-Z]{2}$","example":"NL"},"name":{"description":"Human-readable name for the language.","type":"string","maxLength":128,"example":"Nederlands"},"locale":{"description":"The locale for the language. This value consists out of a language code (ISO 639-1) and country code (ISO 3166-1 alpha-2) divided by an underscore.","type":"string","maxLength":5,"minLength":5,"pattern":"^[a-z]{2}_[A-Z]{2}$","example":"nl_NL"}},"type":"object"},"price_object":{"title":"Price","properties":{"amount":{"description":"The price amount.","type":"number","format":"float"},"currency":{"description":"ISO 4217 currency code.","type":"string","maxLength":3,"minLength":3,"pattern":"^[a-zA-Z]{3}$","example":"EUR"}},"type":"object"},"product_object":{"title":"Product","properties":{"model_number":{"description":"The model number of the product.","type":"string","maxLength":255,"example":"GALAXY S10E PRISM GREEN 128GB"},"article_number":{"description":"The store's article number of the product.","type":"string","maxLength":64,"example":"1604855","nullable":true},"eans":{"description":"All of the EAN numbers associated with the product.","type":"array","items":{"type":"string"},"example":["2000016048551"]},"serial_number":{"description":"The serial number or the IMEI number of the product.
_For mobile phones this field may contain the IMEI number. For all other products this will contain the serial number._","type":"string","maxLength":64,"example":"A12BC34056D","nullable":true},"brand":{"description":"The brand of the product.","format":"Brand","nullable":true,"allOf":[{"$ref":"#/components/schemas/brand_object"}]},"article_group":{"description":"The article group of the product.","format":"ArticleGroup","nullable":true,"allOf":[{"$ref":"#/components/schemas/article_group_object"}]},"accessories":{"description":"The accessories that are included with the product.","type":"string","maxLength":65536,"example":"Charger, Charging cable, Earbuds","nullable":true},"conditions":{"description":"The conditions of the product.","type":"array","items":{"enum":["new","undamaged","scratched","dents","cracks","fingerprints","dirty","unable_to_determine_condition"]},"example":["new","undamaged"]},"purchase":{"description":"Purchase information for the product.","format":"Purchase","allOf":[{"$ref":"#/components/schemas/product_purchase_object"}]},"sales":{"description":"Sales information for the product.","format":"Sales","allOf":[{"$ref":"#/components/schemas/product_sales_object"}]},"insurance":{"description":"The insurance of the product.","format":"Insurance","nullable":true,"allOf":[{"$ref":"#/components/schemas/task_insurance_object"}]}},"type":"object"},"product_purchase_object":{"title":"Purchase","properties":{"invoice_number":{"description":"The invoice number of the purchased product.
_Note: This field only contains data when requested by the supplier of the product._","type":"string","maxLength":64,"example":"5313519321","nullable":true},"price":{"description":"The price at which the product was purchased for by the store, excluding VAT.
_Note: This field only contains data when requested by the supplier of the product._","format":"Price","example":{"amount":532.95,"currency":"EUR"},"nullable":true,"allOf":[{"$ref":"#/components/schemas/price_object"}]},"supplier":{"description":"The supplier of the purchased product.","format":"Supplier","nullable":true,"allOf":[{"$ref":"#/components/schemas/supplier_object"}]}},"type":"object"},"product_sales_object":{"title":"Sales","properties":{"proof_of_purchase":{"description":"Whether there is a proof of purchase for the product.","type":"boolean"},"date":{"description":"The date at which the product was sold by the store. _The value will always be according to the RFC 3339 full-date format._","type":"string","format":"date","maxLength":10,"minLength":10,"example":"2020-01-01","nullable":true},"sales_reference":{"description":"The reference of the sales document.","type":"string","maxLength":45},"store":{"description":"The store where the product was purchased.","format":"Store","nullable":true,"allOf":[{"$ref":"#/components/schemas/store_object"}]}},"type":"object"},"referenced_task_attachment_collection_object":{"title":"ReferencedTaskAttachment","properties":{"reference":{"description":"The reference of the attachment.","type":"string","maxLength":36,"minLength":36,"example":"0b3e1638-7257-4d1d-854b-fdcf58d5cafe"},"type":{"description":"The type of the attachment.
_These are the currently available types, and may be extended in the future._","type":"string","maxLength":64,"enum":["damage_picture","sales_document","other"],"example":"damage_picture"},"iri":{"description":"The IRI to the attachment resource.","type":"string","maxLength":255,"example":"/v1/tasks/X123-1234567-R/attachments/0b3e1638-7257-4d1d-854b-fdcf58d5cafe"}},"type":"object"},"referenced_task_object":{"title":"ReferencedTask","properties":{"reference":{"description":"The reference of the task. In the Netherlands, Belgium and Luxembourg (BNL) the format is different.
_For example; WB12345678 (BNL), X123-1234567-R (International)_","type":"string","maxLength":20,"example":"X123-1234567-R"},"iri":{"description":"The IRI to the task resource.","type":"string","maxLength":255,"example":"/v1/tasks/X123-1234567-R"}},"type":"object"},"referenced_task_message_attachment_object":{"title":"ReferencedTaskMessageAttachment","properties":{"reference":{"description":"The reference of the attachment.","type":"string","maxLength":36,"minLength":36,"example":"0b3e1638-7257-4d1d-854b-fdcf58d5cafe"},"iri":{"description":"The IRI to the attachment resource.","type":"string","maxLength":255,"example":"/v1/tasks/X123-1234567-R/attachments/0b3e1638-7257-4d1d-854b-fdcf58d5cafe"}},"type":"object"},"referenced_task_message_object":{"title":"ReferencedTaskMessage","properties":{"reference":{"description":"The reference of the message.","type":"string","maxLength":36,"example":"123456789"},"iri":{"description":"The IRI to the message resource.","type":"string","maxLength":255,"example":"/v1/tasks/X123-1234567-R/messages/123456789"}},"type":"object"},"referenced_task_message_webhook_object":{"title":"ReferencedTaskMessageWebhook","properties":{"reference":{"description":"The reference of the message.","type":"string","maxLength":36,"example":"123456789"},"iri":{"description":"The IRI to the message resource.","type":"string","example":"/v1/tasks/X123-1234567-R/messages/123456789"},"task":{"description":"The task of the message.","format":"ReferencedTask","allOf":[{"$ref":"#/components/schemas/referenced_task_object"}]}},"type":"object"},"referenced_transfer_object":{"title":"ReferencedTransfer","properties":{"reference":{"description":"The reference of the transfer.","type":"string","maxLength":20,"pattern":"^([0-9A-Z]{4})-(\d{5}|\d{7})-([A-Z]{1,3})$","example":"X001-T-100001"},"iri":{"description":"The IRI to the transfer resource.","type":"string","example":"/v1/transfers/X001-T-100001"}},"type":"object"},"referenced_transfer_with_type_object":{"title":"ReferencedTransfer","properties":{"reference":{"description":"The reference of the transfer.","type":"string","maxLength":20,"pattern":"^([0-9A-Z]{4})-(\d{5}|\d{7})-([A-Z]{1,3})$","example":"X001-T-100001"},"type":{"description":"The type of the transfer.","type":"string","maxLength":64,"enum":["return_to_vendor"],"example":"return_to_vendor"},"iri":{"description":"The IRI to the transfer resource.","type":"string","maxLength":255,"example":"/v1/transfers/X001-T-100001"}},"type":"object"},"referenced_waybill_object":{"title":"ReferencedWaybill","properties":{"reference":{"description":"The reference of the waybill.","type":"string","maxLength":13,"minLength":13,"pattern":"^WB\-[0-9]{10}$","example":"WB-1234567890"},"iri":{"description":"The IRI to the waybill resource.","type":"string","example":"/v1/waybills/WB-1234567890"}},"type":"object"},"relation_object":{"title":"Relation","properties":{"name":{"description":"The name of the relation.","type":"string","maxLength":255,"example":"Zes Goes B.V."},"address":{"description":"The address of the relation.","format":"Address","allOf":[{"$ref":"#/components/schemas/address_object"}]}},"type":"object"},"repair_object":{"title":"Repair","properties":{"complaint_description":{"description":"Description on the issue of the repair.","type":"string","maxLength":65536,"example":"Phone does boot, however the screen stays black."},"doa":{"description":"Whether the product is dead/defect upon arrival at the customer.","type":"boolean","example":false},"refurbish":{"description":"Whether the product is to be refurbished once the repair is completed.","type":"boolean","example":false},"invoiced":{"description":"Whether the product is or is going to be invoiced to the supplier, or whether the credit note of the supplier is or is going to be processed.","type":"boolean","example":false},"rma_reference":{"description":"The RMA reference of the repair.","type":"string","maxLength":64,"example":"2020010117072512345067","nullable":true},"return_reference":{"description":"The reference assigned by the external system to the transfer to track the goods flow.","type":"string","maxLength":64,"example":"190123456","nullable":true},"return_invoice_reference":{"description":"The reference of the invoice connected to the transfer to track the financial flow.","type":"string","maxLength":64,"example":"15123","nullable":true},"product":{"description":"The product of the repair.","format":"Product","allOf":[{"$ref":"#/components/schemas/product_object"}]},"service_conditions":{"description":"The service conditions applicable to this repair.","format":"ServiceConditions","nullable":true,"allOf":[{"$ref":"#/components/schemas/service_conditions_object"}]},"service_center":{"description":"The service center of the repair.","format":"ServiceCenter","nullable":true,"allOf":[{"$ref":"#/components/schemas/service_center_object"}]},"turn_around_time":{"description":"The turn-around-time information for the repair","format":"TurnAroundTime","allOf":[{"$ref":"#/components/schemas/turn_around_time"}]},"ownership":{"description":"The party that owns the product.","type":"string","enum":["CUSTOMER","RETAILER"],"example":"CUSTOMER"}},"type":"object"},"return_classification_object":{"title":"ReturnClassification","properties":{"code":{"description":"The code of the return classification","type":"string","maxLength":40,"example":"A"},"quality_code":{"description":"The quality code of the return classification","type":"string","maxLength":45,"example":"QUAA"}},"type":"object"},"return_object":{"title":"Return","properties":{"classification":{"description":"The classification of the return.","format":"ReturnClassification","nullable":true,"allOf":[{"$ref":"#/components/schemas/return_classification_object"}]},"description":{"description":"The description of the return.","type":"string","maxLength":65536,"example":"Wrong product","nullable":true},"product":{"description":"The product of the return.","format":"Product","allOf":[{"$ref":"#/components/schemas/product_object"}]}},"type":"object"},"service_center_object":{"title":"ServiceCenter","properties":{"external_reference":{"description":"The external (third-party) reference of the service center.","type":"string","maxLength":16,"example":"512373"},"name":{"description":"The name of the service center.","type":"string","maxLength":255,"example":"ZES B.V."},"address":{"description":"The address of the service center.","format":"Address","allOf":[{"$ref":"#/components/schemas/address_object"}]}},"type":"object"},"service_center_turn_around_time":{"title":"ServiceCenterTurnAroundTime","properties":{"maximum_days":{"description":"The number of days the service center has to complete the repair before it will be invoiced.","type":"integer","format":"int32","example":15},"working_days":{"description":"The amount of days the repair has already been worked on.","type":"integer","format":"int32","example":2},"remaining_days":{"description":"The amount of days remaining.","type":"integer","format":"int32","example":13},"day_counter_active":{"description":"Is the day counter currently running.","type":"boolean","example":true}},"type":"object"},"service_conditions_object":{"title":"ServiceConditions","properties":{"procedure":{"description":"The procedure of the repair's service condition","enum":["ask_for_photos","credit","credit_and_destroy_at_store","credit_and_destroy_at_hub","credit_batch","credit_second_life","debit","debit_and_destroy_at_store","debit_and_destroy_at_hub","destroy_at_hub_and_write_off_store","exchange","exchange_at_store","homeservice","inform_and_ask_for_confirmation","no_repair","pickup_and_return","repair","repair_and_credit","repair_at_store","retailer_contacts_customer","return_to_vendor_credit","return_to_vendor_destroy_credit","return_to_vendor_destroy_invoice","return_to_vendor_invoice","return_to_warehouse","return_to_warehouse_order_new","supplier_contacts_customer","test_and_credit","test_and_invoice","test_and_swap","write_off_after_registration"],"example":"repair"},"warranty_type":{"description":"The warranty type of the repair's service condition.","type":"string","maxLength":64,"enum":["doa","in_warranty","out_of_warranty","extra_warranty","refurbish","insurance","extra_warranty_and_insurance"],"example":"out_of_warranty"}},"type":"object"},"service_conditions_procedure":{"title":"ServiceConditionsProcedure","type":"object"},"store_object":{"title":"Store","properties":{"external_reference":{"description":"The external (third-party) reference of the store.","type":"string","maxLength":16,"example":"X123","nullable":true},"name":{"description":"The name of the store.","type":"string","maxLength":255,"example":"MediaMarkt Schul"},"address":{"description":"The address of the store.","format":"Address","allOf":[{"$ref":"#/components/schemas/address_object"}]},"language":{"description":"The language of the store.","format":"Language","allOf":[{"$ref":"#/components/schemas/language_object"}]}},"type":"object"},"success_object":{"title":"success","properties":{"_success":{"description":"Indicates that the request has been handled successfully.","type":"boolean"}},"type":"object"},"supplier_object":{"title":"Supplier","properties":{"external_reference":{"description":"The external (third-party) reference of the supplier.","type":"string","maxLength":16,"example":"897413"},"name":{"description":"The name of the supplier.","type":"string","maxLength":255,"example":"SAMSUNG ELECTRONICS BENELUX B.V."},"address":{"description":"The address of the supplier.","format":"Address","allOf":[{"$ref":"#/components/schemas/address_object"}]}},"type":"object"},"create_supplier_invoice_object":{"title":"CreateSupplierInvoice","required":["number","lines"],"properties":{"number":{"description":"The number of the invoice.","type":"string","maxLength":80,"example":"12345"},"invoiced_at":{"description":"The date-time at which the invoice was created. _The value must be according to the RFC 3339 date-time format._","type":"string","format":"date-time","maxLength":32,"example":"2021-01-01T13:01:20Z","nullable":true},"lines":{"description":"The lines present on the invoice.","type":"array","items":{"$ref":"#/components/schemas/create_supplier_invoice_line_object"}}},"type":"object"},"create_supplier_invoice_line_object":{"title":"CreateSupplierInvoiceLine","required":["brand_name","serial_number","ean","levy","vat_reverse_charge"],"properties":{"number":{"description":"The number of the invoice line.","type":"string","maxLength":80,"example":"12345","nullable":true},"brand_name":{"description":"The name of the brand of the product.","type":"string","maxLength":80,"example":"Samsung"},"serial_number":{"description":"The serial number or the IMEI number of the product.
_For mobile phones the IMEI number must be provided. For all other products the serial number must be provided._","type":"string","maxLength":80,"minLength":4,"example":"5L729B78A0007"},"model_number":{"description":"The model number of the product.","type":"string","maxLength":80,"example":"R7000-100PES","nullable":true},"article_number":{"description":"The article number of the product.","type":"string","maxLength":80,"example":"2975952","nullable":true},"ean":{"description":"The EAN of the product.","type":"string","maxLength":13,"minLength":13,"example":"0606449099850"},"levy":{"description":"The levy of the product. 0.00 can be used if there is no levy.
_This must not include VAT._","type":"number","format":"float","example":0.99},"vat_reverse_charge":{"description":"Whether the VAT is reverse charged.","type":"boolean","example":false}},"type":"object"},"accept_task_rma_object":{"title":"AcceptTaskRma","properties":{"rma_reference":{"description":"The new RMA reference of the task.
_When this field is omitted or is given the value `null`, a number is generated._","type":"string","maxLength":28,"example":"2020010117072512345067","nullable":true}},"type":"object"},"AssignTaskRmaNumberObject":{"title":"AssignTaskRmaNumber","required":["rma_reference"],"properties":{"rma_reference":{"description":"The new RMA reference of the task.","type":"string","maxLength":28,"example":"2020010117072512345067"}},"type":"object"},"ChangeTaskStatusObject":{"title":"ChangeTaskStatus","required":["status"],"properties":{"status":{"description":"The new status of the repair.","type":"string","enum":["REPAIR_RECEIVED_AT_SERVICE_CENTER","REPAIR_STARTED","REPAIR_PAUSED","REPAIR_CONTINUED","REPAIR_FINISHED","RETAILER_FEEDBACK_REQUESTED","SPARE_PARTS_ORDERED","SERVICE_CENTER_CREDIT_NOTE_CREATED","SERVICE_CENTER_COST_ESTIMATE_CREATED","REPAIR_SHIPPED_FROM_SERVICE_CENTER"],"example":"REPAIR_RECEIVED_AT_SERVICE_CENTER"},"message":{"description":"Additional information can be added here, this will be added to the repair flow in ZIR.","type":"string","maxLength":5000,"minLength":3,"example":"The repair has been received at the service center.","nullable":true},"attachments":{"description":"Attachments relevant to this status change notification.","type":"array","items":{"$ref":"#/components/schemas/attachment_object"}}},"type":"object"},"decline_task_rma_object":{"title":"DeclineTaskRma","required":["reason"],"properties":{"reason":{"description":"The reason why the RMA is declined for the task.
_These are the currently available reasons and may be extended in the future._","type":"string","maxLength":64,"enum":["not_bought_at_us","incorrect_rma_procedure","wrong_workshop","not_covered_by_warranty","insufficient_data"],"example":"insufficient_data"},"insufficient_data":{"description":"Specify which data provided is insufficient.
_Note: Mandatory when the reason for declining is insufficient data._
_These are the currently available options, and may be extended in the future._","type":"array","items":{"type":"string","enum":["brand","type","article_number","serial_number","ean","accessories","purchase_date"]},"uniqueItems":true,"example":["brand","type"]}},"type":"object"},"search_task_object":{"title":"SearchTask","required":["country_code","type"],"properties":{"type":{"description":"the task type.","type":"string","maxLength":64,"enum":["repair","return"],"example":"repair"},"reference_type":{"description":"the reference type","type":"string","maxLength":64,"enum":["external_warehouse_location"],"example":"external_warehouse_location","nullable":true},"_order":{"type":"string","maxLength":64,"enum":["asc","desc"],"example":"ASCENDING"}},"type":"object"},"task_flow_message_answer_object":{"title":"TaskFlowAnswer","required":["message"],"properties":{"message":{"description":"The answer to the question.","type":"string","maxLength":5000,"minLength":3,"example":"This is a reply to a question"},"attachments":{"description":"Attachments relevant to this message.","type":"array","items":{"$ref":"#/components/schemas/attachment_object"}}},"type":"object"},"task_flow_message_object":{"title":"TaskFlowMessage","required":["type","recipient","message"],"properties":{"type":{"description":"The type of the message.","type":"string","maxLength":64,"enum":["question","notification"],"example":"question"},"recipient":{"description":"Who is the message directed at.","type":"string","maxLength":64,"enum":["store","headquarters","cluster"],"example":"store"},"message":{"description":"The message or question.","type":"string","maxLength":5000,"minLength":3,"example":"I need to ask a question"},"attachments":{"description":"Attachments relevant to this message.","type":"array","items":{"$ref":"#/components/schemas/attachment_object"}}},"type":"object"},"task_quotation_object":{"title":"TaskQuotation","required":["description","document"],"properties":{"description":{"description":"A description of the quotation.","type":"string","maxLength":65536,"example":"Screen needs to be replaced"},"document":{"description":"The quotation document.","format":"Document","allOf":[{"$ref":"#/components/schemas/document_object"}]}},"type":"object"},"task_repair_invoice_object":{"title":"TaskRepairInvoice","required":["description","cost","document"],"properties":{"description":{"description":"A description of the repair invoice.","type":"string","maxLength":65536,"example":"Screen has been replaced."},"cost":{"description":"The total cost of the repair invoice.
_This must not include VAT._","type":"number","format":"float","example":128.5},"document":{"description":"The repair invoice document.","format":"Document","allOf":[{"$ref":"#/components/schemas/document_object"}]}},"type":"object"},"update_task_product_object":{"title":"UpdateTaskProduct","properties":{"serial_number":{"description":"The serial number or the IMEI number of the product.
_For mobile phones the IMEI number must be provided. For all other products the serial number must be provided._","type":"string","maxLength":64,"example":"5L729B78A0007"}},"type":"object"},"task_attachment_object":{"title":"TaskAttachment","properties":{"reference":{"description":"The reference of the attachment.","type":"string","maxLength":36,"minLength":36,"example":"0b3e1638-7257-4d1d-854b-fdcf58d5cafe"},"type":{"description":"The type of the attachment.
_These are the currently available types, and may be extended in the future._","type":"string","maxLength":64,"enum":["damage_picture","sales_document","other"],"example":"damage_picture"},"mime_type":{"description":"The mime type of the attachment.","type":"string","maxLength":255,"example":"image/jpeg"},"file_name":{"description":"The file name of the attachment.","type":"string","maxLength":80,"example":"example.jpg"},"content":{"description":"The base64 encoded content of the attachment.
_Approximately 16MB in raw format (when not encoded in base64)._","type":"string","format":"byte","maxLength":22369624,"example":"SGVsbG8gd29ybGQ="}},"type":"object"},"task_object":{"title":"Task","properties":{"reference":{"description":"The reference of the task. In the Netherlands, Belgium and Luxembourg (BNL) the format is different.
_For example; WB12345678 (BNL), X123-1234567-R (International)_","type":"string","maxLength":20,"example":"X123-1234567-R"},"internal_reference":{"description":"The internal ZIR reference of the task, also known as the task ID.
This reference can be used for scanning a barcode that can be found on documents such as waybills.","type":"integer","format":"int32","example":12345678},"references":{"description":"The references of the task.","type":"array","items":{"$ref":"#/components/schemas/task_reference_object"}},"type":{"description":"The type of the task.","type":"string","maxLength":64},"active":{"description":"Whether the task is active for the store.","type":"boolean","example":true},"attachments":{"description":"The attachments of the task.","type":"array","items":{"$ref":"#/components/schemas/referenced_task_attachment_collection_object"}},"transfers":{"description":"The transfers of which the task is a part of.","type":"array","items":{"$ref":"#/components/schemas/referenced_transfer_with_type_object"}},"store":{"description":"The store this task was created by.","format":"Store","allOf":[{"$ref":"#/components/schemas/store_object"}]},"preceded_by":{"description":"The previous task that is connected to this task.","nullable":true,"oneOf":[{"$ref":"#/components/schemas/referenced_task_object"}]},"succeeded_by":{"description":"A list of tasks this task is connected to.","type":"array","items":{"$ref":"#/components/schemas/referenced_task_object"}},"created_at":{"description":"The date-time at which the task was created. _The value will always be according to the RFC 3339 date-time format._","type":"string","format":"date-time","maxLength":32,"example":"2020-01-01T16:04:37Z"}},"type":"object","discriminator":{"propertyName":"type","mapping":{"repair":"#/components/schemas/task_repair_object","return":"#/components/schemas/task_return_object"}}},"task_repair_object":{"type":"object","allOf":[{"$ref":"#/components/schemas/task_object"},{"properties":{"repair":{"description":"The repair data of the task.","type":"object","format":"Repair","nullable":false,"allOf":[{"$ref":"#/components/schemas/repair_object"}]}},"type":"object"}]},"task_return_object":{"type":"object","allOf":[{"$ref":"#/components/schemas/task_object"},{"properties":{"return":{"description":"The return data of the task.","type":"object","format":"Return","nullable":false,"allOf":[{"$ref":"#/components/schemas/return_object"}]}},"type":"object"}]},"task_insurance_company_object":{"title":"InsuranceCompany","properties":{"external_reference":{"description":"The external (third-party) reference of the insurance company.","type":"string","maxLength":16,"example":"573127"},"name":{"description":"The name of the insurance company.","type":"string","maxLength":255,"example":"ALLIANZ VERSICHERUNGS-AG"}},"type":"object"},"task_insurance_object":{"title":"Insurance","properties":{"policy_number":{"description":"The policy number for the insurance.","type":"string","maxLength":64,"example":"00110.1012345","nullable":true},"claim_number":{"description":"The claim number for the insurance.","type":"string","maxLength":64,"example":"001239834214","nullable":true},"company":{"description":"The company that provides the insurance.","format":"InsuranceCompany","nullable":true,"allOf":[{"$ref":"#/components/schemas/task_insurance_company_object"}]}},"type":"object"},"task_location_object":{"title":"TaskLocation","properties":{"location":{"description":"The target warehouse location","type":"string","maxLength":11,"example":"01-01-01-01"}},"type":"object"},"task_message_object":{"title":"TaskMessage","properties":{"reference":{"description":"The reference of the message.","type":"string","maxLength":36,"example":"123456789"},"type":{"description":"The type of the message.
_These are the currently available types, and may be extended in the future._","type":"string","maxLength":64,"enum":["question","answer","notification"],"example":"question"},"message":{"description":"The content of the message.","type":"string","maxLength":5000},"attachments":{"description":"The attachments of the message.","type":"array","items":{"$ref":"#/components/schemas/referenced_task_message_attachment_object"}},"sender":{"description":"The sender of the message.","format":"TaskMessageRelation","allOf":[{"$ref":"#/components/schemas/task_message_relation_object"}]},"recipient":{"description":"The recipient of the message.","format":"TaskMessageRelation","nullable":true,"allOf":[{"$ref":"#/components/schemas/task_message_relation_object"}]},"parent":{"description":"The parent message of this message.","format":"ReferencedTaskMessage","nullable":true,"allOf":[{"$ref":"#/components/schemas/referenced_task_message_object"}]},"answers":{"description":"The answer message(s) to this message.","type":"array","items":{"$ref":"#/components/schemas/referenced_task_message_object"}},"created_at":{"description":"The date-time at which the message was created. _The value will always be according to the RFC 3339 date-time format._","type":"string","format":"date-time","maxLength":32,"example":"2020-01-01T16:04:37Z"}},"type":"object"},"task_message_relation_object":{"title":"TaskMessageRelation","properties":{"type":{"description":"The type of the relation.
_These are the currently available relation types, and may be extended in the future._","type":"string","maxLength":64,"enum":["cluster","headquarters","service_center","store","supplier"],"example":"store"},"name":{"description":"The name of the relation.","type":"string","maxLength":255,"example":"MediaMarkt Schul"}},"type":"object"},"task_reference_object":{"title":"TaskReference","properties":{"reference":{"description":"The reference.","type":"string","maxLength":255,"example":"LV-012345679-19700101000001"},"type":{"description":"The reference type.
_These are the currently available types, and may be extended in the future._","type":"string","maxLength":255,"enum":["external_warehouse_location"],"example":"external_warehouse_location"}},"type":"object"},"accept_transfer_rma_object":{"title":"AcceptTransferRma","properties":{"rma_reference":{"description":"The new RMA reference of the transfer.
_When this field is omitted or is given the value `null`, a number is generated._","type":"string","maxLength":28,"example":"2020010117072512345067","nullable":true}},"type":"object"},"decline_transfer_task_rma_object":{"title":"DeclineTransferTaskRma","required":["reason"],"properties":{"reason":{"description":"The reason as to why the RMA is declined for the specific task.
_These are the currently available reasons, and may be extended in the future._","type":"string","maxLength":64,"enum":["not_bought_at_us","incorrect_rma_procedure","wrong_workshop","not_covered_by_warranty","insufficient_data"],"example":"insufficient_data"},"insufficient_data":{"description":"Specify which data provided is insufficient.
_Note: Mandatory when the reason for declining is insufficient data._
_These are the currently available options, and may be extended in the future._","type":"array","items":{"type":"string","enum":["brand","type","article_number","serial_number","ean","accessories","purchase_date","price","documents"]},"uniqueItems":true,"example":["brand","type"]}},"type":"object"},"transfer_object":{"title":"Transfer","properties":{"reference":{"description":"The reference of the transfer.","type":"string","maxLength":20,"pattern":"^([0-9A-Z]{4})-T-(\d{6,})$","example":"X001-T-100001"},"type":{"description":"The type of the transfer.
_These are the currently available types, and may be extended in the future._","type":"string","maxLength":64,"enum":["return_to_vendor"],"example":"return_to_vendor"},"tasks":{"description":"The tasks on the transfer.","type":"array","items":{"$ref":"#/components/schemas/referenced_task_object"}},"return_reference":{"description":"The reference assigned by the external system to the transfer to track the goods flow.","type":"string","maxLength":64,"example":"190123456","nullable":true},"rma_reference":{"description":"The RMA reference of the transfer.","type":"string","maxLength":255,"example":"2020010112345433555310","nullable":true},"collection_task":{"oneOf":[{"$ref":"#/components/schemas/referenced_task_object"}],"nullable":true,"description":"The collective task for this transfer"},"financial_processing_type":{"description":"The financial processing type of the transfer.","type":"string","maxLength":64,"enum":["credit","invoice"],"example":"invoice"},"store_processing_type":{"description":"The store processing type of the transfer.","type":"string","maxLength":64,"enum":["send","destroy"],"example":"destroy"},"total_purchase_price":{"description":"The total purchase price of the tasks that are in the transfer.
_This price does not include VAT._","format":"Price","example":{"amount":532.95,"currency":"EUR"},"allOf":[{"$ref":"#/components/schemas/price_object"}]},"return_invoice_reference":{"description":"The reference of the invoice connected to the transfer to track the financial flow.","type":"string","maxLength":64,"example":"15123","nullable":true},"status":{"description":"The current status of the transfer","type":"string","maxLength":64,"enum":["created","requested","authorised","locked","created_in_external_system","sent","destroyed","cancelled","ready_to_send","ready_to_destroy","finished","ready_to_invoice","ready_to_credit","invoiced","credited","verify_credit","request_manually","awaiting_payout"],"example":"requested"},"requested_at":{"description":"The date-time at which the RMA was requested for the transfer. _The value will always be according to the RFC 3339 date-time format._","type":"string","format":"date-time","maxLength":32,"example":"2020-01-01T13:54:26Z","nullable":true}},"type":"object"},"transport_object":{"title":"Transporter","properties":{"external_reference":{"description":"The external reference of the transporter.","type":"string","maxLength":16,"example":"200110"},"name":{"description":"The name of the transporter.","type":"string","maxLength":255,"example":"GLS Netherlands"}},"type":"object"},"turn_around_time":{"title":"TurnAroundTime","properties":{"service_center":{"description":"Turn-around-time restrictions for the service center.","format":"ServiceCenterTurnAroundTime","allOf":[{"$ref":"#/components/schemas/service_center_turn_around_time"}]}},"type":"object"},"waybill_container_object":{"title":"WaybillContainer","properties":{"type":{"type":"string","maxLength":64,"enum":["trolley","pallet","cardboard_box","roll_container","parcel","shuttle_container","shuttle_box","smartphone_box","shuttle_crate","box","value_box","euro_crate_with_lid","bas_group_crate","unknown","collection_package","individual_package","collective_return_package"]},"tracking_reference":{"description":"The tracking reference of the waybill container.","type":"string","maxLength":45,"example":"1Z5W7E776834550358","nullable":true},"security_reference":{"description":"The security reference of the waybill container.","type":"string","maxLength":45,"example":"1234567","nullable":true},"tasks":{"description":"The tasks that are sent with the waybill container.","type":"array","items":{"$ref":"#/components/schemas/referenced_task_object"}}},"type":"object"},"waybill_object":{"title":"Waybill","properties":{"reference":{"description":"The reference of the waybill.","type":"string","maxLength":13,"minLength":13,"pattern":"^WB\-[0-9]{10}$","example":"WB-1234567890"},"sender":{"description":"The relation that sends the waybill.","format":"Relation","allOf":[{"$ref":"#/components/schemas/relation_object"}]},"receiver":{"description":"The relation that receives the waybill.","format":"Relation","allOf":[{"$ref":"#/components/schemas/relation_object"}]},"transporter":{"description":"The transporter that will ship the waybill.","format":"Transporter","nullable":true,"allOf":[{"$ref":"#/components/schemas/transport_object"}]},"containers":{"description":"The containers within the waybill.","type":"array","items":{"$ref":"#/components/schemas/waybill_container_object"}},"sent_at":{"description":"The date-time at which the waybill is sent. _The value will always be according to the RFC 3339 date-time format._","type":"string","format":"date-time","maxLength":32,"example":"2020-01-01T16:04:37Z","nullable":true}},"type":"object"},"create_connection_test_webhook_event_object":{"title":"CreateConnectionTestWebhookEvent","type":"object","allOf":[{"$ref":"#/components/schemas/create_webhook_event_object"}]},"create_task_message_webhook_event_object":{"title":"CreateTaskMessageWebhookEvent","type":"object","allOf":[{"$ref":"#/components/schemas/create_webhook_event_object"},{"properties":{"parameters":{"description":"The optional parameters that may be used to customize the payload of the event.
_If this field is not provided, or left empty, the default values are used._","format":"CreateTaskMessageWebhookEventParameters","nullable":true,"allOf":[{"$ref":"#/components/schemas/create_task_message_webhook_event_parameters_object"}]}},"type":"object"}]},"create_task_message_webhook_event_parameters_object":{"title":"CreateTaskMessageWebhookEventParameters","properties":{"message_reference":{"description":"The reference of the task message.","type":"string","maxLength":10,"example":"123456789"},"task_reference":{"description":"The reference of the task. In the Netherlands, Belgium and Luxembourg (BNL) the format is different.
_For example; WB12345678 (BNL), X123-1234567-R (International)_","type":"string","maxLength":20,"example":"X123-1234567-R"}},"type":"object"},"create_task_rma_request_webhook_event_object":{"title":"CreateTaskRmaRequestWebhookEvent","type":"object","allOf":[{"$ref":"#/components/schemas/create_webhook_event_object"},{"properties":{"parameters":{"description":"The optional parameters that may be used to customize the payload of the event.
_If this field is not provided, or left empty, the default values are used._","format":"CreateTaskRmaRequestWebhookEventParameters","nullable":true,"allOf":[{"$ref":"#/components/schemas/create_task_rma_request_webhook_event_parameters_object"}]}},"type":"object"}]},"create_task_rma_request_webhook_event_parameters_object":{"title":"CreateTaskRmaRequestWebhookEventParameters","properties":{"task_reference":{"description":"The reference of the task. In the Netherlands, Belgium and Luxembourg (BNL) the format is different.
_For example; WB12345678 (BNL), X123-1234567-R (International)_","type":"string","maxLength":20,"example":"X123-1234567-R"}},"type":"object"},"create_transfer_webhook_event_parameters_object":{"title":"CreateTransferWebhookEventParameters","properties":{"transfer_reference":{"description":"The reference of the transfer.","type":"string","default":"X001-T-100001","maxLength":20,"pattern":"^([0-9A-Z]{4})-T-(\d{6,})$","example":"X001-T-100001","nullable":true}},"type":"object"},"create_transfer_invoiced_webhook_event_object":{"title":"CreateTransferInvoicedWebhookEvent","type":"object","allOf":[{"$ref":"#/components/schemas/create_webhook_event_object"},{"properties":{"parameters":{"description":"The optional parameters that may be used to customize the payload of the event.
_If this field is not provided, or left empty, the default values are used._","format":"CreateTransferWebhookEventParameters","nullable":true,"allOf":[{"$ref":"#/components/schemas/create_transfer_webhook_event_parameters_object"}]}},"type":"object"}]},"create_transfer_rma_request_webhook_event_object":{"title":"CreateTransferRmaRequestWebhookEvent","type":"object","allOf":[{"$ref":"#/components/schemas/create_webhook_event_object"},{"properties":{"parameters":{"description":"The optional parameters that may be used to customize the payload of the event.
_If this field is not provided, or left empty, the default values are used._","format":"CreateTransferWebhookEventParameters","nullable":true,"allOf":[{"$ref":"#/components/schemas/create_transfer_webhook_event_parameters_object"}]}},"type":"object"}]},"create_waybill_announcement_webhook_event_object":{"title":"CreateWaybillAnnouncementWebhookEvent","type":"object","allOf":[{"$ref":"#/components/schemas/create_webhook_event_object"},{"properties":{"parameters":{"description":"The optional parameters that may be used to customize the payload of the event.
_If this field is not provided, or left empty, the default values are used._","format":"CreateWaybillAnnouncementWebhookEventParameters","nullable":true,"allOf":[{"$ref":"#/components/schemas/create_waybill_announcement_webhook_event_parameters_object"}]}},"type":"object"}]},"create_waybill_announcement_webhook_event_parameters_object":{"title":"CreateWaybillAnnouncementWebhookEventParameters","properties":{"waybill_reference":{"description":"The reference of the waybill.","type":"string","default":"WB-1234567890","maxLength":13,"minLength":13,"pattern":"^WB\-[0-9]{10}$","example":"WB-1234567890"}},"type":"object"},"create_webhook_event_object":{"title":"CreateWebhookEvent","properties":{"type":{"description":"The type of the webhook event.
_These are the currently available types and may be extended in the future._","type":"string","maxLength":64}},"type":"object","discriminator":{"propertyName":"type","mapping":{"task.rma_request":"#/components/schemas/create_task_rma_request_webhook_event_object","task.message":"#/components/schemas/create_task_message_webhook_event_object","transfer.rma_request":"#/components/schemas/create_transfer_rma_request_webhook_event_object","transfer.invoiced":"#/components/schemas/create_transfer_invoiced_webhook_event_object","waybill.announcement":"#/components/schemas/create_waybill_announcement_webhook_event_object","webhook.connection_test":"#/components/schemas/create_connection_test_webhook_event_object"}}},"referenced_webhook_object":{"title":"ReferencedWebhook","properties":{"id":{"description":"The unique identifier of the webhook.","type":"string","maxLength":36,"minLength":36,"example":"aed19637-cb55-44d9-9acb-b5fb5c656416"},"iri":{"description":"The IRI to the webhook resource.","type":"string","maxLength":255,"example":"/v1/webhooks/aed19637-cb55-44d9-9acb-b5fb5c656416"}},"type":"object"},"webhook_object":{"title":"Webhook","properties":{"id":{"description":"The unique identifier of the webhook.","maxLength":36,"minLength":36,"example":"aed19637-cb55-44d9-9acb-b5fb5c656416"},"label":{"description":"The label of the webhook.","type":"string","maxLength":255,"example":"My webhook"},"target_url":{"description":"The target url of the webhook. This is where webhook events will be send to.","type":"string","maxLength":255,"example":"https://example.com/callback"},"enabled":{"description":"Whether the webhook is enabled or disabled.","type":"boolean","example":true},"created_at":{"description":"The date-time at which the webhook was created. _The value will always be according to the RFC 3339 date-time format._","type":"string","format":"date-time","maxLength":32,"example":"2020-01-01T16:04:37Z"}},"type":"object"},"webhook_event_object":{"title":"WebhookEvent","properties":{"id":{"description":"The unique identifier of the webhook event.","maxLength":36,"minLength":36,"example":"7853a08d-d8c0-40e6-831c-46b09818757d"},"webhook":{"$ref":"#/components/schemas/referenced_webhook_object"},"type":{"description":"The type of the webhook event.","type":"string","maxLength":64,"enum":["task.rma_request","task.message","transfer.rma_request","transfer.invoiced","waybill.announcement","task.customer_return","webhook.connection_test"],"example":"task.rma_request"},"payload":{"description":"The payload of the webhook event.","type":"object","example":{"task":{"reference":"X123-1234567-R","iri":"/v1/tasks/X123-1234567-R"}}},"status":{"description":"The status of the webhook event.","type":"string","maxLength":32,"enum":["pending","succeeded","failed","suspended"],"example":"succeeded"},"created_at":{"description":"The date-time at which the webhook event was created. _The value will always be according to the RFC 3339 date-time format._","type":"string","format":"date-time","maxLength":32,"example":"2021-01-01T13:01:20Z"}},"type":"object"},"oauth_access_token_object":{"type":"object","properties":{"access_token":{"type":"string","maxLength":16384,"description":"An access token that must be used to authenticate.","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c"},"token_type":{"type":"string","maxLength":64,"enum":["bearer"],"description":"The type of the access token. Will always be "bearer".","example":"bearer"},"expires_in":{"type":"integer","description":"The time in seconds until the access token expires.","example":1800}}},"oauth_bad_request_error":{"description":"Bad Request","example":{"error":"invalid_request","error_description":"The request is missing parameter 'grant_type'."},"allOf":[{"$ref":"#/components/schemas/oauth_error"},{"type":"object","properties":{"error":{"enum":["invalid_request","unsupported_grant_type"]}}}]},"oauth_error":{"type":"object","properties":{"error":{"type":"string","description":"The type of the error."},"error_description":{"type":"string","description":"A short, human-readable, summary of the error."}}},"oauth_internal_server_error":{"description":"Internal Server Error","example":{"error":"server_error","error_description":"Internal server error."},"allOf":[{"$ref":"#/components/schemas/oauth_error"},{"type":"object","properties":{"error":{"enum":["server_error"]}}}]},"oauth_not_acceptable_error":{"description":"Not Acceptable","example":{"error":"invalid_request","error_description":"Content type "application/pdf" is not supported."},"allOf":[{"$ref":"#/components/schemas/oauth_error"},{"type":"object","properties":{"error":{"enum":["invalid_request"]}}}]},"oauth_too_many_requests_error":{"description":"Too Many Requests","example":{"error":"rate_limit_reached","error_description":"Too many requests have been received from your client."},"allOf":[{"$ref":"#/components/schemas/oauth_error"},{"type":"object","properties":{"error":{"enum":["rate_limit_reached"]}}}]},"oauth_unauthorized_error":{"description":"Unauthorized","example":{"error":"invalid_client","error_description":"The request contains invalid client credentials."},"allOf":[{"$ref":"#/components/schemas/oauth_error"},{"type":"object","properties":{"error":{"enum":["invalid_client"]}}}]},"missing_access_token_problem":{"title":"Missing access token","example":{"type":"/problems/unauthorized#missing-access-token","title":"You need to be authorized to make this request.","detail":"Access token not found in "Authorization" header of type "Bearer"."},"allOf":[{"$ref":"#/components/schemas/detailed_problem"},{"type":"object","properties":{"type":{"enum":["/problems/unauthorized#missing-access-token"]}}}]},"invalid_access_token_problem":{"title":"Invalid access token","example":{"type":"/problems/unauthorized#invalid-access-token","title":"You need to be authorized to make this request.","detail":"Access token is invalid."},"allOf":[{"$ref":"#/components/schemas/detailed_problem"},{"type":"object","properties":{"type":{"enum":["/problems/unauthorized#invalid-access-token"]}}}]},"expired_access_token_problem":{"title":"Expired access token","example":{"type":"/problems/unauthorized#expired-access-token","title":"You need to be authorized to make this request.","detail":"Access token is expired."},"allOf":[{"$ref":"#/components/schemas/detailed_problem"},{"type":"object","properties":{"type":{"enum":["/problems/unauthorized#expired-access-token"]}}}]},"forbidden_problem":{"title":"Forbidden","example":{"type":"/problems/forbidden","title":"You are forbidden from making this request."},"allOf":[{"type":"object","properties":{"type":{"enum":["/problems/forbidden"]}}},{"$ref":"#/components/schemas/problem"}]},"internal_server_error_problem":{"title":"Internal server error","example":{"type":"/problems/internal-server-error","title":"Internal server error."},"allOf":[{"$ref":"#/components/schemas/problem"},{"type":"object","properties":{"type":{"enum":["/problems/internal-server-error"]}}}]},"invalid_request_body_problem":{"title":"Invalid request body","example":{"type":"/problems/invalid-request-body","title":"The request body contains violations.","violations":[{"message":"This value should be of type string.","field":"foo"}]},"allOf":[{"$ref":"#/components/schemas/problem"},{"$ref":"#/components/schemas/validation_problem"},{"type":"object","properties":{"type":{"enum":["/problems/invalid-request-body"]}}}]},"invalid_request_query_problem":{"title":"Invalid query parameter","example":{"type":"/problems/invalid-request-query","title":"A query parameter contains violations.","violations":[{"message":"This value should be of type string.","field":"foo"}]},"allOf":[{"$ref":"#/components/schemas/problem"},{"$ref":"#/components/schemas/validation_problem"},{"type":"object","properties":{"type":{"enum":["/problems/invalid-request-query"]}}}]},"invalid_task_state_problem":{"title":"Invalid task state","allOf":[{"$ref":"#/components/schemas/detailed_problem"},{"type":"object","properties":{"type":{"enum":["/problems/invalid-task-state"]},"title":{"example":"The state of the task disallows the attempted action."}}}]},"invalid_transfer_state_problem":{"title":"Invalid transfer state","allOf":[{"$ref":"#/components/schemas/detailed_problem"},{"type":"object","properties":{"type":{"enum":["/problems/invalid-transfer-state"]},"title":{"example":"The state of the transfer disallows the attempted action."}}}]},"malformed_request_body_problem":{"title":"Malformed request body","example":{"type":"/problems/malformed-request-body","title":"The request body is malformed.","detail":"The request body can not be decoded."},"allOf":[{"$ref":"#/components/schemas/detailed_problem"},{"type":"object","properties":{"type":{"enum":["/problems/malformed-request-body"]}}}]},"problem":{"type":"object","properties":{"type":{"type":"string","format":"uri","description":"A relative URI that identifies the problem type.","default":"about:blank"},"title":{"type":"string","description":"A short summary of the problem type."}}},"detailed_problem":{"type":"object","properties":{"type":{"type":"string","format":"uri","description":"A relative URI that identifies the problem type.","default":"about:blank"},"title":{"type":"string","description":"A short summary of the problem type."},"detail":{"type":"string","description":"A detailed human-readable explanation about the occurrence of the problem."}}},"resource_not_found_problem":{"title":"Resource not found","example":{"type":"/problems/not-found#resource","title":"Not found.","detail":"The requested resource could not be found."},"allOf":[{"$ref":"#/components/schemas/detailed_problem"},{"type":"object","properties":{"type":{"enum":["/problems/not-found#resource"]}}}]},"unsupported_request_format_problem":{"title":"Unsupported request format","example":{"type":"/problems/unsupported-request-format","title":"The request contains an unsupported format.","detail":"The content type "application/csv" is not supported. Only the MIME type "application/json" is supported."},"allOf":[{"$ref":"#/components/schemas/detailed_problem"},{"type":"object","properties":{"type":{"enum":["/problems/unsupported-request-format"]}}}]},"unsupported_response_format_problem":{"title":"Unsupported response format","example":{"type":"/problems/unsupported-response-format","title":"The requested format is not supported.","detail":"The content type "application/csv" is not supported. Only the MIME type "application/json" is supported."},"allOf":[{"$ref":"#/components/schemas/detailed_problem"},{"type":"object","properties":{"type":{"enum":["/problems/unsupported-response-format"]}}}]},"validation_problem":{"type":"object","properties":{"violations":{"type":"array","description":"A list of violations.","items":{"$ref":"#/components/schemas/constraint_violation"}}}},"constraint_violation":{"type":"object","title":"ConstraintViolation","properties":{"message":{"type":"string","description":"A message describing the violation.","example":"This value should be of type string."},"field":{"type":"string","description":"The field at which the violation occurred at.","example":"foo"}}},"connection_test_webhook_event_object":{"type":"object","title":"ConnectionTestEvent","allOf":[{"$ref":"#/components/schemas/webhook_event_object"},{"properties":{"payload":{"format":"ConnectionTestEventPayload","allOf":[{"$ref":"#/components/schemas/connection_test_webhook_event_payload_object"}]}}}]},"connection_test_webhook_event_payload_object":{"type":"object","title":"ConnectionTestEventPayload"},"task_message_webhook_event_object":{"type":"object","title":"TaskMessageEvent","allOf":[{"$ref":"#/components/schemas/receive_webhook_event_object"},{"properties":{"payload":{"format":"TaskMessageEventPayload","allOf":[{"$ref":"#/components/schemas/task_message_webhook_event_payload_object"}]}}}]},"task_message_webhook_event_payload_object":{"type":"object","title":"TaskMessageEventPayload","properties":{"task_message":{"format":"ReferencedTaskMessageWebhook","description":"The message that has been added to a task.","allOf":[{"$ref":"#/components/schemas/referenced_task_message_webhook_object"}]}}},"task_rma_request_webhook_event_object":{"type":"object","title":"TaskRmaRequestEvent","allOf":[{"$ref":"#/components/schemas/receive_webhook_event_object"},{"properties":{"payload":{"format":"TaskRmaRequestEventPayload","allOf":[{"$ref":"#/components/schemas/task_rma_request_webhook_event_payload_object"}]}}}]},"task_rma_request_webhook_event_payload_object":{"type":"object","title":"TaskRmaRequestEventPayload","properties":{"task":{"format":"ReferencedTask","description":"The task a RMA is requested for.","allOf":[{"$ref":"#/components/schemas/referenced_task_object"}]}}},"transfer_invoiced_webhook_event_object":{"type":"object","title":"TransferInvoicedEvent","allOf":[{"$ref":"#/components/schemas/receive_webhook_event_object"},{"properties":{"payload":{"format":"TransferInvoicedEventPayloadSchema","allOf":[{"$ref":"#/components/schemas/transfer_invoiced_webhook_event_payload_object"}]}}}]},"transfer_invoiced_webhook_event_payload_object":{"type":"object","title":"TransferInvoicedEventPayloadSchema","properties":{"transfer":{"format":"ReferencedTransfer","description":"The transfer that has been invoiced.","allOf":[{"$ref":"#/components/schemas/referenced_transfer_object"}]}}},"transfer_rma_request_webhook_event_object":{"type":"object","title":"TransferRmaRequestEvent","allOf":[{"$ref":"#/components/schemas/receive_webhook_event_object"},{"properties":{"payload":{"format":"TransferRmaRequestEventPayload","allOf":[{"$ref":"#/components/schemas/transfer_rma_request_webhook_event_payload_object"}]}}}]},"transfer_rma_request_webhook_event_payload_object":{"type":"object","title":"TransferRmaRequestEventPayload","properties":{"transfer":{"format":"ReferencedTransfer","description":"The transfer an RMA is requested for.","allOf":[{"$ref":"#/components/schemas/referenced_transfer_object"}]}}},"waybill_announcement_webhook_event_object":{"type":"object","title":"WaybillAnnouncementEvent","allOf":[{"$ref":"#/components/schemas/receive_webhook_event_object"},{"properties":{"payload":{"format":"WaybillAnnouncementEventPayload","allOf":[{"$ref":"#/components/schemas/waybill_announcement_webhook_event_payload_object"}]}}}]},"waybill_announcement_webhook_event_payload_object":{"type":"object","title":"WaybillAnnouncementEventPayload","properties":{"waybill":{"format":"ReferencedWaybill","description":"The waybill that has been announced.","allOf":[{"$ref":"#/components/schemas/referenced_waybill_object"}]}}},"receive_webhook_event_object":{"title":"WebhookEvent","type":"object","properties":{"id":{"type":"string","maxLength":36,"minLength":36,"description":"The identifier of the webhook event.","example":"f64f26c4-0bd2-4fe6-bcf2-a9341e7f0bd2"},"type":{"type":"string","maxLength":64,"description":"The type of the webhook event."},"payload":{"type":"object","description":"The payload of the webhook event."}},"discriminator":{"propertyName":"type","mapping":{"task.rma_request":"#/components/schemas/task_rma_request_webhook_event_object","task.message":"#/components/schemas/task_message_webhook_event_object","transfer.rma_request":"#/components/schemas/transfer_rma_request_webhook_event_object","transfer.invoiced":"#/components/schemas/transfer_invoiced_webhook_event_object","waybill.announcement":"#/components/schemas/waybill_announcement_webhook_event_object","webhook.connection_test":"#/components/schemas/connection_test_webhook_event_object"}}}},"headers":{"X-Tracking-Id":{"description":"An identifier that is used to identify the request.","schema":{"type":"string"}},"Location":{"description":"Contains the IRI of the (created) resource.","schema":{"type":"string"}},"Retry-After":{"description":"Amount of seconds to wait before a new request can be made.","schema":{"type":"integer"}},"X-RateLimit-Limit":{"description":"The rate limit ceiling for the request.","schema":{"type":"string"}},"X-RateLimit-Remaining":{"description":"The number of remaining requests.","schema":{"type":"integer"}},"X-RateLimit-Reset":{"description":"The time in seconds until the rate limit resets.","schema":{"type":"integer"}}},"parameters":{"Authorization":{"name":"Authorization","in":"header","description":"The access token obtained through the operation ["Obtain an access token"](/specification#operation/obtainAccessToken).","required":true,"schema":{"type":"string","example":"Bearer {access_token}"}},"Accept":{"name":"Accept","in":"header","description":"What content type the API should respond with.","required":false,"schema":{"type":"string","default":"application/json","enum":["application/json"]}},"_page_limit":{"name":"_page_limit","in":"query","description":"Maximum number of items to return.","required":false,"example":25,"schema":{"type":"integer","format":"int32","minimum":1,"maximum":50,"default":20}},"_page":{"name":"_page","in":"query","description":"The page to retrieve items from.","required":false,"example":10,"schema":{"type":"integer","format":"int32","minimum":1,"default":1}},"_order":{"name":"_order","in":"query","description":"The order to sort the result in.","required":false,"schema":{"type":"string","enum":["ASCENDING","DESCENDING"],"default":"ASCENDING"}}},"responses":{"oauth_bad_request_response":{"description":"Bad Request","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/oauth_bad_request_error"}}}},"oauth_internal_server_error_response":{"description":"Internal Server Error","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/oauth_internal_server_error"}}}},"oauth_not_acceptable_response":{"description":"Not Acceptable","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/oauth_not_acceptable_error"}}}},"oauth_too_many_requests_response":{"description":"Too Many Requests","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/oauth_too_many_requests_error"}}}},"oauth_unauthorized_response":{"description":"Unauthorized","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/oauth_unauthorized_error"}}}},"forbidden_response":{"description":"Forbidden","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/forbidden_problem"}}}},"internal_server_error_response":{"description":"Internal Server Error","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/internal_server_error_problem"}}}},"not_acceptable_response":{"description":"Not Acceptable","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/unsupported_response_format_problem"}}}},"resource_not_found_response":{"description":"Not Found","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/resource_not_found_problem"}}}},"unauthorized_response":{"description":"Unauthorized","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/missing_access_token_problem"},{"$ref":"#/components/schemas/invalid_access_token_problem"},{"$ref":"#/components/schemas/expired_access_token_problem"}]}}}},"unsupported_media_type_response":{"description":"Unsupported Media Type","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/problem+json":{"schema":{"$ref":"#/components/schemas/unsupported_request_format_problem"}}}}}},"servers":[{"url":"https://webservice.zir-online.com"}],"info":{"version":"v1.40.0","title":"ZIR Online Externals API","description":"An API that exchanges information between ZIR Online and externals, such as Service Centers and Vendors.","contact":{"name":"Tech Support","email":"api-support@zesgoes.nl","url":"https://confluence.media-saturn.com/display/SFT/External+API"},"x-api-id":"3fd14e85-8ec1-4bbb-8b18-21b0c3999085","x-audience":"External-partner","x-business-domain":"Service Fulfillment","x-business-objects":["Authorized Service Center"],"x-product":"External API"},"paths":{"/oauth/token":{"post":{"operationId":"obtainAccessToken","tags":["OAuth"],"summary":"Obtain an access token","description":"Obtain an access token that enables a client to authenticate with the API. This operation is conform [RFC6749 section 4.4 (OAuth 2.0 Client Credentials Grant)](https://tools.ietf.org/html/rfc6749#section-4.4). It is possible to use existing libraries to implement this in your codebase.

You should not use this operation to obtain a large amount of access tokens in a short period of time. Each access token should be used until it expires. If you receive a 429 Rate limit reached response when using this operation, reduce the frequency of requests.","parameters":[{"name":"Authorization","in":"header","description":"Header for [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication) containing a [base64](https://en.wikipedia.org/wiki/Base64) encoded string of the client id and client secret, joined by a single colon `:`. ","required":true,"schema":{"type":"string"},"example":"Basic c29tZV9jbGllbnQ6c29tZV9zZWNyZXQ="}],"requestBody":{"required":true,"content":{"application/x-www-form-urlencoded":{"schema":{"required":["grant_type"],"properties":{"grant_type":{"description":"Which OAuth flow should be used. The value of this parameter must be `client_credentials`.","type":"string","maxLength":64,"enum":["client_credentials"],"example":"client_credentials"}},"type":"object"}}}},"responses":{"200":{"description":"OK","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"},"X-RateLimit-Limit":{"$ref":"#/components/headers/X-RateLimit-Limit"},"X-RateLimit-Remaining":{"$ref":"#/components/headers/X-RateLimit-Remaining"},"X-RateLimit-Reset":{"$ref":"#/components/headers/X-RateLimit-Reset"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/oauth_access_token_object"}}}},"400":{"$ref":"#/components/responses/oauth_bad_request_response"},"401":{"$ref":"#/components/responses/oauth_unauthorized_response"},"406":{"$ref":"#/components/responses/oauth_not_acceptable_response"},"429":{"$ref":"#/components/responses/oauth_too_many_requests_response"},"500":{"$ref":"#/components/responses/oauth_internal_server_error_response"}},"x-code-samples":[{"lang":"PHP","source":"$accessToken = Cache::get('access_token'); // Check whether the access token is expired or non-existent, and if so, request a new access token. if ($accessToken === null || $accessToken->isExpired()) { $request = new Request('POST', 'https://webservice.zir-online.com/oauth/token'); $request->setBody('grant_type=client_credentials'); // Naturally, the client credentials should be stored somewhere safe. $request->setHeader('Authorization', 'Basic c29tZV9jbGllbnQ6c29tZV9zZWNyZXQ='); $request->setHeader('Content-Type', 'application/x-www-form-urlencoded'); $response = HttpClient::send($request); if ($response->getStatusCode() !== 200) { throw new RuntimeException('Failed to obtain access token.'); } $data = JsonDecoder::decode($response->getBody()); // Cache the access token so that it can be used in consecutive requests. $accessToken = new AccessToken($data['access_token'], $data['expires_in']) Cache::set('access_token', $accessToken); } // Use the access token to authenticate with the API. $request = new Request('GET', 'https://webservice.zir-online.com/v1/tasks/X999-12345-R'); $request->setHeader('Authorization', 'Bearer ' . $accessToken->getToken()); $request->setHeader('Content-Type', 'application/json'); $response = HttpClient::send($request); // ..."}]}},"/v1/tasks":{"get":{"operationId":"searchTasks","tags":["Tasks"],"summary":"Search tasks","description":"Retrieves task by search criteria.","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/Accept"},{"$ref":"#/components/parameters/_page"},{"$ref":"#/components/parameters/_page_limit"},{"$ref":"#/components/parameters/_order"},{"name":"type","in":"query","required":true,"description":"The type of task to be retrieved.","schema":{"type":"string","example":"repair","enum":["repair","return"]}},{"name":"country_code","in":"query","required":true,"description":"The code of the country.","schema":{"type":"string","example":"NL"}},{"name":"reference","in":"query","required":false,"description":"The reference to match a task by. Currently only the reference type "external_warehouse_location" is supported.","schema":{"type":"string","format":"{reference_type}:{reference}","example":"external_warehouse_location:LV-012345679-19700101000001"}}],"responses":{"200":{"description":"OK","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/referenced_task_object"}}}}},"401":{"$ref":"#/components/responses/unauthorized_response"},"406":{"$ref":"#/components/responses/not_acceptable_response"},"415":{"$ref":"#/components/responses/unsupported_media_type_response"},"500":{"$ref":"#/components/responses/internal_server_error_response"}}}},"/v1/tasks/{reference}":{"get":{"operationId":"getTask","tags":["Tasks"],"summary":"Get a task","description":"Retrieves information about a task by its reference.","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/Accept"},{"name":"reference","in":"path","required":true,"schema":{"type":"string","maxLength":20},"example":"X123-1234567-R"}],"responses":{"200":{"description":"OK","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_object"}}}},"401":{"$ref":"#/components/responses/unauthorized_response"},"403":{"$ref":"#/components/responses/forbidden_response"},"404":{"$ref":"#/components/responses/resource_not_found_response"},"406":{"$ref":"#/components/responses/not_acceptable_response"},"500":{"$ref":"#/components/responses/internal_server_error_response"}}}},"/v1/tasks/{reference}/customer":{"get":{"operationId":"getTaskCustomer","tags":["Tasks"],"summary":"Get a customer of a task","description":"Retrieves a customer of a task by task reference.
Request access to this endpoint before using it. You can request access by signing a data processing agreement.","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/Accept"},{"name":"reference","in":"path","required":true,"schema":{"type":"string","maxLength":20},"example":"X123-1234567-R"}],"responses":{"200":{"description":"OK","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/customer_object"}}}},"401":{"$ref":"#/components/responses/unauthorized_response"},"403":{"$ref":"#/components/responses/forbidden_response"},"404":{"$ref":"#/components/responses/resource_not_found_response"},"406":{"$ref":"#/components/responses/not_acceptable_response"},"500":{"$ref":"#/components/responses/internal_server_error_response"}}}},"/v1/tasks/{reference}/attachments/{attachmentReference}":{"get":{"operationId":"getTaskAttachment","tags":["Tasks"],"summary":"Get an attachment of a task","description":"Retrieves an attachment of a task by the task and attachment reference.","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/Accept"},{"name":"reference","in":"path","required":true,"schema":{"type":"string","maxLength":20},"example":"X123-1234567-R"},{"name":"attachmentReference","in":"path","required":true,"schema":{"type":"string","maxLength":36,"minLength":36},"example":"0b3e1638-7257-4d1d-854b-fdcf58d5cafe"}],"responses":{"200":{"description":"OK","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_attachment_object"}}}},"401":{"$ref":"#/components/responses/unauthorized_response"},"403":{"$ref":"#/components/responses/forbidden_response"},"404":{"$ref":"#/components/responses/resource_not_found_response"},"406":{"$ref":"#/components/responses/not_acceptable_response"},"500":{"$ref":"#/components/responses/internal_server_error_response"}}}},"/v1/tasks/{reference}/notify-status-change":{"post":{"operationId":"notifyTaskStatusChange","tags":["Tasks"],"summary":"Notify task status change","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/Accept"},{"name":"reference","in":"path","required":true,"schema":{"type":"string","maxLength":20},"example":"X123-1234567-R"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChangeTaskStatusObject"}}}},"responses":{"200":{"description":"OK","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/success_object"}}}},"400":{"description":"Bad Request","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/invalid_request_body_problem"},{"$ref":"#/components/schemas/malformed_request_body_problem"},{"title":"Invalid task state","example":{"type":"/problems/invalid-task-state","title":"The state of the task disallows the attempted action.","detail":"Can not change the status of the repair. The repair is not in the right state."},"allOf":[{"$ref":"#/components/schemas/invalid_task_state_problem"}]}]}}}},"401":{"$ref":"#/components/responses/unauthorized_response"},"403":{"$ref":"#/components/responses/forbidden_response"},"404":{"$ref":"#/components/responses/resource_not_found_response"},"406":{"$ref":"#/components/responses/not_acceptable_response"},"415":{"$ref":"#/components/responses/unsupported_media_type_response"},"500":{"$ref":"#/components/responses/internal_server_error_response"}}}},"/v1/tasks/{reference}/assign-rma-number":{"post":{"operationId":"assignTaskRmaNumber","tags":["Tasks"],"summary":"Assign an RMA number to a task","description":"This endpoint allows you to assign an RMA number to the task, as long as there is no (active) RMA procedure.
If there is an ongoing or planned RMA procedure, the Accept/Decline task RMA endpoint(s) must be used instead.","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/Accept"},{"name":"reference","in":"path","required":true,"schema":{"type":"string","maxLength":20},"example":"X123-1234567-R"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AssignTaskRmaNumberObject"}}}},"responses":{"200":{"description":"OK","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/success_object"}}}},"400":{"description":"Bad Request","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/invalid_request_body_problem"},{"$ref":"#/components/schemas/malformed_request_body_problem"},{"title":"Invalid task state","example":{"type":"/problems/invalid-task-state","title":"The state of the task disallows the attempted action.","detail":"Can not assign an RMA number to the repair. The repair is not in the right state."},"allOf":[{"$ref":"#/components/schemas/invalid_task_state_problem"}]}]}}}},"401":{"$ref":"#/components/responses/unauthorized_response"},"403":{"$ref":"#/components/responses/forbidden_response"},"404":{"$ref":"#/components/responses/resource_not_found_response"},"406":{"$ref":"#/components/responses/not_acceptable_response"},"415":{"$ref":"#/components/responses/unsupported_media_type_response"},"500":{"$ref":"#/components/responses/internal_server_error_response"}}}},"/v1/tasks/{reference}/accept-rma":{"post":{"operationId":"acceptTaskRma","tags":["Tasks"],"summary":"Accept RMA for a task","description":"Accept RMA for a task.","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/Accept"},{"name":"reference","in":"path","required":true,"schema":{"type":"string","maxLength":20},"example":"X123-1234567-R"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/accept_task_rma_object"}}}},"responses":{"200":{"description":"OK","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/success_object"}}}},"400":{"description":"Bad Request","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/invalid_request_body_problem"},{"$ref":"#/components/schemas/malformed_request_body_problem"},{"title":"Invalid task state","example":{"type":"/problems/invalid-task-state","title":"The state of the task disallows the attempted action.","detail":"Can not authorise the task. The task may already be authorised."},"allOf":[{"$ref":"#/components/schemas/invalid_task_state_problem"}]}]}}}},"401":{"$ref":"#/components/responses/unauthorized_response"},"403":{"$ref":"#/components/responses/forbidden_response"},"404":{"$ref":"#/components/responses/resource_not_found_response"},"406":{"$ref":"#/components/responses/not_acceptable_response"},"415":{"$ref":"#/components/responses/unsupported_media_type_response"},"500":{"$ref":"#/components/responses/internal_server_error_response"}}}},"/v1/tasks/{reference}/decline-rma":{"post":{"operationId":"declineTaskRma","tags":["Tasks"],"summary":"Decline RMA for a task","description":"Decline RMA for a task.","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/Accept"},{"name":"reference","in":"path","required":true,"schema":{"type":"string","maxLength":20},"example":"X123-1234567-R"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/decline_task_rma_object"}}}},"responses":{"200":{"description":"OK","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/success_object"}}}},"400":{"description":"Bad Request","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/invalid_request_body_problem"},{"$ref":"#/components/schemas/malformed_request_body_problem"},{"title":"Invalid task state","example":{"type":"/problems/invalid-task-state","title":"The state of the task disallows the attempted action.","detail":"Can not decline the task. The task may already be authorised."},"allOf":[{"$ref":"#/components/schemas/invalid_task_state_problem"}]}]}}}},"401":{"$ref":"#/components/responses/unauthorized_response"},"403":{"$ref":"#/components/responses/forbidden_response"},"404":{"$ref":"#/components/responses/resource_not_found_response"},"406":{"$ref":"#/components/responses/not_acceptable_response"},"415":{"$ref":"#/components/responses/unsupported_media_type_response"},"500":{"$ref":"#/components/responses/internal_server_error_response"}}}},"/v1/tasks/{reference}/quotation":{"put":{"operationId":"addTaskQuotation","tags":["Tasks"],"summary":"Add a quotation to a task","description":"Add a quotation to a task.","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/Accept"},{"name":"reference","in":"path","required":true,"schema":{"type":"string","maxLength":20},"example":"X123-1234567-R"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_quotation_object"}}}},"responses":{"200":{"description":"OK","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/success_object"}}}},"400":{"description":"Bad Request","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/invalid_request_body_problem"},{"$ref":"#/components/schemas/malformed_request_body_problem"},{"title":"Invalid task state","example":{"type":"/problems/invalid-task-state","title":"The state of the task disallows the attempted action.","detail":"Can not add a quotation. The task is not active."},"allOf":[{"$ref":"#/components/schemas/invalid_task_state_problem"}]}]}}}},"401":{"$ref":"#/components/responses/unauthorized_response"},"403":{"$ref":"#/components/responses/forbidden_response"},"404":{"$ref":"#/components/responses/resource_not_found_response"},"406":{"$ref":"#/components/responses/not_acceptable_response"},"415":{"$ref":"#/components/responses/unsupported_media_type_response"},"500":{"$ref":"#/components/responses/internal_server_error_response"}}}},"/v1/tasks/{reference}/repair-invoice":{"put":{"operationId":"addRepairInvoice","tags":["Tasks"],"summary":"Add a repair invoice to a task","description":"Add a repair invoice to a task.","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/Accept"},{"name":"reference","in":"path","required":true,"schema":{"type":"string","maxLength":20},"example":"X123-1234567-R"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_repair_invoice_object"}}}},"responses":{"200":{"description":"OK","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/success_object"}}}},"400":{"description":"Bad Request","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/invalid_request_body_problem"},{"$ref":"#/components/schemas/malformed_request_body_problem"},{"title":"Invalid task state","example":{"type":"/problems/invalid-task-state","title":"The state of the task disallows the attempted action.","detail":"Can not create a repair invoice. The task may be inactive."},"allOf":[{"$ref":"#/components/schemas/invalid_task_state_problem"}]}]}}}},"401":{"$ref":"#/components/responses/unauthorized_response"},"403":{"$ref":"#/components/responses/forbidden_response"},"404":{"$ref":"#/components/responses/resource_not_found_response"},"406":{"$ref":"#/components/responses/not_acceptable_response"},"415":{"$ref":"#/components/responses/unsupported_media_type_response"},"500":{"$ref":"#/components/responses/internal_server_error_response"}}}},"/v1/tasks/{reference}/product":{"patch":{"operationId":"updateTaskProduct","tags":["Tasks"],"summary":"Update the product of a task","description":"Update the product of a task by task reference.
_Note that none of the fields are required. All fields that are not explicitly provided will be ignored and thus not updated._","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/Accept"},{"name":"reference","in":"path","required":true,"schema":{"type":"string","maxLength":20},"example":"X123-1234567-R"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/update_task_product_object"}}}},"responses":{"200":{"description":"OK","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/success_object"}}}},"400":{"description":"Bad Request","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/invalid_request_body_problem"},{"$ref":"#/components/schemas/malformed_request_body_problem"},{"title":"Invalid task state","example":{"type":"/problems/invalid-task-state","title":"The state of the task disallows the attempted action.","detail":"Can not update the task. The task may be inactive."},"allOf":[{"$ref":"#/components/schemas/invalid_task_state_problem"}]}]}}}},"401":{"$ref":"#/components/responses/unauthorized_response"},"403":{"$ref":"#/components/responses/forbidden_response"},"404":{"$ref":"#/components/responses/resource_not_found_response"},"406":{"$ref":"#/components/responses/not_acceptable_response"},"415":{"$ref":"#/components/responses/unsupported_media_type_response"},"500":{"$ref":"#/components/responses/internal_server_error_response"}}}},"/v1/tasks/{reference}/messages/{id}":{"get":{"operationId":"getTaskMessage","tags":["Tasks"],"summary":"Get a message of a task","description":"Retrieves a message by the task and message reference.","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/Accept"},{"name":"reference","in":"path","required":true,"schema":{"type":"string","maxLength":20},"example":"X123-1234567-R"},{"name":"messageReference","in":"path","required":true,"schema":{"type":"string","maxLength":10},"example":"123456789"}],"responses":{"200":{"description":"OK","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_message_object"}}}},"401":{"$ref":"#/components/responses/unauthorized_response"},"403":{"$ref":"#/components/responses/forbidden_response"},"404":{"$ref":"#/components/responses/resource_not_found_response"},"406":{"$ref":"#/components/responses/not_acceptable_response"},"500":{"$ref":"#/components/responses/internal_server_error_response"}}}},"/v1/tasks/{reference}/messages":{"post":{"tags":["Tasks"],"summary":"Add a message to a task","description":"Add a message to a task","operationId":"addTaskMessage","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/Accept"},{"name":"reference","in":"path","required":true,"schema":{"type":"string","maxLength":20},"example":"X123-1234567-R"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_flow_message_object"}}}},"responses":{"201":{"description":"Created","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"},"Location":{"$ref":"#/components/headers/Location"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/success_object"}}}},"400":{"description":"Bad Request","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/invalid_request_body_problem"},{"$ref":"#/components/schemas/malformed_request_body_problem"},{"title":"Invalid task state","example":{"type":"/problems/invalid-task-state","title":"The state of the task disallows the attempted action.","detail":"Can not add message to the task. The message type is not supported."},"allOf":[{"$ref":"#/components/schemas/invalid_task_state_problem"}]}]}}}},"401":{"$ref":"#/components/responses/unauthorized_response"},"403":{"$ref":"#/components/responses/forbidden_response"},"404":{"$ref":"#/components/responses/resource_not_found_response"},"406":{"$ref":"#/components/responses/not_acceptable_response"},"415":{"$ref":"#/components/responses/unsupported_media_type_response"},"500":{"$ref":"#/components/responses/internal_server_error_response"}}}},"/v1/tasks/{reference}/messages/{id}/answer":{"post":{"operationId":"answerTaskMessage","tags":["Tasks"],"summary":"Add an answer to a message on a task","description":"Add an answer to a message on a task.","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/Accept"},{"name":"reference","in":"path","required":true,"schema":{"type":"string","maxLength":20},"example":"X123-1234567-R"},{"name":"messageReference","in":"path","description":"The reference of the message to which this is a answer","required":true,"schema":{"type":"int"},"example":"12345"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_flow_message_answer_object"}}}},"responses":{"201":{"description":"Created","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"},"Location":{"$ref":"#/components/headers/Location"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/success_object"}}}},"400":{"description":"Bad Request","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/invalid_request_body_problem"},{"$ref":"#/components/schemas/malformed_request_body_problem"},{"title":"Invalid task state","example":{"type":"/problems/invalid-task-state","title":"The state of the task disallows the attempted action.","detail":"Can not add answer to the task. The original message is not a question or answer."},"allOf":[{"$ref":"#/components/schemas/invalid_task_state_problem"}]}]}}}},"401":{"$ref":"#/components/responses/unauthorized_response"},"403":{"$ref":"#/components/responses/forbidden_response"},"404":{"$ref":"#/components/responses/resource_not_found_response"},"406":{"$ref":"#/components/responses/not_acceptable_response"},"415":{"$ref":"#/components/responses/unsupported_media_type_response"},"500":{"$ref":"#/components/responses/internal_server_error_response"}}}},"/v1/transfers/{reference}":{"get":{"tags":["Transfers"],"summary":"Get a transfer","description":"Retrieves information about a transfer by its reference.","operationId":"getTransfer","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/Accept"},{"name":"reference","in":"path","required":true,"schema":{"type":"string","maxLength":20},"example":"X001-T-0000001"}],"responses":{"200":{"description":"OK","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/transfer_object"}}}},"401":{"$ref":"#/components/responses/unauthorized_response"},"403":{"$ref":"#/components/responses/forbidden_response"},"404":{"$ref":"#/components/responses/resource_not_found_response"},"406":{"$ref":"#/components/responses/not_acceptable_response"},"500":{"$ref":"#/components/responses/internal_server_error_response"}}}},"/v1/transfers/{reference}/accept-rma":{"post":{"tags":["Transfers"],"summary":"Accept RMA for a transfer","description":"Accept RMA for the current state of a transfer.","operationId":"acceptTransferRma","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/Accept"},{"name":"reference","in":"path","required":true,"schema":{"type":"string","maxLength":20},"example":"X001-T-0000001"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/accept_transfer_rma_object"}}}},"responses":{"200":{"description":"OK","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/success_object"}}}},"400":{"description":"Bad Request","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/invalid_request_body_problem"},{"$ref":"#/components/schemas/malformed_request_body_problem"},{"title":"Invalid transfer state","example":{"type":"/problems/invalid-transfer-state","title":"The state of the transfer disallows the attempted action.","detail":"Can not authorise the transfer. The transfer may already be authorised."},"allOf":[{"$ref":"#/components/schemas/invalid_transfer_state_problem"}]}]}}}},"401":{"$ref":"#/components/responses/unauthorized_response"},"403":{"$ref":"#/components/responses/forbidden_response"},"404":{"$ref":"#/components/responses/resource_not_found_response"},"406":{"$ref":"#/components/responses/not_acceptable_response"},"415":{"$ref":"#/components/responses/unsupported_media_type_response"},"500":{"$ref":"#/components/responses/internal_server_error_response"}}}},"/v1/transfers/{reference}/tasks/{taskReference}/decline-rma":{"post":{"operationId":"declineTransferTaskRma","tags":["Transfers"],"summary":"Decline RMA for a task on a transfer","description":"Decline RMA for a single task on a transfer.
_When RMA for all tasks on a transfer have been declined, the transfer is canceled._","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/Accept"},{"name":"reference","in":"path","description":"Transfer","required":true,"schema":{"type":"string","maxLength":20},"example":"X001-T-0000001"},{"name":"taskReference","in":"path","description":"Reference of a task to decline the RMA for.","required":true,"schema":{"type":"string","maxLength":20},"example":"X123-1234567-R"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/decline_transfer_task_rma_object"}}}},"responses":{"200":{"description":"OK","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/success_object"}}}},"400":{"description":"Bad Request","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/invalid_request_body_problem"},{"$ref":"#/components/schemas/malformed_request_body_problem"},{"title":"Invalid transfer state","example":{"type":"/problems/invalid-transfer-state","title":"The state of the transfer disallows the attempted action.","detail":"Can not decline task of the transfer. The transfer may already be authorised."},"allOf":[{"$ref":"#/components/schemas/invalid_transfer_state_problem"}]}]}}}},"401":{"$ref":"#/components/responses/unauthorized_response"},"403":{"$ref":"#/components/responses/forbidden_response"},"404":{"$ref":"#/components/responses/resource_not_found_response"},"406":{"$ref":"#/components/responses/not_acceptable_response"},"415":{"$ref":"#/components/responses/unsupported_media_type_response"},"500":{"$ref":"#/components/responses/internal_server_error_response"}}}},"/v1/waybills/{reference}":{"get":{"operationId":"getWaybill","tags":["Waybills"],"summary":"Get a waybill","description":"Retrieves information about a waybill by its reference.","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/Accept"},{"name":"reference","in":"path","required":true,"schema":{"type":"string","maxLength":13,"minLength":13},"example":"WB-1234567890"}],"responses":{"200":{"description":"OK","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/waybill_object"}}}},"401":{"$ref":"#/components/responses/unauthorized_response"},"403":{"$ref":"#/components/responses/forbidden_response"},"404":{"$ref":"#/components/responses/resource_not_found_response"},"406":{"$ref":"#/components/responses/not_acceptable_response"},"500":{"$ref":"#/components/responses/internal_server_error_response"}}}},"/v1/supplier-invoices":{"post":{"operationId":"createSupplierInvoice","tags":["Supplier Invoices"],"summary":"Create a supplier invoice","description":"Create a supplier invoice.","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/Accept"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/create_supplier_invoice_object"}}}},"responses":{"201":{"description":"Created","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/success_object"}}}},"400":{"description":"Bad Request","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/problem+json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/invalid_request_body_problem"},{"$ref":"#/components/schemas/malformed_request_body_problem"}]}}}},"401":{"$ref":"#/components/responses/unauthorized_response"},"406":{"$ref":"#/components/responses/not_acceptable_response"},"415":{"$ref":"#/components/responses/unsupported_media_type_response"},"500":{"$ref":"#/components/responses/internal_server_error_response"}}}},"/my-webhook-url":{"post":{"operationId":"receiveWebhookEvent","tags":["Webhooks"],"summary":"Receive a webhook event","description":"This endpoint is for documentation purposes only, so that you know what data each webhook event will send to your system.","parameters":[{"name":"Content-Type","in":"header","description":"The content type of the request.","schema":{"type":"string","enum":["application/json"]}}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/receive_webhook_event_object"}}}},"responses":{"2XX":{"description":"Successful request"},"3XX":{"description":"Failed request"},"4XX":{"description":"Failed request"},"5XX":{"description":"Failed request"}}}},"/v1/webhooks":{"get":{"operationId":"getWebhooks","tags":["Webhooks"],"summary":"Get all webhooks","description":"Retrieves all webhooks that are configured for your user.
_Note that only webhooks that are configured for the current environment are given._","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/Accept"}],"responses":{"200":{"description":"OK","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/webhook_object"}}}}},"401":{"$ref":"#/components/responses/unauthorized_response"},"406":{"$ref":"#/components/responses/not_acceptable_response"},"500":{"$ref":"#/components/responses/internal_server_error_response"}},"x-code-samples":[{"lang":"PHP","source":"$accessToken = Cache::get('access_token'); // Check whether the access token is expired or non-existent, and if so, request a new access token. if ($accessToken === null || $accessToken->isExpired()) { // Retrieve a new access token, an example for this can be found at the OAuth endpoint. } // Use the access token to authenticate with the API. $request = new Request('GET', 'https://webservice.zir-online.com/v1/webhooks'); $request->setHeader('Authorization', 'Bearer ' . $accessToken->getToken()); $request->setHeader('Content-Type', 'application/json'); $response = HttpClient::send($request); // ..."}]}},"/v1/tasks/{countryCode}/{reference}/target-location":{"get":{"operationId":"getTaskTargetLocation","tags":["Tasks"],"summary":"Get the target location for a task","description":"Retrieves the target location of a task by its reference.","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/Accept"},{"name":"countryCode","in":"path","required":true,"schema":{"type":"string","maxLength":2,"minLength":2},"example":"de","description":"A two letter country code according to the ISO 3166-1 Alpha-2 standard."},{"name":"reference","in":"path","required":true,"schema":{"type":"string","maxLength":20},"example":"X123-1234567-R","description":"Can be a task reference or taskid."}],"responses":{"200":{"description":"OK","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/task_location_object"}}}},"401":{"$ref":"#/components/responses/unauthorized_response"},"403":{"$ref":"#/components/responses/forbidden_response"},"404":{"$ref":"#/components/responses/resource_not_found_response"},"406":{"$ref":"#/components/responses/not_acceptable_response"},"500":{"$ref":"#/components/responses/internal_server_error_response"}}}},"/v1/webhook-events/{eventId}":{"get":{"operationId":"getWebhookEvent","tags":["Webhooks"],"summary":"Get a webhook event","description":"Retrieves a webhook event.
_Note that only webhook events that are configured for the current environment are given._","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/Accept"}],"responses":{"200":{"description":"OK","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhook_event_object"}}}},"401":{"$ref":"#/components/responses/unauthorized_response"},"406":{"$ref":"#/components/responses/not_acceptable_response"},"500":{"$ref":"#/components/responses/internal_server_error_response"}},"x-code-samples":[{"lang":"PHP","source":"$accessToken = Cache::get('access_token'); // Check whether the access token is expired or non-existent, and if so, request a new access token. if ($accessToken === null || $accessToken->isExpired()) { // Retrieve a new access token, an example for this can be found at the OAuth endpoint. } // Use the access token to authenticate with the API. $request = new Request('GET', 'https://webservice.zir-online.com/v1/webhook-events/7853a08d-d8c0-40e6-831c-46b09818757d'); $request->setHeader('Authorization', 'Bearer ' . $accessToken->getToken()); $request->setHeader('Content-Type', 'application/json'); $response = HttpClient::send($request); // ..."}]}},"/v1/webhooks/{webhookId}":{"get":{"operationId":"getWebhook","tags":["Webhooks"],"summary":"Get a webhook","description":"Retrieves a webhook that is configured for your user.
_Note that only webhooks that are configured for the current environment can be retrieved._","parameters":[{"$ref":"#/components/parameters/Authorization"},{"$ref":"#/components/parameters/Accept"}],"responses":{"200":{"description":"OK","headers":{"X-Tracking-Id":{"$ref":"#/components/headers/X-Tracking-Id"}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/webhook_object"}}}},"401":{"$ref":"#/components/responses/unauthorized_response"},"406":{"$ref":"#/components/responses/not_acceptable_response"},"500":{"$ref":"#/components/responses/internal_server_error_response"}},"x-code-samples":[{"lang":"PHP","source":"$accessToken = Cache::get('access_token'); // Check whether the access token is expired or non-existent, and if so, request a new access token. if ($accessToken === null || $accessToken->isExpired()) { // Retrieve a new access token, an example for this can be found at the OAuth endpoint. } // Use the access token to authenticate with the API. $request = new Request('GET', 'https://webservice.zir-online.com/v1/webhooks/aed19637-cb55-44d9-9acb-b5fb5c656416'); $request->setHeader('Authorization', 'Bearer ' . $accessToken->getToken()); $request->setHeader('Content-Type', 'application/json'); $response = HttpClient::send($request); // ..."}]}}}}