{"openapi":"3.0.0","info":{"title":"Apilo REST API","description":"# Dokumentacja REST API dla Apilo\n    Limit zapyta\u0144 to 150req\/min.\n## Obs\u0142uga zasob\u00f3w API\n   Dla wszystkich zasob\u00f3w niezwi\u0105zanych z procesem autoryzacji nale\u017cy do\u0142\u0105czy\u0107\nnast\u0119puj\u0105ce nag\u0142\u00f3wki:\n\n```\nAccept: application\/json\nContent-Type: application\/json\nAuthorization: Bearer access_token\n```\n\n   Dla ka\u017cdego zapytania (r\u00f3wnie\u017c autoryzacyjnych) nale\u017cy okre\u015bli\u0107 typ medi\u00f3w (nag\u0142\u00f3wek\n   Accept oraz Content-Type), b\u0119dzie to zawsze application\/json.\n   Zar\u00f3wno dla zapyta\u0144 wysy\u0142anych na serwer jak i danych zwracanych przez serwer\n   stosowany jest format danych (payload) JSON. Nale\u017cy odpowiednio dla zapyta\u0144 enkodowa\u0107\n   dane do tego formatu oraz dla odpowiedzi dekodowa\u0107 dane tego formatu.\n\n   Przesy\u0142aj\u0105c dane do API:\n   Pola opcjonalne mo\u017cna wype\u0142ni\u0107 lub przypisa\u0107 im warto\u015b\u0107 null w przypadku zapyta\u0144\n   POST\/PUT lub nie przesy\u0142a\u0107 ich w przypadku filtr\u00f3w GET.\n   Pola obowi\u0105zkowe nale\u017cy zawsze wype\u0142ni\u0107 w\u0142a\u015bciw\u0105 warto\u015bci\u0105.\n## Filtry dla list\nDla zasob\u00f3w typu GET z list\u0105 wynik\u00f3w mo\u017cna stosowa\u0107 dodatkowe filtry manipuluj\u0105ce\nwynikami. Parametry nale\u017cy przekaza\u0107 w URL zaraz za znakiem ko\u0144cz\u0105cym adres zasobu,\nnp. `...\/api\/orders\/?limit=200`\nDla list dost\u0119pne s\u0105 dwa og\u00f3lne filtry:\n\n`int` `limit` - Limit zwracanych wynik\u00f3w (maksymalnie 2000)\n`int` `offset` - Wska\u017anik pozycji (0 - sam pocz\u0105tek, 1 - pomija jeden rekord, 256 - pomija 256\n    rekord\u00f3w)\n## Format daty\nDaty dla przesy\u0142anych warto\u015bci (filtry oraz przesy\u0142ane obiekty metod\u0105 POST\/PUT)\nstosowany jest format daty ISO 8601 w nast\u0119puj\u0105cym formacie:\n`DateTimeIso` `YYYY-MM-DDTHH-MM-SSZ`. W PHP jest to `DateTimeInterface::ATOM`.\nDomy\u015blnie w takim formacie stosowany jest czas zulu (trzeba uwzgl\u0119dni\u0107 przesuni\u0119cie\nwzgl\u0119dem strefy czasowej). Czas Zulu mo\u017cna zast\u0105pi\u0107 lokalizacj\u0105 strefy czasowej, np. w\nprzypadku Polski jest to +0200 w przypadku czasu letniego lub +0100 w przypadku czasu\npodstawowego (przekazuj\u0105c stref\u0119 czasow\u0105 w filtrze - parametr GET - nale\u017cy pami\u0119ta\u0107 o\nzakodowaniu znaku plusa, w przeciwnym wypadku zostanie zinterpretowany jako spacja).\n\n`2024-09-12T08:16:32+02:00`\n","version":"2.0.0.0"},"paths":{"\/rest\/auth\/token\/":{"post":{"tags":["Authorization"],"summary":"Obtaining access_token and refresh_token tokens.","description":"This method allows you to get <code>access_token<\/code> and <code>refresh_token<\/code> through two scenarios:<br>\n    <ul>\n    <li> exchanging <code>authorization_code<\/code> for tokens<\/li>\n    <li> exchange of <code>refresh_token<\/code> for tokens (token refresh operation)<\/li>\n    <\/ul>","operationId":"post_rest_auth_tokenpost","requestBody":{"description":"Obtaining access_token and refresh_token tokens","required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AuthorizationRequest"}}}},"responses":{"201":{"description":"Credentials","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/AuthorizationResponse"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"403":{"description":"Invalid authorization code","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"422":{"description":"Invalid Accept header value","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BasicAuth":[]}]}},"\/rest\/api\/finance\/document-configs\/":{"get":{"tags":["Finance document"],"summary":"Get accounting document numbering series.","description":"List of numbering series","operationId":"get_rest_finance_document_configs_index","parameters":[{"name":"type","in":"query","description":"Type of accounting document (1-Invoice, 5-Receipt, 10-Proforma, 31-Corrective invoice)","schema":{"type":"integer","enum":[1,5,10,31]}},{"name":"offset","in":"query","required":false,"schema":{"description":"Position indicator (0-beginning, 1-skips one record, 256 - skips 256 records)","type":"integer","format":"int32","minimum":0}},{"name":"limit","in":"query","required":false,"schema":{"description":"Limit of returned results, max 512 records","type":"integer","format":"int32","maximum":512,"minimum":1}}],"responses":{"200":{"description":"Numbering series array","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/RestDocumentConfigsIndexResponse"},{"$ref":"#\/components\/schemas\/RestListingResponse"}]}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/finance\/documents\/":{"get":{"tags":["Finance document"],"summary":"Get list of accounting documents.","description":"List of accounting documents","operationId":"get_rest_finance_document_index","parameters":[{"name":"type","in":"query","description":"Type of accounting document (1-Invoice, 5-Receipt, 10-Proforma, 31-Corrective invoice)","required":false,"schema":{"type":"integer","enum":[1,5,10,31]}},{"name":"hasDocumentDocumentType","in":"query","description":"A DocumentDocument of the specified type is created (1-printed, 2-exported to an external platform)","required":false,"schema":{"type":"integer","enum":[1,2]}},{"name":"hasNotDocumentDocumentType","in":"query","description":"A DocumentDocument of the specified type is not created (1-printed, 2-exported to an external platform)","required":false,"schema":{"type":"integer","enum":[1,2]}},{"name":"isFiscal","in":"query","description":"Only for type Receipt type (type=5)","required":false,"schema":{"type":"boolean"}},{"name":"documentConfig[]","in":"query","description":"ID of <a href='#tag\/Finance-document\/operation\/get_rest_finance_document_configs_index'>accounting document numbering series<\/a>","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"offset","in":"query","required":false,"schema":{"description":"Position indicator (0-beginning, 1-skips one record, 256 - skips 256 records)","type":"integer","format":"int32","minimum":0}},{"name":"limit","in":"query","required":false,"schema":{"description":"Limit of returned results, max 512 records","type":"integer","format":"int32","maximum":512,"minimum":1}}],"responses":{"200":{"description":"Returns list of accounting documents","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/RestDocumentsIndexResponse"},{"$ref":"#\/components\/schemas\/RestListingResponse"}]}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/finance\/documents\/{id}\/documents\/":{"post":{"tags":["Finance document"],"summary":"Create a document for accounting documents.","description":"Create a document for accounting documents","operationId":"post_rest_finance_documents_documents_create","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestDocumentDocumentDTO"}}}},"responses":{"200":{"description":"Document has not been created","content":{"application\/json":{"schema":{},"example":[]}}},"201":{"description":"Document has been created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestDocumentDocumentDTO2"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"422":{"description":"Validation error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"409":{"description":"Document with the given idExternal already exists","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/finance\/documents\/{id}\/documents\/{idExternal}\/":{"delete":{"tags":["Finance document"],"summary":"Delete a document for accounting documents.","operationId":"delete_rest_finance_documents_documents_delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"description":"Internal ID of the document (e.g. 31)","type":"integer","pattern":"\\d+"}},{"name":"idExternal","in":"path","required":true,"schema":{"description":"Unique document ID (e.g. 24)","type":"integer","pattern":"\\d+"}}],"responses":{"200":{"description":"If deleted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"404":{"description":"Not deleted","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}}}},"\/rest\/api\/":{"get":{"tags":["Connection"],"summary":"Connection test.","description":"Test Api","operationId":"get_rest_index_index","responses":{"200":{"description":"Hello","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/HelloResponse"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/whoami\/":{"get":{"tags":["Connection"],"summary":"Connection info.","description":"Informacje o po\u0142\u0105czeniu","operationId":"get_rest_index_whoami","responses":{"200":{"description":"Successfull operation","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ContentDTO"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/media\/":{"post":{"tags":["Media"],"summary":"Create new media attachment.","description":"Create new media attachment","operationId":"post_rest_media_new","parameters":[{"name":"Content-Disposition","in":"header","description":"Extra file parameters (e.g. 'Content-Disposition: filename=invoice.pdf')","content":{"application\/json":{"schema":{"type":"string"}}}}],"requestBody":{"description":"You can create new media attachment for files with type application\/pdf, image\/jpeg, image\/png, image\/gif, image\/webp","required":true,"content":{"application\/octet-stream":{"schema":{"type":"string","format":"binary"}}}},"responses":{"201":{"description":"Create attachment correctly","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Media"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"415":{"description":"Invalid file type","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"422":{"description":"Validation error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/media\/{uuid}\/":{"get":{"tags":["Media"],"summary":"Get media.","operationId":"get_rest_media_get","parameters":[{"name":"uuid","in":"path","description":"UUID Media","required":true,"schema":{"type":"string","pattern":"[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-5][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}"}}],"responses":{"200":{"description":"Binary Content"},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"404":{"description":"Media not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException2"}}}}}}},"\/rest\/api\/orders\/":{"get":{"tags":["Order"],"summary":"Get simple list of orders.","description":"Example URL for filters and sort: <code>\/rest\/api\/orders\/?orderStatus=7&createdAfter=2022-03-01T14%3A40%3A33%2B0200&order&sort=updatedAtDesc<\/code><br><br>\n    The fields orderItems and addressCustomer will be returned conditionally from end of 2022","operationId":"get_rest_orders_index","parameters":[{"name":"createdAfter","in":"query","required":false,"schema":{"description":"The date of order creation from in Apilo, takes the value of ISO 8601 date encoded to URL, e.g. `2022-03-01T14:40:33+0200`","type":"string","format":"date-time","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2})(Z|\\+\\d{2}:?\\d{2})$"}},{"name":"createdBefore","in":"query","required":false,"schema":{"description":"Date of order creation from customer, takes the value of ISO 8601 date encoded to URL, e.g. `2022-03-01T14:40:33+0200`","type":"string","format":"date-time","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2})(Z|\\+\\d{2}:?\\d{2})$"}},{"name":"orderedAfter","in":"query","required":false,"schema":{"description":"Date of order to customer, takes the value of ISO 8601 date encoded to URL, e.g. `2022-03-01T14:40:33+0200`","type":"string","format":"date-time","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2})(Z|\\+\\d{2}:?\\d{2})$"}},{"name":"orderedBefore","in":"query","required":false,"schema":{"description":"Update date from in Apilo system, takes the value of ISO 8601 date encoded to URL, e.g. `2022-03-01T14:40:33+0200`","type":"string","format":"date-time","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2})(Z|\\+\\d{2}:?\\d{2})$"}},{"name":"updatedAfter","in":"query","required":false,"schema":{"description":"Update date to in Apilo system, takes the value of ISO 8601 date encoded to URL, e.g. `2022-03-01T14:40:33+0200`","type":"string","format":"date-time","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2})(Z|\\+\\d{2}:?\\d{2})$"}},{"name":"updatedBefore","in":"query","required":false,"schema":{"description":"Update date from in Apilo system, takes the value of ISO 8601 date encoded to URL, e.g. `2022-03-01T14:40:33+0200`","type":"string","format":"date-time","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2})(Z|\\+\\d{2}:?\\d{2})$"}},{"name":"isOrderDocument","in":"query","required":false,"schema":{"description":"Determines whether a document exists for the order, takes the value of 1 or 0","type":"integer","format":"int32","maximum":1,"minimum":0}},{"name":"id","in":"query","required":false,"schema":{"description":"Order number in Apilo system, e.g. `AL0012345`","type":"string","pattern":"^[A-Za-z0-9\\.|]{10,11}$"}},{"name":"idExternal","in":"query","required":false,"schema":{"description":"External order number, e.g. `5200669628624`","type":"string","maxLength":36}},{"name":"orderStatus","in":"query","required":false,"schema":{"description":"Order status according to the order status map","type":"integer","format":"int32","minimum":1}},{"name":"orderStatusIds[]","in":"query","required":false,"schema":{"description":"Array of Order Status according to the order status map, example: <code>\/rest\/api\/orders\/?orderStatusIds[]=1&orderStatusIds[]=2<\/code>","type":"array","items":{"type":"integer","format":"int32","minimum":1}}},{"name":"paymentStatus","in":"query","required":false,"schema":{"description":"Order Payment Status <a href='#tag\/Order\/operation\/get_rest_orders_status_map'>Order payment Status <\/a>","type":"integer","format":"int32","minimum":1}},{"name":"paymentType","in":"query","required":false,"schema":{"description":"Order Payment type <a href='#tag\/Order\/operation\/get_rest_orders_payment_map'> Order Payment Type <\/a>","type":"integer","format":"int32","minimum":1}},{"name":"platformAccountId","in":"query","required":false,"schema":{"description":"Platform accoutn Id <a href='#tag\/Order\/operation\/get_rest_orders_platform_map'> Platform account Id <\/a>","type":"integer","format":"int32","minimum":1}},{"name":"sort","in":"query","description":"Sort options","required":false,"schema":{"type":"integer","enum":["createdAtAsc","createdAtDesc","updatedAtAsc","updatedAtDesc","orderedAtAsc","orderedAtDesc"]}},{"name":"offset","in":"query","required":false,"schema":{"description":"Position indicator (0-beginning, 1-skips one record, 256 - skips 256 records)","type":"integer","format":"int32","minimum":0}},{"name":"limit","in":"query","required":false,"schema":{"description":"Limit of returned results, max 512 records","type":"integer","format":"int32","maximum":512,"minimum":1}}],"responses":{"200":{"description":"Order array","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/RestOrdersIndexResponse"},{"$ref":"#\/components\/schemas\/RestListingResponse"}]}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException3"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Order"],"summary":"Create a new order.","description":"Create a new order","operationId":"post_rest_orders_create","requestBody":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestOrderWriteDTO"}}}},"responses":{"200":{"description":"Order with the given idExternal already exists","content":{"application\/json":{"schema":{"required":["id"],"properties":{"id":{"description":"Internal order ID","type":"string","maxLength":11,"minLength":10,"pattern":"^[A-Za-z0-9\\.|]{10,11}$","example":"AA123456789"}},"type":"object"}}}},"201":{"description":"Create order correctly 2","content":{"application\/json":{"schema":{"required":["id"],"properties":{"id":{"description":"Internal order ID","type":"string","maxLength":11,"minLength":10,"pattern":"^[A-Za-z0-9\\.|]{10,11}$","example":"AA123456789"}},"type":"object"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"404":{"description":"Invalid platform ID","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"422":{"description":"Validation error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/orders\/{id}\/":{"get":{"tags":["Order"],"summary":"Get detailed order by given ID.","operationId":"get_rest_orders_detail","parameters":[{"name":"id","in":"path","description":"order number in Apilo system, e.g. <code>AL0012345<\/code>","required":true,"schema":{"type":"string","maxLength":11,"minLength":10,"pattern":"^[A-Za-z0-9\\.|]{10,11}$"}}],"responses":{"200":{"description":"Detailed order object","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestOrderReadDTO"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"404":{"description":"Order not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/orders\/{id}\/status\/":{"put":{"tags":["Order"],"summary":"Update order status.","operationId":"put_rest_orders_status_change","parameters":[{"name":"id","in":"path","description":"order number in Apilo system, e.g. <code>AL0012345<\/code>","required":true,"schema":{"type":"string","maxLength":11,"minLength":10,"pattern":"^[A-Za-z0-9\\.|]{10,11}$"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestStatusOrderDTO"}}}},"responses":{"200":{"description":"Change status correctly","content":{"application\/json":{"schema":{"required":["id"],"properties":{"updates":{"description":"Number of updates","type":"integer","minimum":0,"example":"1"}},"type":"object"}}}},"304":{"description":"No changes was made","content":{"application\/json":{"schema":{},"example":"[]"}}},"400":{"description":"Invalid status ID","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"404":{"description":"Order not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/orders\/{id}\/payment\/":{"post":{"tags":["Order"],"summary":"Add payment to Order.","description":"Add payment to Orders","operationId":"post_rest_orders_payment_create","parameters":[{"name":"id","in":"path","description":"order number in Apilo system, e.g. <code>AL0012345<\/code>","required":true,"schema":{"type":"string","maxLength":11,"minLength":10,"pattern":"^[A-Za-z0-9\\.|]{10,11}$"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestOrderPaymentDTO"}}}},"responses":{"200":{"description":"Payment with the given idExternal already exists","content":{"application\/json":{"schema":{},"example":[]}}},"201":{"description":"Add payment correctly","content":{"application\/json":{"schema":{"required":["id"],"properties":{"updates":{"description":"Number of payment created","type":"integer","minimum":0,"example":"1"}},"type":"object"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"404":{"description":"Order not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/orders\/{id}\/media\/{document}\/":{"get":{"tags":["Order"],"summary":"Order Binary document.","description":"Binary contents of the document (or shipment label) file belongs to the specified order","operationId":"get_rest_orders_raw_media","parameters":[{"name":"id","in":"path","description":"order number in Apilo system, e.g. <code>AL0012345<\/code>","required":true,"schema":{"type":"string","maxLength":11,"minLength":10,"pattern":"^[A-Za-z0-9\\.|]{10,11}$"}},{"name":"document","in":"path","description":"ID of the document or shipment belongs to the Apilo order","required":true,"schema":{"type":"string","minimum":1,"pattern":"\\d+"}}],"responses":{"200":{"description":"Binary content","content":{"application\/pdf":{}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException2"}}}},"404":{"description":"Media not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException2"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/orders\/{id}\/documents\/":{"get":{"tags":["Order"],"summary":"Get simple list of documents for given order.","description":"List of documents belongs to the indicated order","operationId":"get_rest_order_documents_index","parameters":[{"name":"id","in":"path","required":true,"schema":{"description":"order number in Apilo system, e.g. <code>AL0012345<\/code>","type":"string","maxLength":11,"minLength":10,"pattern":"^[A-Za-z0-9\\.|]{10,11}$"}},{"name":"id","in":"query","description":"ID of the document","required":false,"schema":{"minimum":1}},{"name":"idExternal","in":"query","description":"External unique ID of the document","required":false,"schema":{"maxLength":36}},{"name":"number","in":"query","required":false,"schema":{"description":"External document number","type":"integer"}},{"name":"type","in":"query","required":false,"schema":{"description":"Document type - <a href='#tag\/Order\/operation\/get_rest_documents_map'>order document types endpoint<\/a>","type":"integer"}},{"name":"createdAfter","in":"query","description":"start date of document creation in Apilo, takes the value of ISO 8601 date encoded to URL, e.g. <code>2022-03-01T14:40:33%2B0200<\/code>","required":false,"schema":{"pattern":"^(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2})(Z|\\+\\d{2}:?\\d{2})$"}},{"name":"createdBefore","in":"query","description":"end date of document creation in Apilo, takes the value of ISO 8601 date encoded to URL, e.g. <code>2022-03-01T14:40:33%2B0200<\/code>","required":false,"schema":{"pattern":"^(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2})(Z|\\+\\d{2}:?\\d{2})$"}},{"name":"offset","in":"query","description":"Position indicator (0-beginning, 1-skips one record, 256 - skips 256 records)","required":false,"schema":{"minimum":0}},{"name":"limit","in":"query","description":"Limit of returned results, max 512 records","required":false,"schema":{"maximum":512,"minimum":1}}],"responses":{"200":{"description":"Order document array","content":{"application\/json":{"schema":{"allOf":[{"$ref":"#\/components\/schemas\/RestOrderDocumentsIndexResponse"},{"$ref":"#\/components\/schemas\/RestListingResponse"}]}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Order"],"summary":"Create document for order.","description":"Create document for order","operationId":"post_rest_order_documents_create","parameters":[{"name":"id","in":"path","description":"order number in Apilo system, e.g. <code>AL0012345<\/code>","required":true,"schema":{"type":"string","maxLength":11,"minLength":10,"pattern":"^[A-Za-z0-9\\.|]{10,11}$"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestOrderDocumentDTO"}}}},"responses":{"200":{"description":"Order document with the given idExternal already exists","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestOrderDocumentDTO2"}}}},"201":{"description":"Create document correctly","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestOrderDocumentDTO2"}}}},"422":{"description":"Validation fail","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"404":{"description":"Order not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/orders\/{id}\/documents\/{document}\/":{"get":{"tags":["Order"],"summary":"Order Document detail.","description":"Get detailed document by Id for given Order","operationId":"get_rest_order_documents_detail","parameters":[{"name":"id","in":"path","description":"order number in Apilo system, e.g. <code>AL0012345<\/code>","required":true,"schema":{"type":"string","maxLength":11,"minLength":10,"pattern":"^[A-Za-z0-9\\.|]{10,11}$"}},{"name":"document","in":"path","description":"ID of the document belongs to the Apilo order","required":true,"schema":{"type":"string","minimum":1,"pattern":"\\d+"}}],"responses":{"200":{"description":"Order document model","headers":{"Download-Link":{"description":"Link to document file","schema":{"description":"Relative URL","type":"string"}}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestOrderDocumentDTO2"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"404":{"description":"Document or Order not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Order"],"summary":"Delete document for given order.","operationId":"delete_rest_order_documents_delete","parameters":[{"name":"id","in":"path","description":"order number in Apilo system, e.g. <code>AL0012345<\/code>","required":true,"schema":{"type":"string","maxLength":11,"minLength":10,"pattern":"^[A-Za-z0-9\\.|]{10,11}$"}},{"name":"document","in":"path","description":"ID of the document belongs to the Apilo order","required":true,"schema":{"type":"string","minimum":1,"pattern":"[0-9]+"}}],"responses":{"200":{"description":"Delete document correctly","content":{"application\/json":{"schema":{},"example":[]}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"404":{"description":"Document not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/orders\/documents\/map\/":{"get":{"tags":["Order"],"summary":"Get document types map.","description":"Document types map","operationId":"get_rest_documents_map","responses":{"200":{"description":"Returns document types map","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/MappingDTO"}}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/orders\/payment\/map\/":{"get":{"tags":["Order"],"summary":"Get Payment types list.","description":"Get Payment types list","operationId":"get_rest_orders_payment_map","responses":{"200":{"description":"Returns list of Payment type objects","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/MappingDTO"}},"example":[{"id":1,"key":"PAYMENT_TYPE_BANK_TRANSFER","name":"Przelew bankowy","description":"przelew bankowy"},{"id":2,"key":"PAYMENT_TYPE_COD","name":"Pobranie","description":"za pobraniem"},{"id":3,"key":"PAYMENT_TYPE_SERVICE_PAYU","name":"PayU","description":"serwis PayU"}]}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/orders\/status\/map\/":{"get":{"tags":["Order"],"summary":"Get order Status types list.","description":"Get Order Status types list","operationId":"get_rest_orders_status_map","responses":{"200":{"description":"Returns list of order Status objects","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/MappingDTO"}},"example":[{"id":7,"key":"STATUS_7","name":"Nowy","description":"Nowy"},{"id":8,"key":"STATUS_8","name":"Niepotwierdzone","description":"Niepotwierdzone"},{"id":9,"key":"STATUS_9","name":"W realizacji","description":"W realizacji"}]}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/orders\/carrier\/map\/":{"get":{"tags":["Order"],"summary":"Get list of Carrier.","operationId":"get_rest_orders_carrier_map","responses":{"200":{"description":"Returns list of Carrier objects","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/MappingDTO"}},"example":[{"id":3,"key":"CARRIER_253","name":"Inpost (Kurier, Paczkomaty, Allegro)","description":""},{"id":143,"key":"CARRIER_258","name":"Wysy\u0142am z Allegro","description":""},{"id":5,"key":"CARRIER_257","name":"Poczta Polska","description":""}]}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/orders\/carrier-account\/map\/":{"get":{"tags":["Order"],"summary":"Get Carrier Account list.","description":"Get Carrrier Account List","operationId":"get_rest_orders_carrier_account_map","responses":{"200":{"description":"Returns list of Carrier Account objects","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/MappingDTO"}},"example":[{"id":22,"key":"CARRIER_ACCOUNT_143_22","name":"AllegroBroker Minipaczka","description":"Wysy\u0142am z Allegro"},{"id":23,"key":"CARRIER_ACCOUNT_143_23","name":"DPD PL - nowa umowa","description":"DPD Polska"},{"id":15,"key":"CARRIER_ACCOUNT_3_15","name":"Inpost","description":"Inpost (Kurier, Paczkomaty, Allegro"}]}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/orders\/platform\/map\/":{"get":{"tags":["Order"],"summary":"Get Platform list.","description":"Get Platform list","operationId":"get_rest_orders_platform_map","responses":{"200":{"description":"Returns list of Platform object","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/MappingDTO"}},"example":[{"id":44,"key":"PLATFORM_ALLEGRO_44","name":"Allegro","description":"Allegro jankowalski"},{"id":92,"key":"PLATFORM_AMAZON_92","name":"Amazon","description":"Amazon 4x kowalski janek"},{"id":101,"key":"PLATFORM_EMPIK_101","name":"Empik","description":"Empik jan.kowalski@apilo.com"}]}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/orders\/tag\/map\/":{"get":{"tags":["Order"],"summary":"Tag list.","description":"List of tag","operationId":"get_rest_orders_tag_list","responses":{"200":{"description":"Returns list of tag","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/MappingDTO"}},"example":[{"id":9,"key":"TAG_9","name":"BezFV","description":"Bez faktury, kolor: purple-soft"},{"id":5,"key":"TAG_5","name":"DR","description":"Do realizacji, kolor: purple-studio"},{"id":8,"key":"TAG_8","name":"FV","description":"Klient chce faktur\u0119, kolor: yellow-mint"}]}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/orders\/{id}\/note\/":{"get":{"tags":["Order"],"summary":"Get order notes.","operationId":"get_rest_orders_order_note_list","parameters":[{"name":"id","in":"path","description":"order number in Apilo system, e.g. <code>AL0012345<\/code>","required":true,"schema":{"type":"string","maxLength":11,"minLength":10,"pattern":"^[A-Za-z0-9\\.|]{10,11}$"}}],"responses":{"200":{"description":"List of order notes","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestOrderNoteDTO"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"404":{"description":"Invalid platform ID","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Order"],"summary":"Add note to order.","operationId":"post_rest_orders_order_note_create","parameters":[{"name":"id","in":"path","description":"order number in Apilo system, e.g. <code>AL0012345<\/code>","required":true,"schema":{"type":"string","maxLength":11,"minLength":10,"pattern":"^[A-Za-z0-9\\.|]{10,11}$"}}],"requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestOrderNoteDTO2"}}}},"responses":{"201":{"description":"Order note created correctly","content":{"application\/json":{"schema":{},"example":[]}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"404":{"description":"Invalid platform ID","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"422":{"description":"Validation error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/orders\/{id}\/shipment\/":{"get":{"tags":["Order"],"summary":"List of order shipments.","description":"List of shipments belongs to the indicated order","operationId":"get_rest_orders_shipment_list","parameters":[{"name":"id","in":"path","description":"order number in Apilo system, e.g. <code>AL0012345<\/code>","required":true,"schema":{"type":"string","maxLength":11,"minLength":10,"pattern":"^[A-Za-z0-9\\.|]{10,11}$"}},{"name":"offset","in":"query","description":"Position indicator (0-beginning, 1-skips one record, 256 - skips 256 records)","required":false,"schema":{"type":"integer","minimum":0}},{"name":"limit","in":"query","description":"Limit of returned results, max 512 records","required":false,"schema":{"type":"integer","maximum":512,"minimum":1}}],"responses":{"200":{"description":"Shipments array","content":{"application\/json":{"schema":{"allOf":[{"properties":{"list":{"type":"array","items":{"$ref":"#\/components\/schemas\/RestOrderShipmentDTO"},"example":[{"id":1,"idExternal":"SH300021044869"},{"id":2,"idExternal":"SH300021044870"},{"id":3,"idExternal":"SH300021044871"}]}},"type":"object"},{"$ref":"#\/components\/schemas\/RestListingResponse"}]}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Order"],"summary":"Add shipment to order.","description":"Shipment is created as order document, it can be see from <a href='#tag\/Order\/operation\/get_rest_order_documents_detail'>here<\/a>","operationId":"post_rest_orders_shipment_create","parameters":[{"name":"id","in":"path","description":"order number in Apilo system, e.g. <code>AL0012345<\/code>","required":true,"schema":{"type":"string","maxLength":11,"minLength":10,"pattern":"^[A-Za-z0-9\\.|]{10,11}$"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestOrderShipmentDTO2"}}}},"responses":{"200":{"description":"Shipment already exsists","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestOrderShipmentDTO3"}}}},"201":{"description":"Add shipment correctly","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestOrderShipmentDTO3"}}}},"400":{"description":"Courier account is not configuret yet","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"422":{"description":"Validation error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException2"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/orders\/{id}\/shipment\/{shipment}\/":{"get":{"tags":["Order"],"summary":"Shipment detail.","description":"Detail of specific shipment belongs to given order","operationId":"get_rest_orders_shipment_detail","parameters":[{"name":"id","in":"path","description":"order number in Apilo system, e.g. <code>AL0012345<\/code>","required":true,"schema":{"type":"string","maxLength":11,"minLength":10,"pattern":"^[A-Za-z0-9\\.|]{10,11}$"}},{"name":"shipment","in":"path","description":"ID of the shipment belongs to the Apilo order","required":true,"schema":{"type":"string","pattern":"\\d+"}}],"responses":{"200":{"description":"Shipment model","headers":{"Download-Link":{"description":"Link to label file","schema":{"description":"Relative URL","type":"string"}}},"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestOrderShipmentDTO3"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"404":{"description":"Document or Order not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/orders\/shipment\/status\/map\/":{"get":{"tags":["Order"],"summary":"Get shipment status map.","description":"Shipment status map","operationId":"get_rest_orders_shipment_status_map","responses":{"200":{"description":"Returns shipment status map","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/MappingDTO"}}}}},"401":{"description":"Authorization failed"}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/orders\/{orderId}\/tag\/":{"get":{"tags":["Order"],"summary":"Order tags list.","description":"Order tags list","operationId":"get_rest_orders_order_tag_list","parameters":[{"name":"offset","in":"query","required":false,"schema":{"description":"Position indicator (0-beginning, 1-skips one record, 256 - skips 256 records)","type":"integer","format":"int32","minimum":0}},{"name":"limit","in":"query","required":false,"schema":{"description":"Limit of returned results, max 512 records","type":"integer","format":"int32","maximum":512,"minimum":1}},{"name":"orderId","in":"path","description":"Order ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns list of order tags","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestTagsDTO"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"404":{"description":"Order not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Order"],"summary":"Create order tag.","description":"Create order tag","operationId":"post_rest_orders_order_tag_create","parameters":[{"name":"orderId","in":"path","description":"Order ID","required":true,"schema":{"type":"string"}}],"requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/OrderTagPost"}}}},"responses":{"201":{"description":"Create order tag correctly","content":{"application\/json":{"schema":{},"example":[]}}},"304":{"description":"No changes was made","content":{"application\/json":{"schema":{},"example":[]}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"404":{"description":"Order or tag not exist","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/orders\/{orderId}\/tag\/{tagId}\/":{"delete":{"tags":["Order"],"summary":"Delete order tag.","description":"Delete order tag","operationId":"delete_rest_orders_order_tag_delete","parameters":[{"name":"orderId","in":"path","description":"Order ID","required":true,"schema":{"type":"string"}},{"name":"tagId","in":"path","description":"Tag ID","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Delete order tag correctly"},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"404":{"description":"Order tag not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/sale\/":{"get":{"tags":["Sale"],"summary":"Get list of sales channels.","operationId":"get_rest_sale_index","responses":{"200":{"description":"Return list of sales channels","content":{"application\/json":{"schema":{},"example":[]}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/sale\/auction\/":{"get":{"tags":["Sale"],"summary":"Get auctions list.","operationId":"get_rest_sale_auction_index","responses":{"200":{"description":"Returns list of auctions","content":{"application\/json":{"schema":{},"example":[]}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/shipping\/shipment\/{id}\/":{"get":{"tags":["Shipment"],"summary":"Get detailed shipment by given ID.","operationId":"get_rest_shipment_details","parameters":[{"name":"id","in":"path","description":"Shipment ID","required":true,"schema":{"type":"string","pattern":"(\\d+)"}}],"responses":{"200":{"description":"Detailed shipment object","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestShipmentDetailsDTO"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"404":{"description":"Shipment not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}}}},"\/rest\/api\/shipping\/shipment\/info\/":{"get":{"tags":["Shipment"],"summary":"Get list of shipments for given filters.","operationId":"get_rest_shipment_info_index","parameters":[{"name":"carrierAccountId[]","in":"query","description":"Carrier account IDs","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"carrierBrokerId[]","in":"query","description":"Carrier broker IDs","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"postDateAfter","in":"query","required":false,"schema":{"description":"Date of shipment creation from in Apilo, takes the value of ISO 8601 date encoded to URL, e.g. <code>2022-03-01T14:40:33%2B0200<\/code>","type":"string","format":"date-time","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2})(Z|\\+\\d{2}:?\\d{2})$"}},{"name":"postDateBefore","in":"query","required":false,"schema":{"description":"Date of shipment creation from in Apilo, takes the value of ISO 8601 date encoded to URL, e.g. <code>2022-03-01T14:40:33%2B0200<\/code>","type":"string","format":"date-time","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2})(Z|\\+\\d{2}:?\\d{2})$"}},{"name":"status[]","in":"query","description":"Status of shipment (0 - New parcel, not yet shipped, 1 - The parcel is waiting in the waiting room, it has not been sent, 2 - A new parcel, registered in the courier's system but does not have a status yet, 21 - Package in delivery, 9 - Package removed, 31 - The parcel is waiting for collection (collection point, notice), 32 - Return of the parcel to the sender, other error, 100 - Parcel received, 101 - Return parcel delivered)","required":false,"schema":{"type":"array","items":{"type":"integer","enum":[0,1,2,21,9,31,32,100,101]}}}],"responses":{"200":{"description":"Returns list of shipments","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestShipmentInfoIndexResponse"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}}}},"\/rest\/api\/shipping\/shipment\/tracking\/":{"get":{"tags":["Shipment"],"summary":"Get a list of shipments tracking information for given filters.","description":"List of shipments tracking","operationId":"get_rest_shipment_tracking","parameters":[{"name":"carrierAccountId[]","in":"query","description":"Carrier account IDs","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"carrierBrokerId[]","in":"query","description":"Carrier broker IDs","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"postDateAfter","in":"query","required":false,"schema":{"description":"Date of shipment creation from in Apilo, takes the value of ISO 8601 date encoded to URL, e.g. <code>2022-03-01T14:40:33%2B0200<\/code>","type":"string","format":"date-time","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2})(Z|\\+\\d{2}:?\\d{2})$"}},{"name":"postDateBefore","in":"query","required":false,"schema":{"description":"Date of shipment creation from in Apilo, takes the value of ISO 8601 date encoded to URL, e.g. <code>2022-03-01T14:40:33%2B0200<\/code>","type":"string","format":"date-time","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2})(Z|\\+\\d{2}:?\\d{2})$"}},{"name":"receivedDateAfter","in":"query","required":false,"schema":{"description":"Date by which the shipment was delivered, takes the value of ISO 8601 date encoded to URL, e.g. <code>2022-03-01T14:40:33%2B0200<\/code>","type":"string","format":"date-time","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2})(Z|\\+\\d{2}:?\\d{2})$"}},{"name":"receivedDateBefore","in":"query","required":false,"schema":{"description":"Date from which the shipment was delivered, takes the value of ISO 8601 date encoded to URL, e.g. <code>2022-03-01T14:40:33%2B0200<\/code>","type":"string","format":"date-time","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2})(Z|\\+\\d{2}:?\\d{2})$"}},{"name":"status[]","in":"query","description":"Status of shipment (0 - New parcel, not yet shipped, 1 - The parcel is waiting in the waiting room, it has not been sent, 2 - A new parcel, registered in the courier's system but does not have a status yet, 21 - Package in delivery, 9 - Package removed, 31 - The parcel is waiting for collection (collection point, notice), 32 - Return of the parcel to the sender, other error, 100 - Parcel received, 101 - Return parcel delivered)","required":false,"schema":{"type":"array","items":{"type":"integer","enum":[0,1,2,21,9,31,32,100,101]}}}],"responses":{"200":{"description":"Returns list of shipments","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestShipmentTrackingResponse"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}}}},"\/rest\/api\/shipping\/carrier-account\/map\/":{"get":{"tags":["Shipment"],"summary":"Get Carrier Account list.","description":"Get Carrier Account List","operationId":"get_rest_shipment_carrier_account_map","responses":{"200":{"description":"Returns list of Carrier Account","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CarrierAccountMappingListingDTO"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"422":{"description":"Unprocessable Entity","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}}}},"\/rest\/api\/shipping\/carrier-account\/{id}\/method\/":{"get":{"tags":["Shipment"],"summary":"Get Carrier sending methods.","description":"","operationId":"get_rest_shipment_carrier_sending_methods","parameters":[{"name":"id","in":"path","description":"Carrier Account ID","required":true,"schema":{"type":"string","pattern":"(\\d+)"}}],"responses":{"200":{"description":"Returns list of Carrier Account sending methods","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestCarrierMethodListingDTO"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"422":{"description":"Unprocessable Entity","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"404":{"description":"Carrier Account not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}}}},"\/rest\/api\/shipping\/carrier-account\/{carrierAccountId}\/method\/{method}\/map\/":{"get":{"tags":["Shipment"],"summary":"Get list of shipment option need to create new shipment.","description":"List of shipment options need to create new shipment.","operationId":"get_rest_shipment_options","parameters":[{"name":"carrierAccountId","in":"path","description":"Carrier account ID","required":true,"schema":{"type":"string","pattern":"(\\d{1,5})"}},{"name":"method","in":"path","description":"Delivery method","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Returns list of shipment options need to create new shipment.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestShipmentOptionsAndParcelsDTO"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"422":{"description":"Unprocessable Entity","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}}}},"\/rest\/api\/shipping\/shipment\/":{"post":{"tags":["Shipment"],"summary":"Creates a new shipment from the submitted data.","operationId":"post_rest_shipment_new_shipment","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/NewShipmentDTO"}}}},"responses":{"200":{"description":"Returns list of identifiers for created shipments.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/NewShipmentsCreatedResponse"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"422":{"description":"Unprocessable Entity","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}}}},"\/rest\/api\/shipping\/carrier-document\/":{"get":{"tags":["Shipment"],"summary":"Get list of shipment carrier documents.","description":"List of carrier documents for carrier accounts","operationId":"get_rest_shipment_carrier_document_index","parameters":[{"name":"carrierAccountId[]","in":"query","description":"Carrier account IDs","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"createdAtAfter","in":"query","required":false,"schema":{"description":"Date of shipment carrier document creation from in Apilo, takes the value of ISO 8601 date encoded to URL, e.g. <code>2022-03-01T14:40:33%2B0200<\/code>","type":"string","format":"date-time","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2})(Z|\\+\\d{2}:?\\d{2})$"}},{"name":"createdAtBefore","in":"query","required":false,"schema":{"description":"Date of shipment carrier document creation from in Apilo, takes the value of ISO 8601 date encoded to URL, e.g. <code>2022-03-01T14:40:33%2B0200<\/code>","type":"string","format":"date-time","pattern":"^(\\d{4})-(\\d{2})-(\\d{2})T(\\d{2}):(\\d{2}):(\\d{2})(Z|\\+\\d{2}:?\\d{2})$"}}],"responses":{"200":{"description":"Returns list of shipment carrier documents","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestShipmentCarrierDocumentsListingResponse"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}}},"post":{"tags":["Shipment"],"summary":"Confirm shipment and order pickup.","operationId":"post_rest_shipment_carrier_document_create","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestShippingConfirmationsDTO"}}}},"responses":{"201":{"description":"Shipping confirmation created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestShippingConfirmationsListingResponseDTO"}}}},"400":{"description":"The request body must contain at least one shipment confirmation","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"413":{"description":"The limit of 128 shipment confirmations has been exceeded","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"422":{"description":"Validation error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}}}},"\/rest\/api\/shipping\/pickup-date-proposal\/":{"post":{"tags":["Shipment"],"summary":"Get shipment pick up date proposal.","operationId":"post_rest_shipment_pickup_date_proposal","requestBody":{"description":"","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestShipmentsDTO"}}}},"responses":{"200":{"description":"Pickup date proposals","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestShipmentPickupDateProposalsListingDTO"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"422":{"description":"Validation error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"409":{"description":"Validation error - Shipments are associated with different carrier accounts.","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}}}},"\/rest\/api\/warehouse\/attribute\/":{"get":{"tags":["Warehouse"],"summary":"Attribute List.","description":"List of attributes","operationId":"get_rest_warehouse_attribute_index","parameters":[{"name":"offset","in":"query","required":false,"schema":{"description":"Position indicator (0-beginning, 1-skips one record, 256 - skips 256 records)","type":"integer","format":"int32","minimum":0}},{"name":"limit","in":"query","required":false,"schema":{"description":"Limit of returned results, max 512 records","type":"integer","format":"int32","maximum":512,"minimum":1}}],"responses":{"200":{"description":"Attributes array","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestAttributesIndexResponse"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Warehouse"],"summary":"Attribute create.","operationId":"post_rest_warehouse_attribute_create","requestBody":{"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestAttributesDTO"}}}},"responses":{"200":{"description":"Nothing to create","content":{"application\/json":{"schema":{},"example":[]}}},"201":{"description":"Create attributes correctly","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestAttributesDTO"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"422":{"description":"Validation error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]},"patch":{"tags":["Warehouse"],"summary":"Attribute update.","operationId":"patch_rest_warehouse_attribute_update","requestBody":{"description":"\n    Typ Wielu Warto\u015bci:\n    1 W celu utworzenia nowej warto\u015bci, wymagana jest podanie parametru attributeFeatures.id jako null,\n    2 W celu aktualicji istniej\u0105cej warto\u015bci wymagane jest podanie parametru attributeFeatures.id jako warto\u015bc i podanie parametru value.\n    3 Nie podanie warto\u015bci, kt\u00f3re powinny by\u0107 zachowane, spowoduje ich usuni\u0119cie\n    ","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestAttributesDTO2"}}}},"responses":{"200":{"description":"Attributes update correctly","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestAttributesDTO2"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"422":{"description":"Validation error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/warehouse\/product\/attributes\/":{"get":{"tags":["Warehouse"],"summary":"Product attribute list.","description":"list of product attributes","operationId":"get_rest_warehouse_product_attribute_index","parameters":[{"name":"offset","in":"query","required":false,"schema":{"description":"Position indicator (0-beginning, 1-skips one record, 256 - skips 256 records)","type":"integer","format":"int32","minimum":0}},{"name":"limit","in":"query","required":false,"schema":{"description":"Limit of returned results, max 512 records","type":"integer","format":"int32","maximum":512,"minimum":1}}],"responses":{"200":{"description":"Attributes array","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestProductAttributeIndexResponse"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Warehouse"],"summary":"Product Attributes Delete.","description":"Delete a product attributes","operationId":"delete_rest_warehouse_product_attribute_delete","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestProductAttributesDTO"}}}},"responses":{"204":{"description":"Delete product attributes complete","content":{"application\/json":{"schema":{},"example":[]}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]},"patch":{"tags":["Warehouse"],"summary":"Product Attribute update.","description":"Update a product attributes","operationId":"patch_rest_warehouse_product_attribute_update","requestBody":{"description":"Product Attributes","required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestProductAttributesDTO2"}}}},"responses":{"200":{"description":"Product Attributes updated successfully","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestProductAttributeIndexResponse2"}}}},"422":{"description":"Validation error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/warehouse\/product\/media\/":{"get":{"tags":["Warehouse"],"summary":"Products Media list.","description":"List of Product media","operationId":"get_rest_warehouse_productmedia_getproductmedia","parameters":[{"name":"onlyMain","in":"query","required":false,"schema":{"type":"boolean"}},{"name":"productIds[]","in":"query","required":false,"schema":{"type":"array","items":{"type":"integer"}}},{"name":"offset","in":"query","required":false,"schema":{"description":"Position indicator (0-beginning, 1-skips one record, 256 - skips 256 records)","type":"integer","format":"int32","minimum":0}},{"name":"limit","in":"query","required":false,"schema":{"description":"Limit of returned results, max 512 records","type":"integer","format":"int32","maximum":512,"minimum":1}}],"responses":{"200":{"description":"Product media list","content":{"application\/json":{"schema":{"allOf":[{"properties":{"media":{"type":"array","items":{"$ref":"#\/components\/schemas\/RestProductAttributeAttachmentItemDTO"}}},"type":"object"},{"$ref":"#\/components\/schemas\/RestListingResponse"}]}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"422":{"description":"Validation error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/warehouse\/category\/":{"get":{"tags":["Warehouse"],"summary":"Categories list.","operationId":"get_rest_warehouse_category_index","parameters":[{"name":"id","in":"query","required":false,"schema":{"description":"Internal Apilo Id for category","type":"integer"}},{"name":"offset","in":"query","required":false,"schema":{"description":"Position indicator (0-beginning, 1-skips one record, 256 - skips 256 records)","type":"integer","format":"int32","minimum":0}},{"name":"limit","in":"query","required":false,"schema":{"description":"Limit of returned results, max 512 records","type":"integer","format":"int32","maximum":512,"minimum":1}}],"responses":{"200":{"description":"Returns simple list of categories","content":{"application\/json":{"schema":{"allOf":[{"properties":{"categories":{"type":"array","items":{"$ref":"#\/components\/schemas\/RestCategoryDTO"}}},"type":"object"},{"$ref":"#\/components\/schemas\/RestListingResponse"}]}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Warehouse"],"summary":"Category create.","operationId":"post_rest_warehouse_category_create","requestBody":{"description":"Category Creation","required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CategoryCreateModel"}}}},"responses":{"200":{"description":"Nothing to create","content":{"application\/json":{"schema":{},"example":[]}}},"201":{"description":"Create categories correctly","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/CreateCategoriesResponse"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"413":{"description":"Too many Category objects submitted (max 512)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"422":{"description":"Validation error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/warehouse\/product\/":{"get":{"tags":["Warehouse"],"summary":"Products list.","operationId":"get_rest_warehouse_product_index","parameters":[{"name":"id","in":"query","required":false,"schema":{"type":"integer"}},{"name":"sku","in":"query","required":false,"schema":{"type":"string"}},{"name":"name","in":"query","required":false,"schema":{"type":"string"}},{"name":"ean","in":"query","required":false,"schema":{"type":"string"}},{"name":"status","in":"query","description":"Product status (`0-inactive`, `1-active`, `8-archive`)","required":false,"schema":{"enum":[0,1,8]}},{"name":"offset","in":"query","required":false,"schema":{"description":"Limit of returned results","type":"integer"}},{"name":"limit","in":"query","description":"Position indicator (0-beginning, 1-skips one record, 256 - skips 256 records), max 2000 records","required":false,"schema":{"type":"integer"}}],"responses":{"200":{"description":"Returns simple list of products","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/GetProductsResponse"}}}}},"security":[{"BearerAuth":[]}]},"put":{"tags":["Warehouse"],"summary":"Products data update.","operationId":"put_rest_warehouse_product_update","requestBody":{"description":"\n    Aktualizacja danych identyfikacyjnych produktu mo\u017cliwa jest wg. nast\u0119puj\u0105cych zasad:\n    \u25cf Nie mo\u017cna dokona\u0107 zmiany p\u00f3l id oraz originalCode ,\n    \u25cf Wype\u0142niaj\u0105c pole id lub originalCode mo\u017cna dokona\u0107 aktualizacji wszystkich\n    pozosta\u0142ych danych identyfikacyjnych (w tym sku oraz ean),\n    \u25cf nie przekazuj\u0105c p\u00f3l id oraz originalCode mo\u017cna dokona\u0107 aktualizacji tylko danych\n    nie identyfikacyjnych produktu (za wyj\u0105tkiem ean)","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/ProductPut"}}}}},"responses":{"200":{"description":"Update product correctly","content":{"application\/json":{"schema":{},"example":{"updated":1}}}},"304":{"description":"No updates","content":{"application\/json":{"schema":{},"example":"[]"}}},"400":{"description":"Invalid payload","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"413":{"description":"Too many Product objects submitted (max 128)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"422":{"description":"Validation error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Warehouse"],"summary":"Products create.","operationId":"post_rest_warehouse_product_create","requestBody":{"description":"\n    1 Poniewa\u017c pojedynczy produkt tworzony jest w systemie Apilo zawsze jako grupa\n    produkt\u00f3w z jedn\u0105 kombinacj\u0105 produktu, domy\u015blnie nazwa grupy jest r\u00f3wnie\u017c nazw\u0105\n    produktu. Aby \u201csterowa\u0107\u201d nazw\u0105 grupy produkt\u00f3w nale\u017cy wype\u0142ni\u0107 dodatkowe pole o nazwie\n    groupName (np. groupName=Rolki agresywne EXTREM II name=Kolor niebieski\n\n    2 Przekazana tablica zdj\u0119\u0107 mo\u017ce by\u0107 tablic\u0105 asocjacyjn\u0105 gdzie kluczem jest zewn\u0119trzny\n    identyfikator zdj\u0119cia (przydatne przy aktualizacji produktu - zostan\u0105 dodane tylko\n    nieistniej\u0105ce pozycje w systemie Apilo), a warto\u015bci\u0105 adres URL zdj\u0119cia.\n     * ","required":true,"content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/Products"}}}}},"responses":{"201":{"description":"Create products correctly","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ProductsCreateResponse"}}}},"200":{"description":"No products was created","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ProductsNotCreateResponse"}}}},"400":{"description":"Invalid payload","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"413":{"description":"Too many Product objects submitted (max 128)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"422":{"description":"Validation error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]},"patch":{"tags":["Warehouse"],"summary":"Products PATCH update.","operationId":"patch_rest_warehouse_product_put","requestBody":{"description":"Maksymalnie 512 rekord\u00f3w, aktualizacja po id lub originalCode","content":{"application\/json":{"schema":{"type":"array","items":{"$ref":"#\/components\/schemas\/ProductBaseModel"}}}}},"responses":{"200":{"description":"Update products correctly","content":{"application\/json":{"schema":{},"example":{"changes":10}}}},"304":{"description":"No updates","content":{"application\/json":{"schema":{},"example":"['changes' = 0]"}}},"400":{"description":"Invalid payload","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"413":{"description":"Too many Product objects submitted (max 128)","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"422":{"description":"Validation error","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/warehouse\/product\/{id}\/":{"get":{"tags":["Warehouse"],"summary":"Get Product detail.","operationId":"get_rest_warehouse_product_details","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"\\d+"}}],"responses":{"200":{"description":"Returns detailed Product object","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/ProductDetailModel"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"404":{"description":"Product not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]},"delete":{"tags":["Warehouse"],"summary":"Delete Product.","description":"Delete Product","operationId":"delete_rest_warehouse_product_delete","parameters":[{"name":"id","in":"path","required":true,"schema":{"type":"string","pattern":"\\d+"}}],"responses":{"200":{"description":"Delete product correctly","content":{"application\/json":{"schema":{},"example":[]}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"404":{"description":"Product not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/warehouse\/price-calculated\/":{"get":{"tags":["Warehouse"],"summary":"Prices list.","description":"List of prices","operationId":"get_rest_warehouse_price_calculated_list","parameters":[{"name":"price","in":"query","required":true,"schema":{"description":"Price list ID","type":"integer"}},{"name":"offset","in":"query","required":false,"schema":{"description":"Start on record","type":"integer"}},{"name":"limit","in":"query","required":false,"schema":{"description":"Limit of returned results, max 2000 records","type":"integer"}}],"responses":{"200":{"description":"Returns list of prices","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/Prices"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"404":{"description":"Prices not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]},"post":{"tags":["Warehouse"],"summary":"Price create and update.","description":"Create\/update product price","operationId":"post_rest_warehouse_price_calculated_create_update","requestBody":{"required":true,"content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/PriceCalculatedPost"}}}},"responses":{"201":{"description":"Create\/update price correctly","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/IdModel"}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"422":{"description":"Create\/Update\/Validation price failed","content":{"application\/json":{"schema":{"oneOf":[{"$ref":"#\/components\/schemas\/RestBundleException"},{"$ref":"#\/components\/schemas\/RestProductNotFoundException"}]}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/warehouse\/price-calculated\/{product}\/{price}\/":{"delete":{"tags":["Warehouse"],"summary":"Delete price.","description":"Delete product price","operationId":"delete_rest_warehouse_price_calculated_delete","parameters":[{"name":"product","in":"path","description":"Unique product ID","required":true,"schema":{"type":"string","minimum":1}},{"name":"price","in":"path","description":"Unique price list ID","required":true,"schema":{"type":"string","minimum":1}}],"responses":{"200":{"description":"Delete price correctly","content":{"application\/json":{"schema":{},"example":[]}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"404":{"description":"Price not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"500":{"description":"Delete price failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}},"\/rest\/api\/warehouse\/price\/":{"get":{"tags":["Warehouse"],"summary":"Price lists.","description":"List of price lists","operationId":"get_rest_warehouse_price_index","responses":{"200":{"description":"Returns list of price lists","content":{"application\/json":{"schema":{"allOf":[{"properties":{"list":{"type":"array","items":{"$ref":"#\/components\/schemas\/RestPriceDTO"}}},"type":"object"},{"$ref":"#\/components\/schemas\/RestListingResponse"}]}}}},"401":{"description":"Authorization failed","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}},"404":{"description":"Price lists not found","content":{"application\/json":{"schema":{"$ref":"#\/components\/schemas\/RestBundleException"}}}}},"security":[{"BearerAuth":[]}]}}},"components":{"schemas":{"AuthorizationRequest":{"required":["grantType","token"],"properties":{"grantType":{"description":"Authorization grant type","type":"string","enum":["authorization_code","refresh_token"]},"token":{"description":"Authorization code when grant type is <code>authorization_code<\/code> or Refresh token when grant type is <code>refresh_token<\/code>","type":"string","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJleGFtcGxlLmVycGJveC5wbCIsImV4cCI6MTYxNTg5NzYxOSwianRpIjoiOTc2YjYxYmItNWRkMC01MjIxLWExY2MtNzNiY2Q0MzVhNGMyIiwidHlwZSI6InJlZnJlc2hfdG9rZW4iLCJjbGllbnRfaWQiOjIsInBsYXRmb3JtX2lkIjoxLCJpYXQiOjE2MDc5NTMyMTl9.XH8X9cA0eb0RNlQJn8_jIQFDFVmKnOCDO0YWVvaM5B8"},"developerId":{"title":"optional.","description":"Developer UUID (optional)","type":"string","example":"abc8c088-f9e0-42a8-b2e7-3fa0e90aa1be","nullable":true}},"type":"object"},"AuthorizationResponse":{"properties":{"accessToken":{"description":"Access token","type":"string","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJleGFtcGxlLmVycGJveC5wbCIsImV4cCI6MTYwOTc2NzYxOSwianRpIjoiZTg0Yjg3MWItMjg1NS01NzVkLWJlYzMtNzdhMjcwOTdlOTYyIiwidHlwZSI6ImFjY2Vzc190b2tlbiIsImNsaWVudF9pZCI6MiwicGxhdGZvcm1faWQiOjEsImlhdCI6MTYwNzk1MzIxOX0.iQJ78Xqd7exf7M6l26iWS-Nor0AjxJKwsyHPwOFpJ-s"},"accessTokenExpireAt":{"description":"Access token expire date","type":"string","format":"date-time","example":"2021-01-04T14:40:19Z"},"refreshToken":{"description":"Refresh token","type":"string","example":"eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJleGFtcGxlLmVycGJveC5wbCIsImV4cCI6MTYxNTg5NzYxOSwianRpIjoiOTc2YjYxYmItNWRkMC01MjIxLWExY2MtNzNiY2Q0MzVhNGMyIiwidHlwZSI6InJlZnJlc2hfdG9rZW4iLCJjbGllbnRfaWQiOjIsInBsYXRmb3JtX2lkIjoxLCJpYXQiOjE2MDc5NTMyMTl9.XH8X9cA0eb0RNlQJn8_jIQFDFVmKnOCDO0YWVvaM5B8"},"refreshTokenExpireAt":{"description":"Refresh token expire date","type":"string","format":"date-time","example":"2021-03-16T13:26:59Z"}},"type":"object"},"RestBundleException":{"properties":{"message":{"type":"string"},"code":{"type":"integer"},"description":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#\/components\/schemas\/RestBundleException"}},"field":{"type":"string"}},"type":"object"},"RestDocumentConfigsIndexResponse":{"properties":{"documentConfigs":{"title":"Array of numbering series.","description":"List of numbering series of accounting documents","type":"array","items":{"$ref":"#\/components\/schemas\/RestDocumentConfigDTO"},"example":[{"id":1,"type":1,"name":"Faktura (domy\u015blnie)","status":1},{"id":2,"type":31,"name":"Faktura koryguj\u0105ca (domy\u015blnie)","status":1},{"id":3,"type":5,"name":"Paragon (domy\u015blnie)","status":1},{"id":4,"type":10,"name":"Faktura pro forma (domy\u015blnie)","status":1}]},"totalCount":{"description":"Number of matching results","type":"integer","minimum":0,"example":7398},"currentOffset":{"description":"Current list offset","type":"integer","minimum":0,"example":0},"pageResultCount":{"description":"Number of results per page","type":"integer","maximum":512,"minimum":0,"example":64}},"type":"object"},"RestListingResponse":{"title":"List response","description":"This object represents list response.","properties":{"totalCount":{"description":"Number of matching results","type":"integer","minimum":0,"example":7398},"currentOffset":{"description":"Current list offset","type":"integer","minimum":0,"example":0},"pageResultCount":{"description":"Number of results per page","type":"integer","maximum":512,"minimum":0,"example":64}},"type":"object"},"RestDocumentsIndexResponse":{"properties":{"documents":{"title":"Array of documents.","description":"List of accounting documents","type":"array","items":{"$ref":"#\/components\/schemas\/RestDocumentDTO"}},"totalCount":{"description":"Number of matching results","type":"integer","minimum":0,"example":7398},"currentOffset":{"description":"Current list offset","type":"integer","minimum":0,"example":0},"pageResultCount":{"description":"Number of results per page","type":"integer","maximum":512,"minimum":0,"example":64}},"type":"object"},"RestDocumentDocumentDTO":{"required":["idExternal","number","status"],"properties":{"idExternal":{"description":"Unique document ID","type":"integer","example":24},"number":{"description":"Document number","type":"string","example":"DOC\/013\/2023","nullable":true},"status":{"title":"\n4 - disabled, 1 - enabled","description":"1-enabled\/ok, 4-disabled\/error","type":"string","enum":[1,4],"example":1},"type":{"description":"1-printed (default), 2-exported to an external platform","type":"string","enum":[1,2],"example":1},"preferences":{"$ref":"#\/components\/schemas\/DocumentDocumentCreatePreferencesDTO"}},"type":"object"},"RestDocumentDocumentDTO2":{"required":["idExternal","number","status"],"properties":{"id":{"description":"Internal ID","type":"integer","example":7},"idExternal":{"description":"Unique document ID","type":"integer","example":24},"number":{"description":"Document number","type":"string","example":"DOC\/013\/2023","nullable":true},"status":{"title":"\n4 - disabled, 1 - enabled","description":"1-enabled\/ok, 4-disabled\/error","type":"string","enum":[1,4],"example":1},"type":{"description":"1-printed (default), 2-exported to an external platform","type":"string","enum":[1,2],"example":1},"preferences":{"$ref":"#\/components\/schemas\/DocumentDocumentCreatePreferencesDTO2"}},"type":"object"},"HelloResponse":{"properties":{"content":{"type":"string"}},"type":"object"},"ContentDTO":{"properties":{"content":{"description":"Response Content","type":"array","items":{"$ref":"#\/components\/schemas\/WhoamiDTO"}}},"type":"object"},"Media":{"title":"Media attachment model","required":["uuid","name","type"],"properties":{"uuid":{"title":"Unique internal ID.","type":"string","example":"2ed996a6-0b91-529c-9728-f2e59532e7bc"},"name":{"title":"Final name of the file.","type":"string","example":"Invoice-22-12-2020.pdf"},"type":{"title":"Type of file (MIME type).","type":"string","example":"application\/pdf"},"expiresAt":{"description":"Expiration date","type":"string","format":"date-time","example":"2022-03-08T20:00:00Z"}},"type":"object"},"RestBundleException2":{"properties":{"message":{"type":"string"},"code":{"type":"integer"},"description":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#\/components\/schemas\/RestBundleException2"}},"field":{"type":"string"}},"type":"object"},"RestOrdersIndexResponse":{"properties":{"orders":{"title":"Array of orders.","description":"List of orders","type":"array","items":{"$ref":"#\/components\/schemas\/RestOrderReadDTO2"}},"totalCount":{"description":"Number of matching results","type":"integer","minimum":0,"example":7398},"currentOffset":{"description":"Current list offset","type":"integer","minimum":0,"example":0},"pageResultCount":{"description":"Number of results per page","type":"integer","maximum":512,"minimum":0,"example":64}},"type":"object"},"RestBundleException3":{"properties":{"message":{"type":"string"},"code":{"type":"integer"},"description":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#\/components\/schemas\/RestBundleException3"}},"field":{"type":"string"}},"type":"object"},"RestOrderWriteDTO":{"title":"Order","description":"This object represents a single order.","required":["paymentStatus","platformId","paymentType","originalCurrency","originalAmountTotalWithoutTax","originalAmountTotalWithTax","originalAmountTotalPaid","orderItems","addressCustomer","addressDelivery","carrierAccount","orderedAt","status"],"properties":{"platformId":{"description":"<a href='#tag\/Order\/operation\/get_rest_orders_platform_map'>Sale platform account ID<\/a>","type":"integer","minimum":1,"example":1},"idExternal":{"title":"Provided by external systems.","description":"External order ID, e.g. on the sales platform","type":"string","maxLength":36,"example":"WWW\/341\/2023","nullable":true},"isInvoice":{"description":"Does the customer want a VAT invoice?","type":"boolean","example":true},"customerLogin":{"type":"string","maxLength":128,"example":"user123"},"paymentStatus":{"description":"Payment status (`0-no payment`, `1-partially paid`, `2-paid in full\/amount in accordance with the order`, `3-overpayment`)","type":"string","enum":[0,1,2,3],"example":2},"paymentType":{"title":"integer.","description":"<a href='#tag\/Order\/operation\/get_rest_orders_payment_map'>Payment method ID<\/a>","type":"integer","minimum":1,"example":2},"originalCurrency":{"description":"Order currency","type":"string","maxLength":3,"minLength":3,"example":"PLN"},"originalAmountTotalWithoutTax":{"description":"Value of the order items without tax","type":"string","maximum":99999999.99,"minimum":0.01,"example":1024.37,"nullable":true},"originalAmountTotalWithTax":{"description":"Value of order items including tax","type":"string","maximum":99999999.99,"minimum":0.01,"example":1259.98,"nullable":true},"originalAmountTotalPaid":{"description":"Gross amount paid by customer in original currency","type":"string","maximum":99999999.99,"minimum":0,"example":1259.98,"nullable":true},"sendDateMin":{"description":"Minimal shipping date","type":"string","format":"date-time","example":"2022-03-07T00:00:00Z","nullable":true},"sendDateMax":{"description":"Maximum shipping date","type":"string","format":"date-time","example":"2022-03-08T20:00:00Z","nullable":true},"preferences":{"description":"Extra order fields","properties":{"idUser":{"type":"string","example":"user-12345"}},"type":"object","example":{"idUser":"user-12345"}},"orderItems":{"description":"Order items list","type":"array","items":{"$ref":"#\/components\/schemas\/RestOrderItemsDTO"},"example":[{"id":1,"idExternal":"359","ean":"400638133393","sku":"P44\/3-T1.2","originalName":"Samsung Galaxy S20 Plus Black 128GB 5G","originalCode":"PHONE-S20-128GB-B","originalPriceWithTax":"2799.99","originalPriceWithoutTax":"2799.99","media":null,"quantity":2,"tax":"23.00","productSet":null,"status":1,"unit":"Szt.","type":1,"productId":12345},{"id":2,"idExternal":null,"ean":null,"sku":"ship-pp","originalName":"Wysy\u0142ka - Poczta Polska - Pocztex","originalCode":null,"originalPriceWithTax":"10.00","originalPriceWithoutTax":"10.00","media":null,"quantity":1,"tax":null,"productSet":null,"status":1,"unit":null,"type":2,"productId":null}]},"orderPayments":{"title":"Wp\u0142aty klienta.","description":"Order payments list","type":"array","items":{"$ref":"#\/components\/schemas\/RestOrderPaymentDTO"},"example":[{"idExternal":"PAY-123456","amount":1259.98,"paymentDate":"2022-03-08T20:00:00Z","type":1,"comment":"Komentarz do wp\u0142aty"}]},"addressCustomer":{"$ref":"#\/components\/schemas\/RestOrderAddressDTO"},"addressDelivery":{"$ref":"#\/components\/schemas\/RestOrderAddressDTO2"},"addressInvoice":{"$ref":"#\/components\/schemas\/RestOrderAddressDTO3"},"carrierAccount":{"description":"<a href='#tag\/Order\/operation\/get_rest_orders_carrier_account_map'>Carrier account ID<\/a>","type":"integer","minimum":1,"example":1},"orderNotes":{"title":"Array of objects.","description":"Order notes and comments","type":"array","items":{"$ref":"#\/components\/schemas\/RestOrderNoteDTO2"}},"orderedAt":{"title":"DateTime format.","description":"Date when the order was created by the customer","type":"string","format":"date-time","example":"2022-06-09T10:59:12+0100","nullable":true},"status":{"description":"<a href='#tag\/Order\/operation\/get_rest_orders_shipment_status_map'>Status ID<\/a>","type":"integer","minimum":1,"example":3}},"type":"object"},"RestOrderReadDTO":{"title":"Order","description":"This object represents a single order.","required":["paymentStatus","platformId","paymentType","originalCurrency","originalAmountTotalWithoutTax","originalAmountTotalWithTax","originalAmountTotalPaid","orderItems","addressCustomer","addressDelivery","carrierAccount","orderedAt","status"],"properties":{"platformAccountId":{"description":"<a href='#tag\/Order\/operation\/get_rest_orders_platform_map'>Sale platform account ID<\/a>","type":"integer","minimum":1,"example":1},"platformId":{"description":"Sale platform ID","type":"integer","minimum":1,"example":1},"idExternal":{"title":"Provided by external systems.","description":"External order ID, e.g. on the sales platform","type":"string","maxLength":36,"example":"WWW\/341\/2023","nullable":true},"isInvoice":{"description":"Does the customer want a VAT invoice?","type":"boolean","example":true},"customerLogin":{"type":"string","maxLength":128,"example":"user123"},"paymentStatus":{"description":"Payment status (`0-no payment`, `1-partially paid`, `2-paid in full\/amount in accordance with the order`, `3-overpayment`)","type":"string","enum":[0,1,2,3],"example":2},"paymentType":{"title":"integer.","description":"<a href='#tag\/Order\/operation\/get_rest_orders_payment_map'>Payment method ID<\/a>","type":"integer","minimum":1,"example":2},"originalCurrency":{"description":"Order currency","type":"string","maxLength":3,"minLength":3,"example":"PLN"},"originalAmountTotalWithoutTax":{"description":"Value of the order items without tax","type":"string","maximum":99999999.99,"minimum":0.01,"example":1024.37,"nullable":true},"originalAmountTotalWithTax":{"description":"Value of order items including tax","type":"string","maximum":99999999.99,"minimum":0.01,"example":1259.98,"nullable":true},"originalAmountTotalPaid":{"description":"Gross amount paid by customer in original currency","type":"string","maximum":99999999.99,"minimum":0,"example":1259.98,"nullable":true},"sendDateMin":{"description":"Minimal shipping date","type":"string","format":"date-time","example":"2022-03-07T00:00:00Z","nullable":true},"sendDateMax":{"description":"Maximum shipping date","type":"string","format":"date-time","example":"2022-03-08T20:00:00Z","nullable":true},"isEncrypted":{"description":"Is order customer data encrypted?","type":"boolean","example":false},"preferences":{"description":"Extra order fields","properties":{"idUser":{"type":"string","example":"user-12345"}},"type":"object","example":{"idUser":"user-12345"}},"createdAt":{"description":"Date when the order was created in Apilo","type":"string","format":"date-time","example":"2022-06-09T10:59:12Z","nullable":true},"updatedAt":{"description":"Date when the order was updated in Apilo","type":"string","format":"date-time","example":"2022-06-09T10:59:12Z","nullable":true},"orderItems":{"description":"Order items list","type":"array","items":{"$ref":"#\/components\/schemas\/RestOrderItemsDTO2"},"example":[{"id":1,"idExternal":"359","ean":"400638133393","sku":"P44\/3-T1.2","originalName":"Samsung Galaxy S20 Plus Black 128GB 5G","originalCode":"PHONE-S20-128GB-B","originalPriceWithTax":"2799.99","originalPriceWithoutTax":"2799.99","media":null,"quantity":2,"tax":"23.00","productSet":null,"status":1,"unit":"Szt.","type":1,"productId":12345},{"id":2,"idExternal":null,"ean":null,"sku":"ship-pp","originalName":"Wysy\u0142ka - Poczta Polska - Pocztex","originalCode":null,"originalPriceWithTax":"10.00","originalPriceWithoutTax":"10.00","media":null,"quantity":1,"tax":null,"productSet":null,"status":1,"unit":null,"type":2,"productId":null}]},"orderPayments":{"title":"Wp\u0142aty klienta.","description":"Order payments list","type":"array","items":{"$ref":"#\/components\/schemas\/RestOrderPaymentDTO2"},"example":[{"idExternal":"PAY-123456","amount":1259.98,"paymentDate":"2022-03-08T20:00:00Z","type":1,"comment":"Komentarz do wp\u0142aty"}]},"addressCustomer":{"$ref":"#\/components\/schemas\/RestOrderAddressDTO4"},"addressDelivery":{"$ref":"#\/components\/schemas\/RestOrderAddressDTO5"},"addressInvoice":{"$ref":"#\/components\/schemas\/RestOrderAddressDTO6"},"carrierAccount":{"description":"<a href='#tag\/Order\/operation\/get_rest_orders_carrier_account_map'>Carrier account ID<\/a>","type":"integer","minimum":1,"example":1},"orderNotes":{"title":"Array of objects.","description":"Order notes and comments","type":"array","items":{"$ref":"#\/components\/schemas\/RestOrderNoteDTO3"}},"orderedAt":{"title":"DateTime format.","description":"Date when the order was created by the customer","type":"string","format":"date-time","example":"2022-06-09T10:59:12+0100","nullable":true},"isCanceledByBuyer":{"description":"Canceled by buyer (Allegro)","type":"boolean","example":false},"id":{"title":"Provided by Apilo.","description":"Internal order ID","type":"string","maxLength":11,"minLength":10,"pattern":"^[A-Za-z0-9\\.|]{10,11}$","example":"AL231100017"},"status":{"description":"<a href='#tag\/Order\/operation\/get_rest_orders_shipment_status_map'>Status ID<\/a>","type":"integer","minimum":1,"example":3}},"type":"object"},"RestStatusOrderDTO":{"required":["status"],"properties":{"status":{"title":"Status zam\u00f3wienia.","description":"<a href='#tag\/Order\/operation\/get_rest_orders_shipment_status_map'>Status ID<\/a>","type":"integer","minimum":1,"example":3}},"type":"object"},"RestOrderPaymentDTO":{"required":["type","paymentDate","amount"],"properties":{"idExternal":{"description":"External payment ID","type":"string","maximum":64,"minimum":0,"example":"PAY-123456"},"type":{"description":"<a href='#tag\/Order\/operation\/get_rest_orders_payment_map'>Payment method ID<\/a>","type":"integer","minimum":1,"example":1},"paymentDate":{"description":"Date of payment","type":"string","format":"date-time","example":"2022-03-08T20:00:00Z","nullable":true},"amount":{"description":"Amount of payment","type":"string","maximum":9999999.99,"minimum":0.01,"example":1259.98,"nullable":true},"comment":{"type":"string","maxLength":128,"minLength":0,"example":"Credit card payment"}},"type":"object"},"RestOrderDocumentsIndexResponse":{"properties":{"documents":{"title":"Array of order documents.","description":"List of order documents","type":"array","items":{"$ref":"#\/components\/schemas\/RestOrderDocumentDTO3"}},"totalCount":{"description":"Number of matching results","type":"integer","minimum":0,"example":7398},"currentOffset":{"description":"Current list offset","type":"integer","minimum":0,"example":0},"pageResultCount":{"description":"Number of results per page","type":"integer","maximum":512,"minimum":0,"example":64}},"type":"object"},"RestOrderDocumentDTO":{"title":"Order document model","description":"This object represents a document belongs to an order with the specified ID","required":["idExternal","type"],"properties":{"idExternal":{"description":"External unique ID of the document - used for the update","type":"string","maxLength":36,"minLength":1,"example":"1","nullable":true},"number":{"description":"External document number","type":"string","maxLength":64,"minLength":1,"example":"FV\/1\/12\/2020","nullable":true},"priceWithTax":{"description":"The gross value","type":"string","maximum":99999999.99,"minimum":-99999999.99,"example":123,"nullable":true},"priceWithoutTax":{"description":"The net value","type":"string","maximum":99999999.99,"minimum":-99999999.99,"example":100,"nullable":true},"currency":{"title":"Currency type.","description":"Currency on the document","type":"string","maxLength":3,"minLength":3,"example":"PLN","nullable":true},"currencyValue":{"description":"Currency exchange rate","type":"string","maximum":9999.9999,"minimum":-9999.9999,"example":1,"nullable":true},"type":{"title":"Enum document type, default 16.","description":"Document type - <a href='#tag\/Order\/operation\/get_rest_documents_map'>order document types endpoint<\/a>","type":"integer","example":16,"nullable":true},"media":{"title":"ID obtained after sending Media.","description":"Null or media UUID - <a href='#tag\/Media\/operation\/post_rest_media_new'>media attachment endpoint<\/a>","type":"string","example":"2ed996a6-0b91-529c-9728-f2e59532e7bc"}},"type":"object"},"RestOrderDocumentDTO2":{"title":"Order document model","description":"This object represents a document belongs to an order with the specified ID","required":["idExternal","type"],"properties":{"id":{"description":"Internal ID of the shipment","type":"integer","minimum":0,"example":1,"nullable":true},"idExternal":{"description":"External unique ID of the document - used for the update","type":"string","maxLength":36,"minLength":1,"example":"1","nullable":true},"number":{"description":"External document number","type":"string","maxLength":64,"minLength":1,"example":"FV\/1\/12\/2020","nullable":true},"priceWithTax":{"description":"The gross value","type":"string","maximum":99999999.99,"minimum":-99999999.99,"example":123,"nullable":true},"priceWithoutTax":{"description":"The net value","type":"string","maximum":99999999.99,"minimum":-99999999.99,"example":100,"nullable":true},"currency":{"title":"Currency type.","description":"Currency on the document","type":"string","maxLength":3,"minLength":3,"example":"PLN","nullable":true},"currencyValue":{"description":"Currency exchange rate","type":"string","maximum":9999.9999,"minimum":-9999.9999,"example":1,"nullable":true},"type":{"title":"Enum document type, default 16.","description":"Document type - <a href='#tag\/Order\/operation\/get_rest_documents_map'>order document types endpoint<\/a>","type":"integer","example":16,"nullable":true},"media":{"title":"ID obtained after sending Media.","description":"Null or media UUID - <a href='#tag\/Media\/operation\/post_rest_media_new'>media attachment endpoint<\/a>","type":"string","example":"2ed996a6-0b91-529c-9728-f2e59532e7bc"},"createdAt":{"title":"DateTime format.","description":"Date the document was added to Apilo","type":"string","format":"date-time","example":"2023-11-24TT08:33:07+0100","nullable":true}},"type":"object"},"MappingDTO":{"title":"Mapping item","description":"This object represents a single item of mapping","properties":{"id":{"title":"Provided by Apilo.","description":"Internal element ID","type":"integer","maximum":65535,"minimum":1,"example":"3"},"key":{"title":"Provided by Apilo.","description":"Internal element key name","type":"string","maxLength":255,"minLength":1,"example":"CARRIER_253"},"name":{"title":"Provided by Apilo.","description":"Internal element name","type":"string","maxLength":255,"minLength":1,"example":"Inpost (Kurier, Paczkomaty, Allegro)"},"description":{"title":"Provided by Apilo.","description":"Internal element description","type":"string","maxLength":255,"example":"Kurier"}},"type":"object"},"RestOrderNoteDTO":{"title":"Order note","description":"This object represents a single note belongs to an order with the specified ID.","required":["comment"],"properties":{"type":{"title":"1 - Message from client, 2 - Internal note.","description":"Type of the note","type":"integer","default":1,"enum":[1,2],"example":2},"createdAt":{"description":"Time when created note","type":"string","format":"date-time","example":"2024-01-23T09:29:30+0100","nullable":true},"comment":{"description":"Note content","type":"string","maxLength":1024,"example":"I'll ask for delivery next week at the earliest"}},"type":"object"},"RestOrderNoteDTO2":{"title":"Order note","description":"This object represents a single note belongs to an order with the specified ID.","required":["comment"],"properties":{"type":{"title":"1 - Message from client, 2 - Internal note.","description":"Type of the note","type":"integer","default":1,"enum":[1,2],"example":2},"comment":{"description":"Note content","type":"string","maxLength":1024,"example":"I'll ask for delivery next week at the earliest"}},"type":"object"},"RestOrderShipmentDTO":{"title":"Order shipment model","description":"This object represents a shipment belongs to an order with the specified ID","properties":{"id":{"description":"Internal ID of the shipment","type":"integer","minimum":1,"example":1},"idExternal":{"description":"External unique ID of the shipment","type":"string","maxLength":36,"minLength":0,"example":"312","nullable":true}},"type":"object"},"RestOrderShipmentDTO2":{"title":"Order shipment model","description":"This object represents a shipment belongs to an order with the specified ID","required":["tracking","carrierProviderId"],"properties":{"idExternal":{"description":"External unique ID of the shipment","type":"string","maxLength":36,"minLength":0,"example":"312","nullable":true},"tracking":{"description":"Shipment tracking number","type":"string","maxLength":64,"minLength":1,"example":"005842792564T"},"carrierProviderId":{"description":"ID of <a href='#tag\/Order\/operation\/get_rest_orders_carrier_map'>Carrier ID<\/a>. If you specify a value equal to 'manual carrier', there might be problems in passing the tracking number to the external integration.","type":"integer","example":1},"postDate":{"title":"DateTime format.","description":"Date of shipment","type":"string","format":"date-time","example":"2022-06-09T10:59:12+0100","nullable":true},"media":{"description":"Null or media UUID - <a href='#tag\/Media\/operation\/post_rest_media_new'>media attachment endpoint<\/a>","type":"string","example":"2ed996a6-0b91-529c-9728-f2e59532e7bc"}},"type":"object"},"RestOrderShipmentDTO3":{"title":"Order shipment model","description":"This object represents a shipment belongs to an order with the specified ID","required":["tracking","carrierProviderId"],"properties":{"id":{"description":"Internal ID of the shipment","type":"integer","minimum":1,"example":1},"idExternal":{"description":"External unique ID of the shipment","type":"string","maxLength":36,"minLength":0,"example":"312","nullable":true},"tracking":{"description":"Shipment tracking number","type":"string","maxLength":64,"minLength":1,"example":"005842792564T"},"carrierProviderId":{"description":"ID of <a href='#tag\/Order\/operation\/get_rest_orders_carrier_map'>Carrier ID<\/a>. If you specify a value equal to 'manual carrier', there might be problems in passing the tracking number to the external integration.","type":"integer","example":1},"postDate":{"title":"DateTime format.","description":"Date of shipment","type":"string","format":"date-time","example":"2022-06-09T10:59:12+0100","nullable":true},"media":{"description":"Null or media UUID - <a href='#tag\/Media\/operation\/post_rest_media_new'>media attachment endpoint<\/a>","type":"string","example":"2ed996a6-0b91-529c-9728-f2e59532e7bc"},"status":{"description":"Shipment tracking status if is present or NULL","type":"string","example":2}},"type":"object"},"RestTagsDTO":{"properties":{"list":{"description":"Rest Order Tag items list","type":"array","items":{"$ref":"#\/components\/schemas\/RestTagDTO"}},"pageResultCount":{"description":"Total count per page","type":"integer","example":"1"},"totalCount":{"description":"Count for all order tags ","type":"integer","example":"512"},"currentOffset":{"description":"Offset","type":"integer","example":"0"}},"type":"object"},"OrderTagPost":{"required":["tag"],"properties":{"tag":{"description":"Tag ID","type":"integer","example":1}},"type":"object"},"RestShipmentDetailsDTO":{"title":"Shipment","description":"This object represents a single shipment.","properties":{"statusDate":{"title":"DateTime format.","description":"Status change date","type":"string","format":"date-time","example":"2023-11-24T08:33:07+0100","nullable":true},"statusDescription":{"description":"Status description","type":"string","example":"readyToSend","nullable":true},"statusCheckTimestamp":{"title":"DateTime format.","description":"Status check date","type":"string","format":"date-time","example":"2023-11-24T08:33:07+0100","nullable":true},"receivedDate":{"title":"DateTime format.","description":"Received date","type":"string","format":"date-time","example":"2023-11-24T08:33:07+0100","nullable":true},"receivedDays":{"description":"Number of business days in which the parcel was received","type":"integer","example":2},"id":{"description":"Internal shipment ID","type":"integer","minimum":1,"example":"123"},"carrierAccountId":{"description":"Carrier account ID","type":"integer","minimum":1,"example":"123"},"carrierBrokerId":{"description":"Carrier broker ID","type":"integer","minimum":1,"example":"123"},"externalId":{"description":"External unique ID of the shipment","type":"string","maxLength":36,"minLength":0,"example":"312","nullable":true},"orderId":{"description":"Internal order ID","type":"string","minimum":1,"example":"123"},"createdAt":{"description":"Date the document was created in Apilo","type":"string","format":"date-time","example":"2023-11-24T08:33:07+0100","nullable":true},"postDate":{"description":"Date of shipment","type":"string","format":"date-time","example":"2022-06-09T10:59:12+0100","nullable":true},"status":{"description":"Shipment tracking status if is present or NULL","type":"string","example":2},"method":{"description":"External unique ID of the shipment method","type":"string","example":"312","nullable":true},"media":{"description":"Null or media UUID - <a href='#tag\/media\/operation\/get_rest_media_get'>media attachment endpoint<\/a>","type":"string","example":"2ed996a6-0b91-529c-9728-f2e59532e7bc"}},"type":"object"},"RestShipmentInfoIndexResponse":{"properties":{"shipments":{"title":"Array of shipments.","description":"List of shipments","type":"array","items":{"$ref":"#\/components\/schemas\/RestShipmentInfoDTO"}},"totalCount":{"description":"Number of matching results","type":"integer","minimum":0,"example":7398},"currentOffset":{"description":"Current list offset","type":"integer","minimum":0,"example":0},"pageResultCount":{"description":"Number of results per page","type":"integer","maximum":512,"minimum":0,"example":64}},"type":"object"},"RestShipmentTrackingResponse":{"properties":{"shipments":{"title":"Array of documents.","description":"List of shipments tracking","type":"array","items":{"$ref":"#\/components\/schemas\/RestShipmentTrackingDTO"}},"totalCount":{"description":"Number of matching results","type":"integer","minimum":0,"example":7398},"currentOffset":{"description":"Current list offset","type":"integer","minimum":0,"example":0},"pageResultCount":{"description":"Number of results per page","type":"integer","maximum":512,"minimum":0,"example":64}},"type":"object"},"CarrierAccountMappingListingDTO":{"title":"Carrier account information","description":"This object represents a lisitng item of carrier account information","properties":{"carrierAccounts":{"description":"Listing of CarrierAccountMappingDTO","type":"array","items":{"$ref":"#\/components\/schemas\/CarrierAccountMappingDTO"}}},"type":"object"},"RestCarrierMethodListingDTO":{"properties":{"methods":{"title":"ID of Carrier Sending Method.","description":"Listing of RestCarrierMethodDTO","type":"array","items":{"$ref":"#\/components\/schemas\/RestCarrierMethodDTO"}}},"type":"object"},"RestShipmentOptionsAndParcelsDTO":{"title":"Shipment","description":"This object represents options describing shipment and way of dividing into several parcels.","properties":{"options":{"$ref":"#\/components\/schemas\/RestShipmentOptionsDefinitionDTO"},"parcels":{"$ref":"#\/components\/schemas\/RestShipmentOptionsDefinitionDTO"},"maxParcelsCount":{"description":"Number of parcels into which the shipment can be divided.","type":"integer","example":"1"}},"type":"object"},"NewShipmentDTO":{"properties":{"carrierAccountId":{"description":"Carrier account ID","type":"integer","example":"1","nullable":true},"addressReceiver":{"$ref":"#\/components\/schemas\/AddressReceiverDTO"},"orderId":{"description":"Order ID","type":"string","example":"MA123456789","nullable":true},"postDate":{"description":"Post date","type":"string","format":"date-time","example":"2024-07-14T13:41:18+00:00","nullable":true},"method":{"description":"Shipment methods can be downloaded from <a href='#tag\/Shipment\/operation\/get_rest_shipment_carrier_sending_methods'>Get Carrier sending methods<\/a>.","type":"string","example":"inpost_courier_standard","nullable":true},"options":{"description":"Options can be downloaded from <a href='#tag\/Shipment\/operation\/get_rest_shipment_options'>Get list of shipment option need to create new shipment<\/a>.","type":"array","items":{"$ref":"#\/components\/schemas\/RestShipmentOptionDTO"}},"parcels":{"description":"Options can be downloaded from <a href='#tag\/Shipment\/operation\/get_rest_shipment_options'>Get list of shipment option need to create new shipment<\/a>.","type":"array","items":{"$ref":"#\/components\/schemas\/RestShipmentParcelDTO"}}},"type":"object"},"NewShipmentsCreatedResponse":{"properties":{"shipments":{"title":"Array of shipments IDs.","description":"List of newly created shipments Ids","type":"array","items":{"$ref":"#\/components\/schemas\/NewShipmentCreatedDTO"}}},"type":"object"},"RestShipmentCarrierDocumentsListingResponse":{"properties":{"documents":{"title":"Array of documents.","description":"List of shipment carrier documents","type":"array","items":{"$ref":"#\/components\/schemas\/RestShipmentCarrierDocumentDTO"}},"totalCount":{"description":"Number of matching results","type":"integer","minimum":0,"example":7398},"currentOffset":{"description":"Current list offset","type":"integer","minimum":0,"example":0},"pageResultCount":{"description":"Number of results per page","type":"integer","maximum":512,"minimum":0,"example":64}},"type":"object"},"RestShippingConfirmationsDTO":{"title":"Shipping confirmations","description":"This object represents an list of shipping confirmations.","required":["shippingConfirmations"],"properties":{"shippingConfirmations":{"title":"List of shipping confirmations.","description":"List of shipping confirmations","maxProperties":128,"minProperties":1,"type":"array","items":{"$ref":"#\/components\/schemas\/RestShippingConfirmationDTO"}}},"type":"object"},"RestShippingConfirmationsListingResponseDTO":{"title":"Shipping confirmations","description":"This object represents an list of shipping confirmations.","properties":{"shippingConfirmations":{"title":"List of shipping confirmations.","description":"List of shipping confirmations","type":"array","items":{"$ref":"#\/components\/schemas\/RestShippingConfirmationsListingItemDTO"}}},"type":"object"},"RestShipmentsDTO":{"title":"Shipment","description":"This object represents an list of shipment IDs.","required":["shipments"],"properties":{"shipments":{"title":"List of shipment IDs.","description":"List of shipment IDs","type":"array","items":{"$ref":"#\/components\/schemas\/RestShipmentIdDTO"},"example":{"shipment":[{"id":1},{"id":2}]}}},"type":"object"},"RestShipmentPickupDateProposalsListingDTO":{"title":"Shipment","description":"This object represents a listing shipment pickup date proposals.","properties":{"pickups":{"description":"Listing of RestShipmentPickupDateProposalsDTO","type":"array","items":{"$ref":"#\/components\/schemas\/RestShipmentPickupDateProposalsDTO"}}},"type":"object"},"RestAttributesIndexResponse":{"required":["attributes"],"properties":{"attributes":{"title":"Lista Atrybut\u00f3w.","description":"Attribute items list","type":"array","items":{"$ref":"#\/components\/schemas\/RestAttributeDTO"},"example":[{"id":30,"type":1,"name":"Manufacturer code","attributeFeatures":null},{"id":31,"type":17,"name":"Color","attributeFeatures":[{"id":12,"value":"Red"},{"id":13,"value":"Blue"},{"value":"Black"}]},{"id":32,"type":16,"name":"Materials","attributeFeatures":[{"id":15,"value":"Plastic"},{"id":16,"value":"Metal"}]}]},"totalCount":{"description":"Number of matching results","type":"integer","minimum":0,"example":7398},"currentOffset":{"description":"Current list offset","type":"integer","minimum":0,"example":0},"pageResultCount":{"description":"Number of results per page","type":"integer","maximum":512,"minimum":0,"example":64}},"type":"object"},"RestAttributesDTO":{"required":["attributes"],"properties":{"attributes":{"title":"List of Attributes.","description":"Attribute items list","type":"array","items":{"$ref":"#\/components\/schemas\/RestAttributeDTO2"},"example":[{"id":123,"type":1,"name":"test1","values":[{"id":1,"value":"test"}]},{"id":123,"type":16,"name":"test1","values":[{"id":10,"value":"test"},{"id":11,"value":"test"}]}]}},"type":"object"},"RestAttributesDTO2":{"required":["attributes"],"properties":{"attributes":{"title":"List of Attributes.","description":"Attribute items list","type":"array","items":{"$ref":"#\/components\/schemas\/RestAttributeDTO3"},"example":[{"id":123,"type":1,"name":"test1","values":[{"id":1,"value":"test"}]},{"id":123,"type":16,"name":"test1","values":[{"id":10,"value":"test"},{"id":11,"value":"test"}]}]}},"type":"object"},"RestProductAttributeIndexResponse":{"required":["attributes"],"properties":{"attributes":{"title":"Lista Atrybut\u00f3w.","description":"Product attribute items list","type":"array","items":{"$ref":"#\/components\/schemas\/RestProductAttributeDTO"},"example":[{"id":30,"type":1,"name":"Manufacturer code","attributeFeatures":null},{"id":31,"type":16,"name":"Color","values":[{"id":12},{"id":13}]},{"id":32,"type":9,"name":"Materials","values":[{"id":15,"value":"Plastic"},{"id":16,"value":"Metal"}]},{"id":33,"type":1,"name":"Material","values":[{"id":17,"value":"Plastic"}]},{"id":34,"type":2,"name":"IsMaterial","values":[{"id":18,"value":false}]}]},"totalCount":{"description":"Number of matching results","type":"integer","minimum":0,"example":7398},"currentOffset":{"description":"Current list offset","type":"integer","minimum":0,"example":0},"pageResultCount":{"description":"Number of results per page","type":"integer","maximum":512,"minimum":0,"example":64}},"type":"object"},"RestProductAttributesDTO":{"title":"Product Attributes","description":"This object represents list of a atributes.","required":["attributes"],"properties":{"attributes":{"description":"Product Attribute items list","type":"array","items":{"$ref":"#\/components\/schemas\/RestProductAttributeDTO2"}}},"type":"object"},"RestProductAttributesDTO2":{"title":"Product Attributes","description":"This object represents list of a atributes.","required":["attributes"],"properties":{"attributes":{"description":"Product Attribute items list","type":"array","items":{"$ref":"#\/components\/schemas\/RestProductAttributeDTO3"}}},"type":"object"},"RestProductAttributeIndexResponse2":{"required":["attributes"],"properties":{"attributes":{"title":"Lista Atrybut\u00f3w.","description":"Product attribute items list","type":"array","items":{"$ref":"#\/components\/schemas\/RestProductAttributeDTO3"},"example":[{"id":30,"type":1,"name":"Manufacturer code","attributeFeatures":null},{"id":31,"type":16,"name":"Color","values":[{"id":12},{"id":13}]},{"id":32,"type":9,"name":"Materials","values":[{"id":15,"value":"Plastic"},{"id":16,"value":"Metal"}]},{"id":33,"type":1,"name":"Material","values":[{"id":17,"value":"Plastic"}]},{"id":34,"type":2,"name":"IsMaterial","values":[{"id":18,"value":false}]}]}},"type":"object"},"RestProductAttributeAttachmentItemDTO":{"properties":{"id":{"description":"Internal Attachment id","type":"integer"},"isMain":{"description":"Main attachment","type":"boolean"},"productId":{"description":"Internal product id","type":"integer"},"uuid":{"description":"UUID of media","type":"string"},"extension":{"description":"Extension of media","type":"string"},"link":{"description":"Link to Media","type":"string"}},"type":"object"},"RestCategoryDTO":{"properties":{"id":{"description":"Internal Id","type":"integer","minimum":1,"example":"1"},"name":{"description":"Category name","type":"string","minimum":1,"maxLength":128,"example":"Category name"},"parentIds":{"title":"Identyfikatory rodzic\u00f3w (ca\u0142e drzewko)","description":"Parent ids array","type":"array","items":{"type":"integer"},"example":[1,2]}},"type":"object"},"CategoryCreateModel":{"required":["name"],"properties":{"name":{"title":"Category name.","type":"string","example":"Kategoria 1"},"parentId":{"title":"Category parent Apilo ID or null.","type":"integer","example":38,"nullable":true},"sort":{"title":"Category sort parameter or null.","type":"integer","example":2,"nullable":true}},"type":"object"},"CreateCategoriesResponse":{"properties":{"categories":{"title":"Created category internal ID - the order of the IDS matches the array from request.","type":"array","items":{"type":"integer"},"example":[38,39,40]}},"type":"object"},"GetProductsResponse":{"properties":{"products":{"type":"array","items":{"$ref":"#\/components\/schemas\/ProductModel"}},"totalCount":{"type":"integer"}},"type":"object"},"ProductPut":{"required":["id","sku","tax","status","quantity","priceWithTax"],"properties":{"id":{"title":"Product ID in Apilo system.","type":"integer","example":341},"sku":{"title":"SKU\/Unique product ID.","type":"string","example":"IT-005\/C"},"name":{"title":"Product name.","type":"string","example":"Samsung Galaxy S20 G980F Dual SIM Blue"},"tax":{"type":"string","example":"23"},"status":{"type":"integer","enum":[0,1],"example":1},"originalCode":{"title":"Unique external ID, e.g. ID from external database.","type":"string","example":"46"},"groupName":{"title":"Product group name - fill this field when you want to set both product group name and product name.","type":"string","example":null},"attributes":{"description":"Array of attribute ID","type":"array","items":{"type":"string"},"example":{"5":"Samsung","4":5}},"images":{"title":"UUID.","description":"Array of UUID uploaded media via Attachment endpoint or associative array of image URL - key attribute is reference","type":"array","items":{"type":"string","format":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"example":{"0":"2ed996a6-0b91-529c-9728-f2e59532e7bc","1":"1a1233cf-b69d-7f27-211e-36aff9ec373a","ref2":"https:\/\/example.com\/images\/example.jpg"}},"categories":{"description":"Array of category ID","type":"array","items":{"type":"integer","minimum":1},"example":[33,44,55]},"ean":{"title":"European Article Number.","type":"string","example":"0400638133393"},"quantity":{"title":"\nProduct inventory","type":"integer","example":350},"priceWithTax":{"title":"\nProduct price including VAT","type":"string","example":100},"weight":{"title":"\nProduct weight","type":"number","format":"float","example":0.45},"unit":{"title":"\nUnit of measure","type":"string","example":"KG"},"description":{"description":"Long product description","type":"string","example":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum dignissim, eros quis consectetur tincidunt, diam leo convallis ligula."},"shortDescription":{"description":"Short product description, max 256 characters","type":"string","example":""}},"type":"object"},"Products":{"required":["sku","tax","status","quantity","priceWithTax"],"properties":{"sku":{"title":"SKU\/Unique product ID.","type":"string","example":"IT-005\/C"},"name":{"title":"Product name.","type":"string","example":"Samsung Galaxy S20 G980F Dual SIM Blue"},"tax":{"type":"string","example":"23"},"status":{"type":"integer","enum":[0,1],"example":1},"originalCode":{"title":"Unique external ID, e.g. ID from external database.","type":"string","example":"46"},"groupName":{"title":"Product group name - fill this field when you want to set both product group name and product name.","type":"string","example":null},"attributes":{"description":"Array of attribute ID","type":"array","items":{"type":"string"},"example":{"5":"Samsung","4":5}},"images":{"title":"UUID.","description":"Array of UUID uploaded media via Attachment endpoint or associative array of image URL - key attribute is reference","type":"array","items":{"type":"string","format":"^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$"},"example":{"0":"2ed996a6-0b91-529c-9728-f2e59532e7bc","1":"1a1233cf-b69d-7f27-211e-36aff9ec373a","ref2":"https:\/\/example.com\/images\/example.jpg"}},"categories":{"description":"Array of category ID","type":"array","items":{"type":"integer","minimum":1},"example":[33,44,55]},"ean":{"title":"European Article Number.","type":"string","example":"0400638133393"},"quantity":{"title":"\nProduct inventory","type":"integer","example":350},"priceWithTax":{"title":"\nProduct price including VAT","type":"string","example":100},"weight":{"title":"\nProduct weight","type":"number","format":"float","example":0.45},"unit":{"title":"\nUnit of measure","type":"string","example":"KG"},"description":{"description":"Long product description","type":"string","example":"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vestibulum dignissim, eros quis consectetur tincidunt, diam leo convallis ligula."},"shortDescription":{"description":"Short product description, max 256 characters","type":"string","example":""}},"type":"object"},"ProductsCreateResponse":{"properties":{"products":{"title":"Product ID list mapped to input SKU code.","type":"array","items":{"type":"integer","format":"\\s"},"example":{"SKU-1":123,"SKU-2":124,"SKU-3":125,"SKU-4":126}}},"type":"object"},"ProductsNotCreateResponse":{"properties":{"products":{"title":"Empty array.","type":"array","items":{"type":"integer"},"example":[]}},"type":"object"},"ProductBaseModel":{"properties":{"id":{"description":"Internal product ID in Apilo","type":"integer","example":1234},"originalCode":{"description":"External product identifier (unambiguous against API\/channel)","type":"string","example":"p12345","nullable":true},"quantity":{"description":"Product stock","type":"integer","example":15},"priceWithTax":{"description":"Gross price","type":"string","example":123},"tax":{"description":"VAT rate (e.g. 23.00, -1.00 - tax exempt).","type":"string","example":"23.00"},"status":{"title":"status produktu","description":"Product status (`0-inactive`, `1-active`, `8-archive`)","type":"integer","enum":[0,1,8],"example":1,"nullable":true},"sku":{"description":"Product SKU","type":"string","example":"HG-331\/P","nullable":true}},"type":"object"},"ProductDetailModel":{"properties":{"name":{"description":"Product name","type":"string","example":"BLACK 128GB","nullable":true},"groupName":{"description":"Product group name","type":"string","example":"Samsung Galxy S20 Plus"},"productGroupId":{"type":"integer","example":123456},"categories":{"description":"Product category ids","type":"array","items":{"type":"integer"},"example":[12,44,149]},"unit":{"type":"string","nullable":true},"weight":{"description":"Product weight [kg]","type":"string","example":1.12,"nullable":true},"priceWithoutTax":{"description":"Net price","type":"string","example":100},"sku":{"description":"Product SKU","type":"string","example":"HG-331\/P","nullable":true},"ean":{"title":"EAN-14","description":"EAN-14","type":"string","example":"4006381333931","nullable":true},"id":{"description":"Internal product ID in Apilo","type":"integer","example":1234},"originalCode":{"description":"External product identifier (unambiguous against API\/channel)","type":"string","example":"p12345","nullable":true},"quantity":{"description":"Product stock","type":"integer","example":15},"priceWithTax":{"description":"Gross price","type":"string","example":123},"tax":{"description":"VAT rate (e.g. 23.00, -1.00 - tax exempt).","type":"string","example":"23.00"},"status":{"title":"status produktu","description":"Product status (`0-inactive`, `1-active`, `8-archive`)","type":"integer","enum":[0,1,8],"example":1,"nullable":true}},"type":"object"},"Prices":{"properties":{"list":{"type":"array","items":{"$ref":"#\/components\/schemas\/PriceModel"}},"totalCount":{"type":"integer"}},"type":"object"},"PriceCalculatedPost":{"required":["product","price","customPriceModify","customMode"],"properties":{"product":{"description":"Unique product ID","type":"integer","example":11},"price":{"description":"Unique price list ID","type":"integer","example":12},"customPriceModify":{"description":"Custom price modify","example":11.12,"oneOf":[{"type":"number","format":"float"},{"type":"integer"},{"type":"string"}]},"customMode":{"description":"\n    3 - fixed - use to set direct price\n    5 - overhead - use to add\/sub percentage to base price\n    6 - margin - use to set percent margin to base price (max 99.99)\n    7 - static - use to add\/sub static value to base price\n     ","type":"integer","enum":[3,5,6,7],"example":3}},"type":"object"},"IdModel":{"properties":{"id":{"type":"integer"}},"type":"object"},"RestProductNotFoundException":{"properties":{"message":{"type":"string","nullable":true},"code":{"type":"integer"},"description":{"type":"string"},"errors":{"type":"array","items":{"$ref":"#\/components\/schemas\/RestBundleException"}},"field":{"type":"string"}},"type":"object"},"RestPriceDTO":{"properties":{"id":{"description":"Internal ID","type":"integer","maximum":4294967295,"minimum":1,"example":1},"name":{"description":"Price name","type":"string","example":"Cennik","nullable":true}},"type":"object"},"RestDocumentConfigDTO":{"title":"Accounting document numbering series model","description":"Accounting document numbering series represent the pattern according to which the subsequent accounting document numbers will be generated.","properties":{"id":{"description":"Internal ID of the numbering series","type":"integer","minimum":0,"example":2,"nullable":true},"type":{"title":"1-Invoice, 5-Receipt, 10-Proforma, 31-Corrective invoice.","description":"Type of accounting document","type":"integer","enum":[1,5,10,31],"example":31,"nullable":true},"name":{"description":"Name of Accounting document numbering series","type":"string","example":"Faktura koryguj\u0105ca (domy\u015blnie)","nullable":true},"status":{"title":"0 - disabled, 1 - enabled.","description":"Accounting document numbering status","type":"integer","enum":[1,0],"example":1,"nullable":true}},"type":"object"},"RestDocumentDTO":{"title":"Fiscal document","description":"","required":["invoicedAt","paymentType"],"properties":{"id":{"description":"Internal ID of the fiscal document","type":"integer","minimum":0,"example":3148,"nullable":true},"documentNumber":{"description":"Fiscal document number","type":"string","example":"INV\/3\/12\/2023","nullable":true},"originalAmountTotalWithTax":{"description":"Gross amount on the document","type":"string","maximum":9999999.99,"minimum":-9999999.99,"example":"123.00","nullable":true},"originalAmountTotalWithoutTax":{"description":"Nett amount on the document","type":"string","maximum":9999999.99,"minimum":-9999999.99,"example":"100.00","nullable":true},"originalCurrencyExchangeValue":{"description":"Exchange rate","type":"string","maximum":9999999.99,"minimum":-9999999.99,"example":"1.0000","nullable":true},"originalCurrency":{"title":"Currency type.","description":"Currency in which the order was made","type":"string","maxLength":3,"minLength":3,"example":"PLN","nullable":true},"currency":{"title":"Currency type.","description":"Currency on the document","type":"string","maxLength":3,"minLength":3,"example":"PLN","nullable":true},"createdAt":{"title":"DateTime format.","description":"Date the document was created in Apilo","type":"string","format":"date-time","example":"2023-11-24T08:33:07+0100","nullable":true},"invoicedAt":{"title":"DateTime format.","description":"Date of issuance of the document","type":"string","format":"date-time","example":"2023-11-20","nullable":true},"soldAt":{"title":"DateTime format.","description":"Date of sale on the document","type":"string","format":"date-time","example":"2023-11-20","nullable":true},"type":{"title":"Enum document type.","description":"Document type (1 - Invoice, 2 - Margin invoice, 5 - Receipt, 10 - Proforma invoice)","type":"string","enum":[1,10,5,2],"example":5},"documentReceiver":{"$ref":"#\/components\/schemas\/RestDocumentPersonalInfoDTO"},"documentIssuer":{"$ref":"#\/components\/schemas\/RestDocumentPersonalInfoDTO"},"documentItems":{"description":"Docment items","type":"array","items":{"$ref":"#\/components\/schemas\/RestDocumentItemDTO"}},"paymentType":{"description":"<a href='#tag\/Order\/operation\/get_rest_orders_payment_map'>Payment method ID<\/a>","type":"integer","minimum":0,"example":3,"nullable":true}},"type":"object"},"DocumentDocumentCreatePreferencesDTO":{"properties":{"message":{"description":"Message for created document","type":"string","example":"An error occurred while trying to print the receipt","nullable":true}},"type":"object"},"DocumentDocumentCreatePreferencesDTO2":{"properties":{"message":{"description":"Message for created document","type":"string","example":"An error occurred while trying to print the receipt","nullable":true}},"type":"object"},"WhoamiDTO":{"properties":{"clientId":{"description":"Client Id","type":"integer","example":1},"name":{"type":"string","example":"Api Key Name"},"validTo":{"type":"DateTime","example":"2024-07-10T10:04:31+0200"}},"type":"object"},"RestOrderReadDTO2":{"title":"Order","description":"This object represents a single order.","required":["paymentStatus","platformId","paymentType","originalCurrency","orderItems","addressCustomer","status"],"properties":{"platformAccountId":{"description":"<a href='#tag\/Order\/operation\/get_rest_orders_platform_map'>Sale platform account ID<\/a>","type":"integer","minimum":1,"example":1},"platformId":{"description":"Sale platform ID","type":"integer","minimum":1,"example":1},"idExternal":{"title":"Provided by external systems.","description":"External order ID, e.g. on the sales platform","type":"string","maxLength":36,"example":"WWW\/341\/2023","nullable":true},"isInvoice":{"description":"Does the customer want a VAT invoice?","type":"boolean","example":true},"paymentStatus":{"description":"Payment status (`0-no payment`, `1-partially paid`, `2-paid in full\/amount in accordance with the order`, `3-overpayment`)","type":"string","enum":[0,1,2,3],"example":2},"paymentType":{"title":"integer.","description":"<a href='#tag\/Order\/operation\/get_rest_orders_payment_map'>Payment method ID<\/a>","type":"integer","minimum":1,"example":2},"originalCurrency":{"description":"Order currency","type":"string","maxLength":3,"minLength":3,"example":"PLN"},"isEncrypted":{"description":"Is order customer data encrypted?","type":"boolean","example":false},"createdAt":{"description":"Date when the order was created in Apilo","type":"string","format":"date-time","example":"2022-06-09T10:59:12Z","nullable":true},"updatedAt":{"description":"Date when the order was updated in Apilo","type":"string","format":"date-time","example":"2022-06-09T10:59:12Z","nullable":true},"orderItems":{"description":"Order items list","type":"array","items":{"$ref":"#\/components\/schemas\/RestOrderItemsDTO3"},"example":[{"id":1,"idExternal":"359","ean":"400638133393","sku":"P44\/3-T1.2","originalName":"Samsung Galaxy S20 Plus Black 128GB 5G","originalCode":"PHONE-S20-128GB-B","originalPriceWithTax":"2799.99","originalPriceWithoutTax":"2799.99","media":null,"quantity":2,"tax":"23.00","productSet":null,"status":1,"unit":"Szt.","type":1,"productId":12345},{"id":2,"idExternal":null,"ean":null,"sku":"ship-pp","originalName":"Wysy\u0142ka - Poczta Polska - Pocztex","originalCode":null,"originalPriceWithTax":"10.00","originalPriceWithoutTax":"10.00","media":null,"quantity":1,"tax":null,"productSet":null,"status":1,"unit":null,"type":2,"productId":null}]},"addressCustomer":{"$ref":"#\/components\/schemas\/RestOrderAddressDTO7"},"isCanceledByBuyer":{"description":"Canceled by buyer (Allegro)","type":"boolean","example":false},"id":{"title":"Provided by Apilo.","description":"Internal order ID","type":"string","maxLength":11,"minLength":10,"pattern":"^[A-Za-z0-9\\.|]{10,11}$","example":"AL231100017"},"status":{"description":"<a href='#tag\/Order\/operation\/get_rest_orders_shipment_status_map'>Status ID<\/a>","type":"integer","minimum":1,"example":3}},"type":"object"},"RestOrderItemsDTO":{"required":["originalName","originalPriceWithTax","quantity","type"],"properties":{"id":{"description":"Product ID in create\/update process, Unique Order Item ID in reading process","type":"integer","maximum":4294967295,"minimum":1,"example":1},"idExternal":{"description":"External product item ID","type":"string","maxLength":36,"minLength":0,"example":"359"},"ean":{"description":"EAN","type":"string","maxLength":14,"minLength":0,"pattern":"^[0-9]{1,14}$","example":"400638133393"},"sku":{"description":"SKU","type":"string","maxLength":96,"minLength":1,"example":"P44\/3-T1.2"},"originalName":{"title":"Original name.","description":"Product name","type":"string","maxLength":255,"minLength":0,"example":"Samsung Galaxy S20 Plus Black 128GB 5G"},"originalCode":{"description":"Product unique code","type":"string","maxLength":96,"minLength":0,"example":"PHONE-S20-128GB-B"},"originalPriceWithTax":{"description":"Gross product price","type":"string","maximum":9999999.99,"minimum":0.01,"example":"2460.00"},"originalPriceWithoutTax":{"description":"Net product price","type":"string","maximum":9999999.99,"minimum":0.01,"example":"2000.00"},"quantity":{"description":"Quantity of products","type":"integer","maximum":65535,"minimum":1,"example":2},"tax":{"title":"TaxEnum.","description":"The amount of VAT (VAT value | `''` if TAX is not specified and will be calculated | `'-1'` when exempt from VAT)","type":"string","enum":["27.00","25.00","24.00","23.00","22.00","21.00","20.00","19.00","18.00","17.00","16.00","8.00","7.00","5.00","0.00","-1.00",""],"example":"23.00"},"unit":{"description":"Product unit","type":"string","maximum":16,"minimum":0,"example":"Szt."},"type":{"description":"Order item type (`1-Product`, `2-Shipment`, `3-service`)","type":"string","enum":[1,2,3]}},"type":"object"},"RestOrderAddressDTO":{"required":["name"],"properties":{"name":{"description":"Client name","type":"string","maxLength":128,"minLength":1,"example":"Jan Kowalski"},"phone":{"description":"Client phone","type":"string","maxLength":64,"minLength":0,"example":"+48 500 000 000"},"email":{"description":"Client E-mail","type":"string","maxLength":128,"minLength":0,"example":"jan.kowalski@apilo.com"},"streetName":{"description":"Client street name","type":"string","maxLength":128,"minLength":0,"example":"Testowa"},"streetNumber":{"description":"Client street number","type":"string","maxLength":32,"minLength":0,"example":"4b\/12"},"city":{"description":"Client city","type":"string","maxLength":128,"minLength":0,"example":"Krak\u00f3w"},"zipCode":{"description":"Client zip code","type":"string","maxLength":10,"minLength":0,"example":"31-154"},"country":{"title":"Country code.","description":"Client country","type":"string","maxLength":2,"minLength":2,"example":"PL"},"parcelIdExternal":{"description":"Pickup point ID","type":"string","maxLength":64,"minLength":0,"example":"KRA32B"},"parcelName":{"description":"Pickup point name","type":"string","maxLength":128,"minLength":0,"example":"Paczkomat, ul. Testowa 12 (obok sklepu)"},"companyTaxNumber":{"description":"Company tax ID","type":"string","maxLength":64,"minLength":0,"example":"937-271-51-54"},"companyName":{"description":"Company name","type":"string","maxLength":128,"minLength":0,"example":"Apilo Sp. z o.o."}},"type":"object"},"RestOrderAddressDTO2":{"required":["name"],"properties":{"name":{"description":"Client name","type":"string","maxLength":128,"minLength":1,"example":"Jan Kowalski"},"phone":{"description":"Client phone","type":"string","maxLength":64,"minLength":0,"example":"+48 500 000 000"},"email":{"description":"Client E-mail","type":"string","maxLength":128,"minLength":0,"example":"jan.kowalski@apilo.com"},"streetName":{"description":"Client street name","type":"string","maxLength":128,"minLength":0,"example":"Testowa"},"streetNumber":{"description":"Client street number","type":"string","maxLength":32,"minLength":0,"example":"4b\/12"},"city":{"description":"Client city","type":"string","maxLength":128,"minLength":0,"example":"Krak\u00f3w"},"zipCode":{"description":"Client zip code","type":"string","maxLength":10,"minLength":0,"example":"31-154"},"country":{"title":"Country code.","description":"Client country","type":"string","maxLength":2,"minLength":2,"example":"PL"},"parcelIdExternal":{"description":"Pickup point ID","type":"string","maxLength":64,"minLength":0,"example":"KRA32B"},"parcelName":{"description":"Pickup point name","type":"string","maxLength":128,"minLength":0,"example":"Paczkomat, ul. Testowa 12 (obok sklepu)"},"companyTaxNumber":{"description":"Company tax ID","type":"string","maxLength":64,"minLength":0,"example":"937-271-51-54"},"companyName":{"description":"Company name","type":"string","maxLength":128,"minLength":0,"example":"Apilo Sp. z o.o."}},"type":"object"},"RestOrderAddressDTO3":{"required":["name"],"properties":{"name":{"description":"Client name","type":"string","maxLength":128,"minLength":1,"example":"Jan Kowalski"},"phone":{"description":"Client phone","type":"string","maxLength":64,"minLength":0,"example":"+48 500 000 000"},"email":{"description":"Client E-mail","type":"string","maxLength":128,"minLength":0,"example":"jan.kowalski@apilo.com"},"streetName":{"description":"Client street name","type":"string","maxLength":128,"minLength":0,"example":"Testowa"},"streetNumber":{"description":"Client street number","type":"string","maxLength":32,"minLength":0,"example":"4b\/12"},"city":{"description":"Client city","type":"string","maxLength":128,"minLength":0,"example":"Krak\u00f3w"},"zipCode":{"description":"Client zip code","type":"string","maxLength":10,"minLength":0,"example":"31-154"},"country":{"title":"Country code.","description":"Client country","type":"string","maxLength":2,"minLength":2,"example":"PL"},"parcelIdExternal":{"description":"Pickup point ID","type":"string","maxLength":64,"minLength":0,"example":"KRA32B"},"parcelName":{"description":"Pickup point name","type":"string","maxLength":128,"minLength":0,"example":"Paczkomat, ul. Testowa 12 (obok sklepu)"},"companyTaxNumber":{"description":"Company tax ID","type":"string","maxLength":64,"minLength":0,"example":"937-271-51-54"},"companyName":{"description":"Company name","type":"string","maxLength":128,"minLength":0,"example":"Apilo Sp. z o.o."}},"type":"object"},"RestOrderItemsDTO2":{"required":["originalName","originalPriceWithTax","quantity","type"],"properties":{"id":{"description":"Product ID in create\/update process, Unique Order Item ID in reading process","type":"integer","maximum":4294967295,"minimum":1,"example":1},"idExternal":{"description":"External product item ID","type":"string","maxLength":36,"minLength":0,"example":"359"},"ean":{"description":"EAN","type":"string","maxLength":14,"minLength":0,"pattern":"^[0-9]{1,14}$","example":"400638133393"},"sku":{"description":"SKU","type":"string","maxLength":96,"minLength":1,"example":"P44\/3-T1.2"},"originalName":{"title":"Original name.","description":"Product name","type":"string","maxLength":255,"minLength":0,"example":"Samsung Galaxy S20 Plus Black 128GB 5G"},"originalCode":{"description":"Product unique code","type":"string","maxLength":96,"minLength":0,"example":"PHONE-S20-128GB-B"},"originalPriceWithTax":{"description":"Gross product price","type":"string","maximum":9999999.99,"minimum":0.01,"example":"2460.00"},"originalPriceWithoutTax":{"description":"Net product price","type":"string","maximum":9999999.99,"minimum":0.01,"example":"2000.00"},"media":{"title":"URL.","description":"Image URL","type":"string","example":null},"quantity":{"description":"Quantity of products","type":"integer","maximum":65535,"minimum":1,"example":2},"tax":{"title":"TaxEnum.","description":"The amount of VAT (VAT value | `''` if TAX is not specified and will be calculated | `'-1'` when exempt from VAT)","type":"string","enum":["27.00","25.00","24.00","23.00","22.00","21.00","20.00","19.00","18.00","17.00","16.00","8.00","7.00","5.00","0.00","-1.00",""],"example":"23.00"},"status":{"type":"string","enum":[0,1]},"unit":{"description":"Product unit","type":"string","maximum":16,"minimum":0,"example":"Szt."},"type":{"description":"Order item type (`1-Product`, `2-Shipment`, `3-service`)","type":"string","enum":[1,2,3]},"productId":{"description":"Internal <a href='#tag\/Warehouse\/operation\/get_rest_warehouse_product_index'>Product ID<\/a> in Apilo (according to product card)","type":"integer","maximum":4294967295,"minimum":0,"nullable":true},"productSet":{"description":"Product Set","type":"integer","example":null,"nullable":true}},"type":"object"},"RestOrderPaymentDTO2":{"required":["type","paymentDate","amount"],"properties":{"id":{"description":"Internal payment ID in Apilo","type":"integer","maximum":4294967295,"minimum":0,"example":371},"idExternal":{"description":"External payment ID","type":"string","maximum":64,"minimum":0,"example":"PAY-123456"},"type":{"description":"<a href='#tag\/Order\/operation\/get_rest_orders_payment_map'>Payment method ID<\/a>","type":"integer","minimum":1,"example":1},"paymentDate":{"description":"Date of payment","type":"string","format":"date-time","example":"2022-03-08T20:00:00Z","nullable":true},"amount":{"description":"Amount of payment","type":"string","maximum":9999999.99,"minimum":0.01,"example":1259.98,"nullable":true},"currency":{"description":"Payment currency","type":"string","maxLength":3,"minLength":3,"example":"PLN","nullable":true},"comment":{"type":"string","maxLength":128,"minLength":0,"example":"Credit card payment"}},"type":"object"},"RestOrderAddressDTO4":{"required":["name"],"properties":{"id":{"description":"Internal addres ID in Apilo","type":"integer","minimum":1,"example":123},"name":{"description":"Client name","type":"string","maxLength":128,"minLength":1,"example":"Jan Kowalski"},"phone":{"description":"Client phone","type":"string","maxLength":64,"minLength":0,"example":"+48 500 000 000"},"email":{"description":"Client E-mail","type":"string","maxLength":128,"minLength":0,"example":"jan.kowalski@apilo.com"},"streetName":{"description":"Client street name","type":"string","maxLength":128,"minLength":0,"example":"Testowa"},"streetNumber":{"description":"Client street number","type":"string","maxLength":32,"minLength":0,"example":"4b\/12"},"city":{"description":"Client city","type":"string","maxLength":128,"minLength":0,"example":"Krak\u00f3w"},"zipCode":{"description":"Client zip code","type":"string","maxLength":10,"minLength":0,"example":"31-154"},"country":{"title":"Country code.","description":"Client country","type":"string","maxLength":2,"minLength":2,"example":"PL"},"department":{"type":"string","nullable":true},"parcelIdExternal":{"description":"Pickup point ID","type":"string","maxLength":64,"minLength":0,"example":"KRA32B"},"parcelName":{"description":"Pickup point name","type":"string","maxLength":128,"minLength":0,"example":"Paczkomat, ul. Testowa 12 (obok sklepu)"},"class":{"type":"string","enum":["customer","house","company","parcel"],"example":"company"},"companyTaxNumber":{"description":"Company tax ID","type":"string","maxLength":64,"minLength":0,"example":"937-271-51-54"},"companyName":{"description":"Company name","type":"string","maxLength":128,"minLength":0,"example":"Apilo Sp. z o.o."}},"type":"object"},"RestOrderAddressDTO5":{"required":["name"],"properties":{"id":{"description":"Internal addres ID in Apilo","type":"integer","minimum":1,"example":123},"name":{"description":"Client name","type":"string","maxLength":128,"minLength":1,"example":"Jan Kowalski"},"phone":{"description":"Client phone","type":"string","maxLength":64,"minLength":0,"example":"+48 500 000 000"},"email":{"description":"Client E-mail","type":"string","maxLength":128,"minLength":0,"example":"jan.kowalski@apilo.com"},"streetName":{"description":"Client street name","type":"string","maxLength":128,"minLength":0,"example":"Testowa"},"streetNumber":{"description":"Client street number","type":"string","maxLength":32,"minLength":0,"example":"4b\/12"},"city":{"description":"Client city","type":"string","maxLength":128,"minLength":0,"example":"Krak\u00f3w"},"zipCode":{"description":"Client zip code","type":"string","maxLength":10,"minLength":0,"example":"31-154"},"country":{"title":"Country code.","description":"Client country","type":"string","maxLength":2,"minLength":2,"example":"PL"},"department":{"type":"string","nullable":true},"parcelIdExternal":{"description":"Pickup point ID","type":"string","maxLength":64,"minLength":0,"example":"KRA32B"},"parcelName":{"description":"Pickup point name","type":"string","maxLength":128,"minLength":0,"example":"Paczkomat, ul. Testowa 12 (obok sklepu)"},"class":{"type":"string","enum":["customer","house","company","parcel"],"example":"company"},"companyTaxNumber":{"description":"Company tax ID","type":"string","maxLength":64,"minLength":0,"example":"937-271-51-54"},"companyName":{"description":"Company name","type":"string","maxLength":128,"minLength":0,"example":"Apilo Sp. z o.o."}},"type":"object"},"RestOrderAddressDTO6":{"required":["name"],"properties":{"id":{"description":"Internal addres ID in Apilo","type":"integer","minimum":1,"example":123},"name":{"description":"Client name","type":"string","maxLength":128,"minLength":1,"example":"Jan Kowalski"},"phone":{"description":"Client phone","type":"string","maxLength":64,"minLength":0,"example":"+48 500 000 000"},"email":{"description":"Client E-mail","type":"string","maxLength":128,"minLength":0,"example":"jan.kowalski@apilo.com"},"streetName":{"description":"Client street name","type":"string","maxLength":128,"minLength":0,"example":"Testowa"},"streetNumber":{"description":"Client street number","type":"string","maxLength":32,"minLength":0,"example":"4b\/12"},"city":{"description":"Client city","type":"string","maxLength":128,"minLength":0,"example":"Krak\u00f3w"},"zipCode":{"description":"Client zip code","type":"string","maxLength":10,"minLength":0,"example":"31-154"},"country":{"title":"Country code.","description":"Client country","type":"string","maxLength":2,"minLength":2,"example":"PL"},"department":{"type":"string","nullable":true},"parcelIdExternal":{"description":"Pickup point ID","type":"string","maxLength":64,"minLength":0,"example":"KRA32B"},"parcelName":{"description":"Pickup point name","type":"string","maxLength":128,"minLength":0,"example":"Paczkomat, ul. Testowa 12 (obok sklepu)"},"class":{"type":"string","enum":["customer","house","company","parcel"],"example":"company"},"companyTaxNumber":{"description":"Company tax ID","type":"string","maxLength":64,"minLength":0,"example":"937-271-51-54"},"companyName":{"description":"Company name","type":"string","maxLength":128,"minLength":0,"example":"Apilo Sp. z o.o."}},"type":"object"},"RestOrderNoteDTO3":{"title":"Order note","description":"This object represents a single note belongs to an order with the specified ID.","required":["comment"],"properties":{"id":{"description":"Internal order ID in Apilo","type":"integer","maximum":4294967295,"minimum":1,"example":221},"type":{"title":"1 - Message from client, 2 - Internal note.","description":"Type of the note","type":"integer","default":1,"enum":[1,2],"example":2},"createdAt":{"description":"Time when created note","type":"string","format":"date-time","example":"2024-01-23T09:29:30+0100","nullable":true},"comment":{"description":"Note content","type":"string","maxLength":1024,"example":"I'll ask for delivery next week at the earliest"}},"type":"object"},"RestOrderDocumentDTO3":{"title":"Order document model","description":"This object represents a document belongs to an order with the specified ID","required":["idExternal","type"],"properties":{"id":{"description":"Internal ID of the shipment","type":"integer","minimum":0,"example":1,"nullable":true},"idExternal":{"description":"External unique ID of the document - used for the update","type":"string","maxLength":36,"minLength":1,"example":"1","nullable":true},"number":{"description":"External document number","type":"string","maxLength":64,"minLength":1,"example":"FV\/1\/12\/2020","nullable":true},"priceWithTax":{"description":"The gross value","type":"string","maximum":99999999.99,"minimum":-99999999.99,"example":123,"nullable":true},"priceWithoutTax":{"description":"The net value","type":"string","maximum":99999999.99,"minimum":-99999999.99,"example":100,"nullable":true},"currency":{"title":"Currency type.","description":"Currency on the document","type":"string","maxLength":3,"minLength":3,"example":"PLN","nullable":true},"currencyValue":{"description":"Currency exchange rate","type":"string","maximum":9999.9999,"minimum":-9999.9999,"example":1,"nullable":true},"type":{"title":"Enum document type, default 16.","description":"Document type - <a href='#tag\/Order\/operation\/get_rest_documents_map'>order document types endpoint<\/a>","type":"integer","example":16,"nullable":true},"createdAt":{"title":"DateTime format.","description":"Date the document was added to Apilo","type":"string","format":"date-time","example":"2023-11-24TT08:33:07+0100","nullable":true}},"type":"object"},"RestTagDTO":{"properties":{"id":{"description":"Internal Tag ID","type":"integer","minimum":"1","example":"1","nullable":true},"alias":{"description":"Tag alias","type":"string","maxLength":32,"minLength":1,"example":"aliasExample","nullable":true},"name":{"description":"Tag name","type":"string","maxLength":64,"minLength":1,"example":"name","nullable":true},"color":{"description":"Tag Color","type":"string","maxLength":32,"minLength":1,"example":"blue","nullable":true}},"type":"object"},"RestShipmentInfoDTO":{"title":"Shipment","description":"This object represents a single shipment in the list.","properties":{"id":{"description":"Internal shipment ID","type":"integer","minimum":1,"example":"123"},"carrierAccountId":{"description":"Carrier account ID","type":"integer","minimum":1,"example":"123"},"carrierBrokerId":{"description":"Carrier broker ID","type":"integer","minimum":1,"example":"123"},"externalId":{"description":"External unique ID of the shipment","type":"string","maxLength":36,"minLength":0,"example":"312","nullable":true},"orderId":{"description":"Internal order ID","type":"string","minimum":1,"example":"123"},"createdAt":{"description":"Date the document was created in Apilo","type":"string","format":"date-time","example":"2023-11-24T08:33:07+0100","nullable":true},"postDate":{"description":"Date of shipment","type":"string","format":"date-time","example":"2022-06-09T10:59:12+0100","nullable":true},"status":{"description":"Shipment tracking status if is present or NULL","type":"string","example":2},"method":{"description":"External unique ID of the shipment method","type":"string","example":"312","nullable":true},"media":{"description":"Null or media UUID - <a href='#tag\/media\/operation\/get_rest_media_get'>media attachment endpoint<\/a>","type":"string","example":"2ed996a6-0b91-529c-9728-f2e59532e7bc"}},"type":"object"},"RestShipmentTrackingDTO":{"title":"Shipment tracking","description":"This object represents a single shipment tracking.","properties":{"id":{"title":"Provided by Apilo.","description":"Internal shipment ID","type":"integer","minimum":1,"example":"123"},"externalId":{"description":"External unique ID of the shipment","type":"string","maxLength":36,"minLength":0,"example":"312","nullable":true},"status":{"description":"Shipment tracking status if is present or NULL","type":"string","example":2},"statusDate":{"title":"DateTime format.","description":"Date of handing over the shipment to the courier","type":"string","format":"date-time","example":"2023-11-24T08:33:07+0100","nullable":true},"statusDescription":{"description":"Descriptive meaning of status","type":"string","maxLength":255,"minLength":0,"example":"Handed over to the courier","nullable":true},"statusCheckTimestamp":{"title":"DateTime format.","description":"Date when the shipment status was last checked","type":"string","format":"date-time","example":"2023-11-24T08:33:07+0100","nullable":true},"receivedDate":{"title":"DateTime format.","description":"The date the parcel was received","type":"string","format":"date-time","example":"2022-06-09T10:59:12+0100","nullable":true},"receivedDays":{"description":"Number of business days in which the parcel was received","type":"integer","minimum":1,"example":"3"}},"type":"object"},"CarrierAccountMappingDTO":{"title":"Carrier account information","description":"This object represents a single item of carrier account information","properties":{"id":{"description":"Internal element ID","type":"integer","maximum":65535,"minimum":1,"example":"3"},"key":{"description":"Internal element key name","type":"string","maxLength":255,"minLength":1,"example":"CARRIER_253"},"name":{"description":"Internal element name","type":"string","maxLength":255,"minLength":1,"example":"Inpost (Kurier, Paczkomaty, Allegro)"},"description":{"description":"Internal element description","type":"string","maxLength":255,"example":"Kurier"},"options":{"$ref":"#\/components\/schemas\/CarrierAccountOptionsDTO"}},"type":"object"},"RestCarrierMethodDTO":{"properties":{"id":{"title":"ID of Carrier Sending Method.","description":"Internal carrier sending method ID","type":"string","maximum":65535,"minimum":1,"example":"parcel_locker"},"name":{"title":"Name of Sending Method.","description":"Method name","type":"string","minimum":1,"example":"Nadanie w paczkomacie"}},"type":"object"},"RestShipmentOptionsDefinitionDTO":{"title":"Shipment options definition","description":"This object represents options describing shipment. You will learn from it what the definitions of individual options look like and which of them are mandatory.","properties":{"id":{"description":"Option ID.","type":"string","example":"options"},"type":{"description":"Option type.","type":"string","enum":["boolean","integer","string","choice","money","dimensions"],"example":"definition"},"label":{"description":"A label that describes an option.","type":"string","example":"Shipping options"},"multiple":{"description":"Specifies whether the application expects one or many objects of this type.","type":"boolean","example":true},"properties":{"description":"List of options describing the shipment as delivery method, insurance, pickup point, etc.","type":"array","items":{"$ref":"#\/components\/schemas\/RestShipmentOptionDTO2"}},"required":{"description":"List of required options.","type":"array","items":{},"example":["cod","dropoffPoint"]}},"type":"object"},"AddressReceiverDTO":{"properties":{"type":{"description":"Address type","type":"string","example":"house","nullable":true},"name":{"description":"Recipient's name","type":"string","example":"Jan Kowalski","nullable":true},"streetName":{"description":"Street name","type":"string","example":"Kwiatowa","nullable":true},"streetNumber":{"description":"Street number","type":"string","example":"1","nullable":true},"zipCode":{"description":"Zip code","type":"string","example":"01-001","nullable":true},"city":{"description":"City","type":"string","example":"Warszawa","nullable":true},"country":{"description":"Country","type":"string","example":"PL","nullable":true},"phone":{"description":"Phone","type":"string","example":"48500600700","nullable":true},"email":{"description":"Email","type":"string","example":"jan.kowalski@poczta.op.pl","nullable":true},"parcelName":{"description":"Helpful description of parcel point.","type":"string","example":"Parcel point next to market.","nullable":true},"parcelIdExternal":{"description":"Unique parcel ID.","type":"string","example":"KRA018","nullable":true}},"type":"object"},"RestShipmentOptionDTO":{"title":"Shipment option","description":"This object represents one of many options required to create shipment.","properties":{"id":{"description":"Option ID.","type":"string","example":"cod"},"type":{"description":"Option type.","type":"string","enum":["boolean","integer","string","choice","money","dimensions"],"example":"money"},"value":{"description":"Option value.","type":"mixed","example":{"amount":12800,"currency":"PLN"},"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"string"},{"type":"array","items":{"anyOf":[{"type":"boolean"},{"type":"integer"},{"type":"string"}]}}]}},"type":"object"},"RestShipmentParcelDTO":{"properties":{"options":{"type":"array","items":{"$ref":"#\/components\/schemas\/RestShipmentOptionDTO"}}},"type":"object"},"NewShipmentCreatedDTO":{"required":["shipmentId"],"properties":{"shipmentId":{"title":"Provided by Apilo.","description":"Internal shipment ID","type":"integer","minimum":1,"example":"123"}},"type":"object"},"RestShipmentCarrierDocumentDTO":{"title":"Shipment","description":"This object represents a single shipment carrier document.","properties":{"id":{"title":"Provided by Apilo.","description":"Internal document ID","type":"integer","minimum":1,"example":"123"},"carrierAccountId":{"title":"Id konta kuriera.","description":"Carrier account ID","type":"integer","minimum":1,"example":"123"},"createdAt":{"title":"DateTime format.","description":"Date the document was created in Apilo","type":"string","format":"date-time","example":"2023-11-24T08:33:07+0100","nullable":true},"type":{"title":"Enum document type, default 16.","description":"Document type - <a href='#tag\/order\/paths\/~1rest~1api~1orders~1documents~1map~1\/get'>order document types endpoint<\/a>","type":"integer","example":16,"nullable":true},"media":{"description":"Null or media UUID - <a href='#tag\/media\/operation\/get_rest_media_get'>media attachment endpoint<\/a>","type":"string","example":"2ed996a6-0b91-529c-9728-f2e59532e7bc"}},"type":"object"},"RestShippingConfirmationDTO":{"title":"Shipping confirmation","description":"This object represents an shipping confirmation.","required":["shipmentId","type"],"properties":{"shipmentId":{"title":"Shipment ID.","description":"Internal shipment ID","type":"integer","minimum":1,"example":"123"},"type":{"title":"Carrier document type.","description":"Carrier document type (1 - TYPE_SEND_FROM_STACK, 2 - TYPE_CMR)","type":"integer","enum":[1,2],"example":"1"},"pickupId":{"title":"Pickup ID.","description":"Pickup ID form <a href='#tag\/Shipment\/operation\/post_rest_shipment_pickup_date_proposal'>Get shipment pick up date proposal<\/a> or NULL","type":"string","example":"2024-06-12|09:00|18:00"}},"type":"object"},"RestShippingConfirmationsListingItemDTO":{"title":"Shipping confirmation","description":"This object represents an shipping confirmation.","properties":{"id":{"title":"Carrier Document ID.","description":"Carrier Document ID","type":"integer","minimum":1,"example":"123"},"media":{"title":"Pickup ID.","description":"Null or media UUID - <a href='#tag\/media\/operation\/get_rest_media_get'>media attachment endpoint<\/a>","type":"string","example":"2ed996a6-0b91-529c-9728-f2e59532e7bc"},"shipments":{"title":"List of shipment IDs.","description":"List of shipment IDs","type":"array","items":{"$ref":"#\/components\/schemas\/RestShipmentIdDTO"},"example":{"shipment":[{"id":1},{"id":2}]}},"error":{"$ref":"#\/components\/schemas\/RestShippingConfirmationsErrorDTO"}},"type":"object"},"RestShipmentIdDTO":{"title":"Shipment","description":"This object represents a single shipment ID.","properties":{"id":{"title":"Provided by Apilo.","description":"Internal shipment ID","type":"integer","minimum":1,"example":"123"}},"type":"object"},"RestShipmentPickupDateProposalsDTO":{"title":"Shipment","description":"This object represents a single shipment pickup date proposals.","properties":{"shipmentId":{"title":"Provided by Apilo.","description":"Internal shipment ID","type":"integer","minimum":1,"example":"123"},"type":{"title":"Carrier document type.","description":"Carrier document type (1 - TYPE_SEND_FROM_STACK, 2 - TYPE_CMR)","type":"integer","enum":[1,2],"example":"1"},"pickupDate":{"title":"Pickup date proposals.","description":"Pickup date proposals","type":"array","items":{},"example":[{"pickupId":"no_pickup"},{"pickupId":"working_days"},{"pickupId":"2024-06-12|09:00|18:00"},{"pickupId":"2023071210001300"}]}},"type":"object"},"RestAttributeDTO":{"required":["type","name"],"properties":{"id":{"title":"Provided by Apilo.","description":"Internal attribute ID","type":"integer","minimum":1,"example":"123"},"type":{"title":"Typ atrybutu.","description":"Attribute type ('1-Text', 2-'boolean', '9-textarea', '16-feature-multi', '17-feature-single')","type":"integer","enum":[1,2,9,16,17],"example":1,"nullable":true},"name":{"title":"Nazwa atrybutu.","description":"Name of attribute","type":"string","maxLength":64,"example":"Atribute Name"},"attributeFeatures":{"title":"Attribute features.","description":"Attribute Features","type":"array","items":{"oneOf":[{"$ref":"#\/components\/schemas\/RestAttributeFeatureDTO"}]},"example":[{"id":1,"value":"test value 1"},{"id":2,"value":"test value 2"}]}},"type":"object"},"RestAttributeDTO2":{"required":["type","name"],"properties":{"type":{"title":"Typ atrybutu.","description":"Attribute type ('1-Text', 2-'boolean', '9-textarea', '16-feature-multi', '17-feature-single')","type":"integer","enum":[1,2,9,16,17],"example":1,"nullable":true},"name":{"title":"Nazwa atrybutu.","description":"Name of attribute","type":"string","maxLength":64,"example":"Atribute Name"},"attributeFeatures":{"title":"Attribute features.","description":"Attribute Features","type":"array","items":{"oneOf":[{"$ref":"#\/components\/schemas\/RestAttributeFeatureDTO2"}]},"example":[{"id":1,"value":"test value 1"},{"id":2,"value":"test value 2"}]}},"type":"object"},"RestAttributeDTO3":{"required":["name"],"properties":{"id":{"title":"Provided by Apilo.","description":"Internal attribute ID","type":"integer","minimum":1,"example":"123"},"name":{"title":"Nazwa atrybutu.","description":"Name of attribute","type":"string","maxLength":64,"example":"Atribute Name"},"attributeFeatures":{"title":"Attribute features.","description":"Attribute Features","type":"array","items":{"oneOf":[{"$ref":"#\/components\/schemas\/RestAttributeFeatureDTO3"}]},"example":[{"id":1,"value":"test value 1"},{"id":2,"value":"test value 2"}]}},"type":"object"},"RestProductAttributeDTO":{"required":["id","productId"],"properties":{"id":{"title":"Provided by Apilo.","description":"Internal Attribute ID","type":"integer","minimum":1,"example":321},"productId":{"title":"Product Id provided by APILO.","description":"Internal Product ID","type":"integer","minimum":1,"example":462},"type":{"title":"Product Attribute Type.","description":"Attribute type ('1-Text', 2-'boolean', '9-textarea', '16-feature')","type":"integer","enum":[1,2,9,16],"example":1},"values":{"title":"Product Attribute Values.","description":"Product Attribute Values","type":"array","items":{"oneOf":[{"$ref":"#\/components\/schemas\/RestProductAttributeTextDTO"},{"$ref":"#\/components\/schemas\/RestProductAttributeTextAreaDTO"},{"$ref":"#\/components\/schemas\/RestProductAttributeBooleanDTO"},{"$ref":"#\/components\/schemas\/RestProductAttributeFeatureDTO"}]}}},"type":"object"},"RestProductAttributeDTO2":{"required":["id","productId"],"properties":{"id":{"title":"Provided by Apilo.","description":"Internal Attribute ID","type":"integer","minimum":1,"example":321},"productId":{"title":"Product Id provided by APILO.","description":"Internal Product ID","type":"integer","minimum":1,"example":462},"type":{"title":"Product Attribute Type.","description":"Attribute type ('1-Text', 2-'boolean', '9-textarea', '16-feature')","type":"integer","enum":[1,2,9,16],"example":1},"values":{"title":"Product Attribute Values.","description":"Product Attribute Values","type":"array","items":{"oneOf":[{"$ref":"#\/components\/schemas\/RestProductAttributeTextDTO2"},{"$ref":"#\/components\/schemas\/RestProductAttributeTextAreaDTO2"},{"$ref":"#\/components\/schemas\/RestProductAttributeBooleanDTO2"},{"$ref":"#\/components\/schemas\/RestProductAttributeFeatureDTO2"}]}}},"type":"object"},"RestProductAttributeDTO3":{"required":["id","productId"],"properties":{"id":{"title":"Provided by Apilo.","description":"Internal Attribute ID","type":"integer","minimum":1,"example":321},"productId":{"title":"Product Id provided by APILO.","description":"Internal Product ID","type":"integer","minimum":1,"example":462},"type":{"title":"Product Attribute Type.","description":"Attribute type ('1-Text', 2-'boolean', '9-textarea', '16-feature')","type":"integer","enum":[1,2,9,16],"example":1},"values":{"title":"Product Attribute Values.","description":"Product Attribute Values","type":"array","items":{"oneOf":[{"$ref":"#\/components\/schemas\/RestProductAttributeTextDTO3"},{"$ref":"#\/components\/schemas\/RestProductAttributeTextAreaDTO3"},{"$ref":"#\/components\/schemas\/RestProductAttributeBooleanDTO3"},{"$ref":"#\/components\/schemas\/RestProductAttributeFeatureDTO3"}]}}},"type":"object"},"ProductModel":{"properties":{"name":{"description":"Product name","type":"string","example":"Samsung Galxy S20 Plus Black 128GB","nullable":true},"unit":{"type":"string","nullable":true},"weight":{"description":"Product weight [kg]","type":"string","example":1.12,"nullable":true},"priceWithoutTax":{"description":"Net price","type":"string","example":100},"sku":{"description":"Product SKU","type":"string","example":"HG-331\/P","nullable":true},"ean":{"title":"EAN-14","description":"EAN-14","type":"string","example":"4006381333931","nullable":true},"id":{"description":"Internal product ID in Apilo","type":"integer","example":1234},"originalCode":{"description":"External product identifier (unambiguous against API\/channel)","type":"string","example":"p12345","nullable":true},"quantity":{"description":"Product stock","type":"integer","example":15},"priceWithTax":{"description":"Gross price","type":"string","example":123},"tax":{"description":"VAT rate (e.g. 23.00, -1.00 - tax exempt).","type":"string","example":"23.00"},"status":{"title":"status produktu","description":"Product status (`0-inactive`, `1-active`, `8-archive`)","type":"integer","enum":[0,1,8],"example":1,"nullable":true}},"type":"object"},"PriceModel":{"properties":{"id":{"description":"Price ID","type":"integer","example":1},"price":{"description":"Price list ID","type":"integer","example":12},"product":{"description":"Product ID","type":"integer","example":3},"customPriceWithTax":{"description":"Custom price with tax","type":"number","format":"float","example":14.9,"nullable":true},"customPriceModify":{"description":"Custom price modify","type":"number","format":"float","example":10,"nullable":true},"customMode":{"description":"Custom mode","type":"integer","example":7,"nullable":true}},"type":"object"},"RestDocumentPersonalInfoDTO":{"title":"Personal info","description":"Collection of personal info belongs to Fiscal document","properties":{"id":{"description":"Internal ID of the personal info","type":"integer","example":1121,"nullable":true},"name":{"description":"Person name","type":"string","maxLength":128,"example":"Jan Kowalski","nullable":true},"companyName":{"description":"Company name","type":"string","maxLength":128,"example":"Kowalsky Sp. z o.o.","nullable":true},"companyTaxNumber":{"description":"Company Tax ID","type":"string","maxLength":64,"example":"1573091058","nullable":true},"streetName":{"description":"Street name","type":"string","maxLength":128,"example":"ul. Pawia","nullable":true},"streetNumber":{"description":"Street number","type":"string","maxLength":32,"example":"9","nullable":true},"city":{"description":"City","type":"string","maxLength":128,"example":"Krak\u00f3w","nullable":true},"zipCode":{"description":"Zip code","type":"string","maxLength":10,"example":"31-154","nullable":true},"country":{"description":"Country code","type":"string","maxLength":2,"minLength":2,"example":"PL","nullable":true},"type":{"title":"Enum document address type.","description":"Document address type","type":"string","enum":["house","company","parcel"],"example":"company"}},"type":"object"},"RestDocumentItemDTO":{"properties":{"id":{"description":"Internal ID of the item","type":"integer","minimum":0,"example":329},"originalPriceWithTax":{"description":"Gross price of the invoice item","type":"string","maximum":9999999.99,"minimum":-9999999.99,"example":123,"nullable":true},"originalPriceWithoutTax":{"description":"Net price of the invoice item","type":"string","maximum":9999999.99,"minimum":-9999999.99,"example":100,"nullable":true},"tax":{"description":"Tax of the invoice item","type":"string","maximum":99.99,"minimum":-99.99,"example":23,"nullable":true},"quantity":{"description":"Quantity of the invoice items","type":"integer","maximum":65535,"minimum":0,"example":1,"nullable":true},"originalAmountTotalWithTax":{"description":"Gross value of the invoice item","type":"string","maximum":9999999.99,"minimum":-9999999.99,"example":100,"nullable":true},"originalAmountTotalWithoutTax":{"description":"Net value of the invoice item","type":"string","maximum":9999999.99,"minimum":-9999999.99,"example":100,"nullable":true},"originalAmountTotalTax":{"description":"Tax value of the invoice item","type":"string","maximum":9999999.99,"minimum":-9999999.99,"example":100,"nullable":true},"gtu":{"title":"1 = GTU_1, 2 = GTU_2, ..., 13 = GTU_13.","description":"GTU codes are a type of classification closely related <a href='https:\/\/www.podatki.gov.pl\/glos-podatnika-szczegoly-zgloszenia?application=114710'>to JPK_VAT<\/a>","type":"string","maximum":255,"minimum":0,"enum":[1,2,3,4,5,6,7,8,9,10,11,12,13],"example":2,"nullable":true},"name":{"description":"External document number","type":"string","maxLength":255,"minLength":1,"example":"FV\/1\/12\/2020","nullable":true},"sku":{"description":"SKU","type":"string","maxLength":96,"minLength":1,"example":"P44\/3-T1.2"},"ean":{"description":"EAN","type":"string","maxLength":14,"minLength":0,"pattern":"^[0-9]{1,14}$","example":"400638133393"},"unit":{"description":"Product unit","type":"string","maximum":16,"minimum":0,"example":"Szt."},"type":{"description":"Order item type (`1-Product`, `2-Shipment`, `3-service`)","type":"string","enum":[1,2,3]}},"type":"object"},"RestOrderItemsDTO3":{"required":["originalName","originalPriceWithTax","quantity","type"],"properties":{"id":{"description":"Product ID in create\/update process, Unique Order Item ID in reading process","type":"integer","maximum":4294967295,"minimum":1,"example":1},"idExternal":{"description":"External product item ID","type":"string","maxLength":36,"minLength":0,"example":"359"},"ean":{"description":"EAN","type":"string","maxLength":14,"minLength":0,"pattern":"^[0-9]{1,14}$","example":"400638133393"},"sku":{"description":"SKU","type":"string","maxLength":96,"minLength":1,"example":"P44\/3-T1.2"},"originalName":{"title":"Original name.","description":"Product name","type":"string","maxLength":255,"minLength":0,"example":"Samsung Galaxy S20 Plus Black 128GB 5G"},"originalCode":{"description":"Product unique code","type":"string","maxLength":96,"minLength":0,"example":"PHONE-S20-128GB-B"},"originalPriceWithTax":{"description":"Gross product price","type":"string","maximum":9999999.99,"minimum":0.01,"example":"2460.00"},"originalPriceWithoutTax":{"description":"Net product price","type":"string","maximum":9999999.99,"minimum":0.01,"example":"2000.00"},"media":{"title":"URL.","description":"Image URL","type":"string","example":null},"quantity":{"description":"Quantity of products","type":"integer","maximum":65535,"minimum":1,"example":2},"tax":{"title":"TaxEnum.","description":"The amount of VAT (VAT value | `''` if TAX is not specified and will be calculated | `'-1'` when exempt from VAT)","type":"string","enum":["27.00","25.00","24.00","23.00","22.00","21.00","20.00","19.00","18.00","17.00","16.00","8.00","7.00","5.00","0.00","-1.00",""],"example":"23.00"},"status":{"type":"string","enum":[0,1]},"unit":{"description":"Product unit","type":"string","maximum":16,"minimum":0,"example":"Szt."},"type":{"description":"Order item type (`1-Product`, `2-Shipment`, `3-service`)","type":"string","enum":[1,2,3]}},"type":"object"},"RestOrderAddressDTO7":{"required":["name"],"properties":{"id":{"description":"Internal addres ID in Apilo","type":"integer","minimum":1,"example":123},"name":{"description":"Client name","type":"string","maxLength":128,"minLength":1,"example":"Jan Kowalski"},"phone":{"description":"Client phone","type":"string","maxLength":64,"minLength":0,"example":"+48 500 000 000"},"email":{"description":"Client E-mail","type":"string","maxLength":128,"minLength":0,"example":"jan.kowalski@apilo.com"},"streetName":{"description":"Client street name","type":"string","maxLength":128,"minLength":0,"example":"Testowa"},"streetNumber":{"description":"Client street number","type":"string","maxLength":32,"minLength":0,"example":"4b\/12"},"city":{"description":"Client city","type":"string","maxLength":128,"minLength":0,"example":"Krak\u00f3w"},"zipCode":{"description":"Client zip code","type":"string","maxLength":10,"minLength":0,"example":"31-154"},"country":{"title":"Country code.","description":"Client country","type":"string","maxLength":2,"minLength":2,"example":"PL"},"department":{"type":"string","nullable":true},"class":{"type":"string","enum":["customer","house","company","parcel"],"example":"company"}},"type":"object"},"CarrierAccountOptionsDTO":{"title":"Carrier account options","description":"Contains information about courier account options","properties":{"isPickupInShipmentCreation":{"description":"Information whether pickup is available when creating a shipment","type":"boolean","example":true},"isPickupInShipmentConfirmation":{"description":"Information whether pickup is available when confirming a shipment","type":"boolean","example":true},"isShipmentConfirmationRequired":{"description":"Information whether shipping confirmation is required","type":"boolean","example":true}},"type":"object"},"RestShipmentOptionDTO2":{"title":"Shipment option","description":"This object represents one of many options required to create shipment.","properties":{"id":{"description":"Option ID.","type":"string","example":"cod"},"type":{"description":"Option type.","type":"string","enum":["boolean","integer","string","choice","money","dimensions"],"example":"money"},"label":{"description":"A label that describes an option.","type":"string","example":"Shipping COD"}},"type":"object"},"RestShippingConfirmationsErrorDTO":{"title":"Shipping confirmation error","description":"This object represents an shipping confirmation error.","properties":{"pickupError":{"title":"Information whether an error occurred when ordering Pickup.","description":"Information whether an error occurred when ordering Pickup","type":"bool","example":true},"pickupErrorMessage":{"title":"Information what error occurred when ordering Pickup.","description":"Information what error occurred when ordering Pickup","type":"string","example":"The pickup date is not available"},"shippingConfirmationError":{"title":"Information whether an error occurred while shipping confirmation.","description":"Information whether an error occurred while shipping confirmation","type":"bool","example":true},"shippingConfirmationErrorMessage":{"title":"Information what error occurred while shipping confirmation.","description":"Information what error occurred while shipping confirmation","type":"string","example":"Shipping confirmation already exists"}},"type":"object"},"RestAttributeFeatureDTO":{"required":["value"],"properties":{"id":{"title":"Provided by Apilo.","description":"Internal attribute feature ID","type":"integer","example":"123","nullable":true},"value":{"title":"Warto\u015b\u0107 atrybutu.","description":"Value","type":"string","maximum":255,"minimum":1,"example":"test"}},"type":"object"},"RestAttributeFeatureDTO2":{"required":["value"],"properties":{"id":{"title":"Provided by Apilo.","description":"Internal attribute feature ID","type":"integer","example":"123","nullable":true},"value":{"title":"Warto\u015b\u0107 atrybutu.","description":"Value","type":"string","maximum":255,"minimum":1,"example":"test"}},"type":"object"},"RestAttributeFeatureDTO3":{"required":["value"],"properties":{"id":{"title":"Provided by Apilo.","description":"Internal attribute feature ID","type":"integer","example":"123","nullable":true},"value":{"title":"Warto\u015b\u0107 atrybutu.","description":"Value","type":"string","maximum":255,"minimum":1,"example":"test"}},"type":"object"},"RestProductAttributeTextDTO":{"title":"ProductAttributeTextDTO","description":"This object represents product Attribute text DTO .","properties":{"value":{"title":"Product Attribute value.","description":"Value","type":"string","maximum":255,"minimum":1,"example":"test"},"id":{"title":"Provided by Apilo.","description":"Internal Attribute ID","type":"integer","minimum":1,"example":123}},"type":"object"},"RestProductAttributeTextAreaDTO":{"title":"ProductAttributeTextAreaDTO","description":"This object represents product Attribute text area DTO .","properties":{"value":{"title":"Product Attribute TextArea value.","description":"Value","type":"string","maximum":65535,"minimum":1,"example":"test"},"id":{"title":"Provided by Apilo.","description":"Internal Attribute ID","type":"integer","minimum":1,"example":123}},"type":"object"},"RestProductAttributeBooleanDTO":{"title":"ProductAttributeBooleanDTO","description":"This object represents product Attribute text boolean DTO .","properties":{"value":{"title":"Product attribute bool value.","description":"Value","type":"boolean","example":"true"},"id":{"title":"Provided by Apilo.","description":"Internal Attribute ID","type":"integer","minimum":1,"example":123}},"type":"object"},"RestProductAttributeFeatureDTO":{"properties":{"id":{"title":"Provided by Apilo.","description":"Internal Attribute ID","type":"integer","minimum":1,"example":123}},"type":"object"},"RestProductAttributeTextDTO2":{"title":"ProductAttributeTextDTO","description":"This object represents product Attribute text DTO .","properties":{"id":{"title":"Provided by Apilo.","description":"Internal Attribute ID","type":"integer","minimum":1,"example":123}},"type":"object"},"RestProductAttributeTextAreaDTO2":{"title":"ProductAttributeTextAreaDTO","description":"This object represents product Attribute text area DTO .","properties":{"id":{"title":"Provided by Apilo.","description":"Internal Attribute ID","type":"integer","minimum":1,"example":123}},"type":"object"},"RestProductAttributeBooleanDTO2":{"title":"ProductAttributeBooleanDTO","description":"This object represents product Attribute text boolean DTO .","properties":{"id":{"title":"Provided by Apilo.","description":"Internal Attribute ID","type":"integer","minimum":1,"example":123}},"type":"object"},"RestProductAttributeFeatureDTO2":{"properties":{"id":{"title":"Provided by Apilo.","description":"Internal Attribute ID","type":"integer","minimum":1,"example":123}},"type":"object"},"RestProductAttributeTextDTO3":{"title":"ProductAttributeTextDTO","description":"This object represents product Attribute text DTO .","properties":{"value":{"title":"Product Attribute value.","description":"Value","type":"string","maximum":255,"minimum":1,"example":"test"},"id":{"title":"Provided by Apilo.","description":"Internal Attribute ID","type":"integer","minimum":1,"example":123}},"type":"object"},"RestProductAttributeTextAreaDTO3":{"title":"ProductAttributeTextAreaDTO","description":"This object represents product Attribute text area DTO .","properties":{"value":{"title":"Product Attribute TextArea value.","description":"Value","type":"string","maximum":65535,"minimum":1,"example":"test"},"id":{"title":"Provided by Apilo.","description":"Internal Attribute ID","type":"integer","minimum":1,"example":123}},"type":"object"},"RestProductAttributeBooleanDTO3":{"title":"ProductAttributeBooleanDTO","description":"This object represents product Attribute text boolean DTO .","properties":{"value":{"title":"Product attribute bool value.","description":"Value","type":"boolean","example":"true"},"id":{"title":"Provided by Apilo.","description":"Internal Attribute ID","type":"integer","minimum":1,"example":123}},"type":"object"},"RestProductAttributeFeatureDTO3":{"properties":{"id":{"title":"Provided by Apilo.","description":"Internal Attribute ID","type":"integer","minimum":1,"example":123}},"type":"object"}},"securitySchemes":{"BasicAuth":{"type":"http","description":"Authorization header that contains the __Basic__ word followed by a space and a base64-encoded __client_id:secret__ string.\nFor example, a header containing the `2:1e934d38-6052-5b56-87e1-53254a1c7597` credentials would be encoded as\n`MjoxZTkzNGQzOC02MDUyLTViNTYtODdlMS01MzI1NGExYzc1OTc=`\n","scheme":"basic"},"BearerAuth":{"type":"http","description":"Autoryzacja API odbywa si\u0119 za pomoc\u0105 access tokenu wa\u017cnego 21 dni. Po wyga\u015bni\u0119ciu (lub przed) access tokenu nale\u017cy go odnowi\u0107 korzystaj\u0105c z refresh tokenu (wa\u017cnego 2 miesi\u0105ce).\nAby pobra\u0107 par\u0119 kluczy access oraz refresh token nale\u017cy utworzy\u0107 now\u0105 aplikacj\u0119 w systemie Apilo w zak\u0142adce Administracja\/API Apilo.\nDomy\u015blnie ka\u017cdy wygenerowany klucz ma scope read oraz write.\n","scheme":"bearer"}}},"tags":[{"name":"Authorization","description":"Autoryzacja API odbywa si\u0119 za pomoc\u0105 access tokenu wa\u017cnego 21 dni. Po wyga\u015bni\u0119ciu (lub przed) access tokenu nale\u017cy go odnowi\u0107 korzystaj\u0105c z refresh tokenu (wa\u017cnego 2 miesi\u0105ce).\nAby pobra\u0107 par\u0119 kluczy access oraz refresh token nale\u017cy utworzy\u0107 now\u0105 aplikacj\u0119 w systemie Apilo w zak\u0142adce Administracja\/API Apilo.\nDomy\u015blnie ka\u017cdy wygenerowany klucz ma scope read oraz write.\n"},{"name":"Connection","description":"Connection and status information"},{"name":"Finance document","description":"Integration with document finances"},{"name":"Order","description":"Integration with orders"},{"name":"Warehouse","description":"Warehouse manager - product, price, quantity"},{"name":"Sale","description":"Sale "},{"name":"Media","description":"Media attachment management"},{"name":"Shipment","description":"Shipment management"}]}