# Models ## The ParcelCreateRequest object ```json {"openapi":"3.0.3","info":{"title":"Packli API","version":"3.0.0"},"components":{"schemas":{"ParcelCreateRequest":{"type":"object","required":["service_id","weight","size","cod","cod_currency_id","insurance","insurance_currency_id","is_fragile","is_amorf"],"properties":{"service_id":{"type":"integer","description":"Provider service ID"},"place_id":{"type":"integer","nullable":true,"description":"Provider place ID (required for some services)"},"custom_id":{"type":"string","nullable":true,"maxLength":255,"description":"Custom parcel identifier"},"contact_id":{"type":"integer","nullable":true,"description":"Existing contact ID (alternative to contact details)"},"contact_first_name":{"type":"string","nullable":true,"description":"Contact first name"},"contact_family_name":{"type":"string","nullable":true,"description":"Contact family name"},"contact_phone":{"type":"string","nullable":true,"description":"Contact phone number"},"contact_email":{"type":"string","nullable":true,"format":"email","description":"Contact email address"},"contact_country_id":{"type":"integer","nullable":true,"description":"Contact country ID"},"contact_zip":{"type":"string","nullable":true,"description":"Contact postal code"},"contact_city":{"type":"string","nullable":true,"description":"Contact city"},"contact_address":{"type":"string","nullable":true,"description":"Contact address"},"warehouse_id":{"type":"integer","nullable":true,"description":"Warehouse contact ID (alternative to warehouse details)"},"warehouse_zip":{"type":"string","nullable":true,"description":"Warehouse postal code"},"warehouse_city":{"type":"string","nullable":true,"description":"Warehouse city"},"warehouse_address":{"type":"string","nullable":true,"description":"Warehouse address"},"warehouse_email":{"type":"string","nullable":true,"format":"email","description":"Warehouse email"},"warehouse_phone":{"type":"string","nullable":true,"description":"Warehouse phone"},"weight":{"type":"number","minimum":0.1,"maximum":40,"description":"Package weight in kg"},"size":{"type":"string","enum":["xs","s","m","l","xl","xxl"],"description":"Package size category"},"cod":{"type":"number","minimum":0,"description":"Cash on delivery amount"},"cod_currency_id":{"type":"integer","description":"COD currency ID"},"insurance":{"type":"number","minimum":0,"description":"Insurance amount"},"insurance_currency_id":{"type":"integer","description":"Insurance currency ID"},"is_fragile":{"type":"boolean","description":"Whether package is fragile"},"is_amorf":{"type":"boolean","description":"Whether package is amorphous"},"customer_note":{"type":"string","nullable":true,"maxLength":50,"description":"Customer note"}}}}}} ``` ## The ContactCreateRequest object ```json {"openapi":"3.0.3","info":{"title":"Packli API","version":"3.0.0"},"components":{"schemas":{"ContactCreateRequest":{"type":"object","properties":{"first_name":{"type":"string","nullable":true,"description":"First name"},"family_name":{"type":"string","nullable":true,"description":"Family name"},"email":{"type":"string","nullable":true,"format":"email","description":"Email address"},"phone":{"type":"string","nullable":true,"description":"Phone number"},"country_id":{"type":"integer","nullable":true,"description":"Country ID"},"zip":{"type":"string","nullable":true,"description":"Postal code"},"city":{"type":"string","nullable":true,"description":"City"},"address":{"type":"string","nullable":true,"description":"Address"}}}}}} ``` ## The OrderCreateRequest object ```json {"openapi":"3.0.3","info":{"title":"Packli API","version":"3.0.0"},"components":{"schemas":{"OrderCreateRequest":{"type":"object","required":["ids"],"properties":{"ids":{"type":"array","items":{"type":"integer"},"description":"Array of parcel IDs to include in the order"}}}}}} ``` ## The ParcelList object ```json {"openapi":"3.0.3","info":{"title":"Packli API","version":"3.0.0"},"components":{"schemas":{"ParcelList":{"type":"object","properties":{"id":{"type":"integer","description":"Parcel ID"},"order_id":{"type":"integer","nullable":true,"description":"Order ID if parcel is part of an order"},"custom_id":{"type":"string","nullable":true,"description":"Custom parcel identifier"},"account_id":{"type":"integer","description":"Account ID"},"warehouse_id":{"type":"integer","description":"Warehouse contact ID"},"contact_id":{"type":"integer","description":"Contact ID"},"place_id":{"type":"integer","nullable":true,"description":"Provider place ID"},"service_id":{"type":"integer","description":"Service ID"},"weight":{"type":"number","description":"Package weight in kg"},"size":{"type":"string","description":"Package size category"},"cod":{"type":"number","description":"Cash on delivery amount"},"cod_currency_id":{"type":"integer","description":"COD currency ID"},"cod_account_date":{"type":"string","nullable":true,"format":"date-time","description":"COD account date"},"cod_accounted_amount":{"type":"number","description":"COD accounted amount"},"insurance":{"type":"number","description":"Insurance amount"},"insurance_currency_id":{"type":"integer","description":"Insurance currency ID"},"is_fragile":{"type":"integer","description":"Whether package is fragile (1/0)"},"is_amorf":{"type":"integer","description":"Whether package is amorphous (1/0)"},"is_priority":{"type":"integer","description":"Whether package has priority (1/0)"},"service_fee":{"type":"number","nullable":true,"description":"Service fee"},"return_fee":{"type":"number","nullable":true,"description":"Return fee"},"fees_currency_id":{"type":"integer","nullable":true,"description":"Fees currency ID"},"fees_calculation":{"type":"string","nullable":true,"description":"JSON string with fee calculation details"},"fees_discount_percent":{"type":"number","nullable":true,"description":"Fee discount percentage"},"foreign_tracking_id":{"type":"string","nullable":true,"description":"External tracking ID"},"customer_note":{"type":"string","nullable":true,"description":"Customer note"},"upload_by":{"type":"string","nullable":true,"description":"Upload user"},"upload_from":{"type":"string","description":"Upload source"},"order_error":{"type":"string","nullable":true,"description":"Order error message"},"tracked_at":{"type":"string","nullable":true,"format":"date-time","description":"Tracking timestamp"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp"},"updated_at":{"type":"string","format":"date-time","description":"Last update timestamp"},"deleted_at":{"type":"string","nullable":true,"format":"date-time","description":"Deletion timestamp"},"is_deleteable":{"type":"boolean","description":"Whether parcel can be deleted"},"is_orderable":{"type":"boolean","description":"Whether parcel can be ordered"},"is_editable":{"type":"boolean","description":"Whether parcel can be edited"},"is_printable":{"type":"boolean","description":"Whether parcel can be printed"},"service":{"$ref":"#/components/schemas/ParcelService"},"contact":{"$ref":"#/components/schemas/ParcelContact"},"status":{"$ref":"#/components/schemas/ParcelStatus"},"cod_currency":{"$ref":"#/components/schemas/Currency"},"place":{"type":"object","nullable":true,"description":"Provider place (if applicable)"},"order":{"$ref":"#/components/schemas/ParcelOrder"},"warehouse":{"$ref":"#/components/schemas/ParcelContact"}}},"ParcelService":{"type":"object","properties":{"id":{"type":"integer"},"provider_id":{"type":"integer"},"country_id":{"type":"integer"},"slug":{"type":"string"},"is_default":{"type":"integer"},"full_address_required":{"type":"integer"},"maximum_weight":{"type":"number"},"supported_sizes":{"type":"string","description":"JSON array of supported sizes"},"is_support_amorf":{"type":"integer"},"is_support_fragile":{"type":"integer"},"is_support_priority":{"type":"integer"},"provider":{"$ref":"#/components/schemas/Provider"}}},"Provider":{"type":"object","properties":{"id":{"type":"integer","description":"Provider ID"},"name":{"type":"string","description":"Provider name"},"slug":{"type":"string","description":"Provider slug"},"tracking_link":{"type":"string","description":"Tracking link template with %foreign_tracking_id% placeholder"}}},"ParcelContact":{"type":"object","properties":{"id":{"type":"integer"},"account_id":{"type":"integer"},"country_id":{"type":"integer"},"is_warehouse":{"type":"integer"},"is_billing":{"type":"integer"},"zip":{"type":"string"},"city":{"type":"string"},"address":{"type":"string"},"position_lat":{"type":"number","nullable":true},"position_lng":{"type":"number","nullable":true},"phone":{"type":"string"},"email":{"type":"string"},"family_name":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"company_name":{"type":"string","nullable":true},"dpd_buCode":{"type":"string","nullable":true},"dpd_customerId":{"type":"string","nullable":true},"dpd_addressId":{"type":"string","nullable":true},"deleted_at":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"country":{"$ref":"#/components/schemas/Country"}}},"Country":{"type":"object","properties":{"id":{"type":"integer","description":"Country ID"},"name":{"type":"string","description":"Country name"},"iso":{"type":"string","description":"ISO country code (lowercase)"},"currency_id":{"type":"integer","description":"Currency ID"},"cod_payout_limit":{"type":"number","description":"Cash on delivery payout limit"},"vat":{"type":"number","description":"VAT rate percentage"}}},"ParcelStatus":{"type":"object","properties":{"id":{"type":"integer"},"parcel_id":{"type":"integer"},"status_code":{"type":"integer"},"status_description":{"type":"string","nullable":true},"status_date":{"type":"string","format":"date-time"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"Currency":{"type":"object","properties":{"id":{"type":"integer","description":"Currency ID"},"name":{"type":"string","description":"Currency name"},"short_text":{"type":"string","description":"Currency short code"},"symbol":{"type":"string","description":"Currency symbol"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"ParcelOrder":{"type":"object","properties":{"id":{"type":"integer"},"account_id":{"type":"integer"},"user_id":{"type":"integer"},"deleted_at":{"type":"string","nullable":true},"updated_at":{"type":"string","format":"date-time"},"created_at":{"type":"string","format":"date-time"}}}}}} ``` ## The Parcel object ```json {"openapi":"3.0.3","info":{"title":"Packli API","version":"3.0.0"},"components":{"schemas":{"Parcel":{"type":"object","properties":{"id":{"type":"integer","description":"Parcel ID"},"custom_id":{"type":"string","nullable":true,"description":"Custom parcel identifier"},"weight":{"type":"number","description":"Package weight in kg"},"size":{"type":"string","description":"Package size category"},"cod":{"type":"number","description":"Cash on delivery amount"},"cod_currency_id":{"type":"integer","description":"COD currency ID"},"insurance":{"type":"number","description":"Insurance amount"},"insurance_currency_id":{"type":"integer","description":"Insurance currency ID"},"is_fragile":{"type":"boolean","description":"Whether package is fragile"},"is_amorf":{"type":"boolean","description":"Whether package is amorphous"},"customer_note":{"type":"string","nullable":true,"description":"Customer note"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp"},"contact":{"$ref":"#/components/schemas/Contact"},"service":{"$ref":"#/components/schemas/Service"},"status":{"$ref":"#/components/schemas/Status"}}},"Contact":{"type":"object","properties":{"id":{"type":"integer","description":"Contact ID"},"first_name":{"type":"string","nullable":true,"description":"First name"},"family_name":{"type":"string","nullable":true,"description":"Family name"},"email":{"type":"string","nullable":true,"description":"Email address"},"phone":{"type":"string","nullable":true,"description":"Phone number"},"country_id":{"type":"integer","description":"Country ID"},"zip":{"type":"string","nullable":true,"description":"Postal code"},"city":{"type":"string","nullable":true,"description":"City"},"address":{"type":"string","nullable":true,"description":"Address"},"is_warehouse":{"type":"boolean","description":"Whether this is a warehouse contact"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp"},"country":{"$ref":"#/components/schemas/Country"}}},"Country":{"type":"object","properties":{"id":{"type":"integer","description":"Country ID"},"name":{"type":"string","description":"Country name"},"iso":{"type":"string","description":"ISO country code (lowercase)"},"currency_id":{"type":"integer","description":"Currency ID"},"cod_payout_limit":{"type":"number","description":"Cash on delivery payout limit"},"vat":{"type":"number","description":"VAT rate percentage"}}},"Service":{"type":"object","properties":{"id":{"type":"integer","description":"Service ID"},"name":{"type":"string","description":"Service name"},"slug":{"type":"string","description":"Service slug"},"price_per_kg":{"type":"number","description":"Price per kilogram"},"provider":{"$ref":"#/components/schemas/Provider"}}},"Provider":{"type":"object","properties":{"id":{"type":"integer","description":"Provider ID"},"name":{"type":"string","description":"Provider name"},"slug":{"type":"string","description":"Provider slug"},"tracking_link":{"type":"string","description":"Tracking link template with %foreign_tracking_id% placeholder"}}},"Status":{"type":"object","properties":{"id":{"type":"integer","description":"Status ID"},"status_code":{"type":"string","description":"Status code"},"name":{"type":"string","description":"Status name"},"created_at":{"type":"string","format":"date-time","description":"Status timestamp"}}}}}} ``` ## The ParcelDetail object ```json {"openapi":"3.0.3","info":{"title":"Packli API","version":"3.0.0"},"components":{"schemas":{"ParcelDetail":{"allOf":[{"$ref":"#/components/schemas/Parcel"},{"type":"object","properties":{"updated_at":{"type":"string","format":"date-time","description":"Last update timestamp"},"warehouse":{"$ref":"#/components/schemas/Contact"},"statuses":{"type":"array","items":{"$ref":"#/components/schemas/Status"},"description":"Status history"},"cod_currency":{"$ref":"#/components/schemas/Currency"},"insurance_currency":{"$ref":"#/components/schemas/Currency"},"fees_currency":{"$ref":"#/components/schemas/Currency"},"place":{"$ref":"#/components/schemas/ProviderPlace"},"escalations":{"type":"array","items":{"type":"object"},"description":"Escalation records"}}}]},"Parcel":{"type":"object","properties":{"id":{"type":"integer","description":"Parcel ID"},"custom_id":{"type":"string","nullable":true,"description":"Custom parcel identifier"},"weight":{"type":"number","description":"Package weight in kg"},"size":{"type":"string","description":"Package size category"},"cod":{"type":"number","description":"Cash on delivery amount"},"cod_currency_id":{"type":"integer","description":"COD currency ID"},"insurance":{"type":"number","description":"Insurance amount"},"insurance_currency_id":{"type":"integer","description":"Insurance currency ID"},"is_fragile":{"type":"boolean","description":"Whether package is fragile"},"is_amorf":{"type":"boolean","description":"Whether package is amorphous"},"customer_note":{"type":"string","nullable":true,"description":"Customer note"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp"},"contact":{"$ref":"#/components/schemas/Contact"},"service":{"$ref":"#/components/schemas/Service"},"status":{"$ref":"#/components/schemas/Status"}}},"Contact":{"type":"object","properties":{"id":{"type":"integer","description":"Contact ID"},"first_name":{"type":"string","nullable":true,"description":"First name"},"family_name":{"type":"string","nullable":true,"description":"Family name"},"email":{"type":"string","nullable":true,"description":"Email address"},"phone":{"type":"string","nullable":true,"description":"Phone number"},"country_id":{"type":"integer","description":"Country ID"},"zip":{"type":"string","nullable":true,"description":"Postal code"},"city":{"type":"string","nullable":true,"description":"City"},"address":{"type":"string","nullable":true,"description":"Address"},"is_warehouse":{"type":"boolean","description":"Whether this is a warehouse contact"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp"},"country":{"$ref":"#/components/schemas/Country"}}},"Country":{"type":"object","properties":{"id":{"type":"integer","description":"Country ID"},"name":{"type":"string","description":"Country name"},"iso":{"type":"string","description":"ISO country code (lowercase)"},"currency_id":{"type":"integer","description":"Currency ID"},"cod_payout_limit":{"type":"number","description":"Cash on delivery payout limit"},"vat":{"type":"number","description":"VAT rate percentage"}}},"Service":{"type":"object","properties":{"id":{"type":"integer","description":"Service ID"},"name":{"type":"string","description":"Service name"},"slug":{"type":"string","description":"Service slug"},"price_per_kg":{"type":"number","description":"Price per kilogram"},"provider":{"$ref":"#/components/schemas/Provider"}}},"Provider":{"type":"object","properties":{"id":{"type":"integer","description":"Provider ID"},"name":{"type":"string","description":"Provider name"},"slug":{"type":"string","description":"Provider slug"},"tracking_link":{"type":"string","description":"Tracking link template with %foreign_tracking_id% placeholder"}}},"Status":{"type":"object","properties":{"id":{"type":"integer","description":"Status ID"},"status_code":{"type":"string","description":"Status code"},"name":{"type":"string","description":"Status name"},"created_at":{"type":"string","format":"date-time","description":"Status timestamp"}}},"Currency":{"type":"object","properties":{"id":{"type":"integer","description":"Currency ID"},"name":{"type":"string","description":"Currency name"},"short_text":{"type":"string","description":"Currency short code"},"symbol":{"type":"string","description":"Currency symbol"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}},"ProviderPlace":{"type":"object","properties":{"id":{"type":"integer","description":"Provider place ID"},"provider_service_id":{"type":"integer","description":"Provider service ID"},"foreign_id":{"type":"string","description":"External provider ID"},"name":{"type":"string","description":"Place name"},"contact_id":{"type":"integer","description":"Contact ID"},"delivery_available":{"type":"integer","description":"Whether delivery is available (1/0)"},"pickup_available":{"type":"integer","description":"Whether pickup is available (1/0)"},"meta":{"type":"string","description":"JSON metadata with hours and description"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp"},"updated_at":{"type":"string","format":"date-time","description":"Last update timestamp"},"account_id":{"type":"integer","nullable":true,"description":"Account ID"},"country_id":{"type":"integer","description":"Country ID"},"is_warehouse":{"type":"integer","description":"Whether this is a warehouse (1/0)"},"is_billing":{"type":"integer","description":"Whether this is a billing address (1/0)"},"zip":{"type":"string","description":"Postal code"},"city":{"type":"string","description":"City"},"address":{"type":"string","description":"Address"},"position_lat":{"type":"number","description":"Latitude coordinate"},"position_lng":{"type":"number","description":"Longitude coordinate"},"phone":{"type":"string","description":"Phone number"},"email":{"type":"string","description":"Email address"},"family_name":{"type":"string","nullable":true,"description":"Family name"},"first_name":{"type":"string","nullable":true,"description":"First name"},"company_name":{"type":"string","description":"Company name"},"dpd_buCode":{"type":"string","nullable":true,"description":"DPD business unit code"},"dpd_customerId":{"type":"string","nullable":true,"description":"DPD customer ID"},"dpd_addressId":{"type":"string","nullable":true,"description":"DPD address ID"},"deleted_at":{"type":"string","nullable":true,"format":"date-time","description":"Deletion timestamp"},"contact":{"$ref":"#/components/schemas/ProviderPlaceContact"},"provider":{"$ref":"#/components/schemas/ProviderPlaceProvider"},"service":{"$ref":"#/components/schemas/ProviderPlaceService"}}},"ProviderPlaceContact":{"type":"object","properties":{"id":{"type":"integer"},"account_id":{"type":"integer","nullable":true},"country_id":{"type":"integer"},"is_warehouse":{"type":"integer"},"is_billing":{"type":"integer"},"zip":{"type":"string"},"city":{"type":"string"},"address":{"type":"string"},"position_lat":{"type":"number"},"position_lng":{"type":"number"},"phone":{"type":"string"},"email":{"type":"string"},"family_name":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"company_name":{"type":"string"},"dpd_buCode":{"type":"string","nullable":true},"dpd_customerId":{"type":"string","nullable":true},"dpd_addressId":{"type":"string","nullable":true},"deleted_at":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"country":{"$ref":"#/components/schemas/Country"}}},"ProviderPlaceProvider":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"slug":{"type":"string"},"tracking_link":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"laravel_through_key":{"type":"integer"}}},"ProviderPlaceService":{"type":"object","properties":{"id":{"type":"integer"},"provider_id":{"type":"integer"},"country_id":{"type":"integer"},"slug":{"type":"string"},"is_default":{"type":"integer"},"full_address_required":{"type":"integer"},"maximum_weight":{"type":"number"},"supported_sizes":{"type":"string","description":"JSON array of supported sizes"},"is_support_amorf":{"type":"integer"},"is_support_fragile":{"type":"integer"},"is_support_priority":{"type":"integer"}}}}}} ``` ## The Contact object ```json {"openapi":"3.0.3","info":{"title":"Packli API","version":"3.0.0"},"components":{"schemas":{"Contact":{"type":"object","properties":{"id":{"type":"integer","description":"Contact ID"},"first_name":{"type":"string","nullable":true,"description":"First name"},"family_name":{"type":"string","nullable":true,"description":"Family name"},"email":{"type":"string","nullable":true,"description":"Email address"},"phone":{"type":"string","nullable":true,"description":"Phone number"},"country_id":{"type":"integer","description":"Country ID"},"zip":{"type":"string","nullable":true,"description":"Postal code"},"city":{"type":"string","nullable":true,"description":"City"},"address":{"type":"string","nullable":true,"description":"Address"},"is_warehouse":{"type":"boolean","description":"Whether this is a warehouse contact"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp"},"country":{"$ref":"#/components/schemas/Country"}}},"Country":{"type":"object","properties":{"id":{"type":"integer","description":"Country ID"},"name":{"type":"string","description":"Country name"},"iso":{"type":"string","description":"ISO country code (lowercase)"},"currency_id":{"type":"integer","description":"Currency ID"},"cod_payout_limit":{"type":"number","description":"Cash on delivery payout limit"},"vat":{"type":"number","description":"VAT rate percentage"}}}}}} ``` ## The Country object ```json {"openapi":"3.0.3","info":{"title":"Packli API","version":"3.0.0"},"components":{"schemas":{"Country":{"type":"object","properties":{"id":{"type":"integer","description":"Country ID"},"name":{"type":"string","description":"Country name"},"iso":{"type":"string","description":"ISO country code (lowercase)"},"currency_id":{"type":"integer","description":"Currency ID"},"cod_payout_limit":{"type":"number","description":"Cash on delivery payout limit"},"vat":{"type":"number","description":"VAT rate percentage"}}}}}} ``` ## The Provider object ```json {"openapi":"3.0.3","info":{"title":"Packli API","version":"3.0.0"},"components":{"schemas":{"Provider":{"type":"object","properties":{"id":{"type":"integer","description":"Provider ID"},"name":{"type":"string","description":"Provider name"},"slug":{"type":"string","description":"Provider slug"},"tracking_link":{"type":"string","description":"Tracking link template with %foreign_tracking_id% placeholder"}}}}}} ``` ## The Service object ```json {"openapi":"3.0.3","info":{"title":"Packli API","version":"3.0.0"},"components":{"schemas":{"Service":{"type":"object","properties":{"id":{"type":"integer","description":"Service ID"},"name":{"type":"string","description":"Service name"},"slug":{"type":"string","description":"Service slug"},"price_per_kg":{"type":"number","description":"Price per kilogram"},"provider":{"$ref":"#/components/schemas/Provider"}}},"Provider":{"type":"object","properties":{"id":{"type":"integer","description":"Provider ID"},"name":{"type":"string","description":"Provider name"},"slug":{"type":"string","description":"Provider slug"},"tracking_link":{"type":"string","description":"Tracking link template with %foreign_tracking_id% placeholder"}}}}}} ``` ## The Status object ```json {"openapi":"3.0.3","info":{"title":"Packli API","version":"3.0.0"},"components":{"schemas":{"Status":{"type":"object","properties":{"id":{"type":"integer","description":"Status ID"},"status_code":{"type":"string","description":"Status code"},"name":{"type":"string","description":"Status name"},"created_at":{"type":"string","format":"date-time","description":"Status timestamp"}}}}}} ``` ## The ProviderPlace object ```json {"openapi":"3.0.3","info":{"title":"Packli API","version":"3.0.0"},"components":{"schemas":{"ProviderPlace":{"type":"object","properties":{"id":{"type":"integer","description":"Provider place ID"},"provider_service_id":{"type":"integer","description":"Provider service ID"},"foreign_id":{"type":"string","description":"External provider ID"},"name":{"type":"string","description":"Place name"},"contact_id":{"type":"integer","description":"Contact ID"},"delivery_available":{"type":"integer","description":"Whether delivery is available (1/0)"},"pickup_available":{"type":"integer","description":"Whether pickup is available (1/0)"},"meta":{"type":"string","description":"JSON metadata with hours and description"},"created_at":{"type":"string","format":"date-time","description":"Creation timestamp"},"updated_at":{"type":"string","format":"date-time","description":"Last update timestamp"},"account_id":{"type":"integer","nullable":true,"description":"Account ID"},"country_id":{"type":"integer","description":"Country ID"},"is_warehouse":{"type":"integer","description":"Whether this is a warehouse (1/0)"},"is_billing":{"type":"integer","description":"Whether this is a billing address (1/0)"},"zip":{"type":"string","description":"Postal code"},"city":{"type":"string","description":"City"},"address":{"type":"string","description":"Address"},"position_lat":{"type":"number","description":"Latitude coordinate"},"position_lng":{"type":"number","description":"Longitude coordinate"},"phone":{"type":"string","description":"Phone number"},"email":{"type":"string","description":"Email address"},"family_name":{"type":"string","nullable":true,"description":"Family name"},"first_name":{"type":"string","nullable":true,"description":"First name"},"company_name":{"type":"string","description":"Company name"},"dpd_buCode":{"type":"string","nullable":true,"description":"DPD business unit code"},"dpd_customerId":{"type":"string","nullable":true,"description":"DPD customer ID"},"dpd_addressId":{"type":"string","nullable":true,"description":"DPD address ID"},"deleted_at":{"type":"string","nullable":true,"format":"date-time","description":"Deletion timestamp"},"contact":{"$ref":"#/components/schemas/ProviderPlaceContact"},"provider":{"$ref":"#/components/schemas/ProviderPlaceProvider"},"service":{"$ref":"#/components/schemas/ProviderPlaceService"}}},"ProviderPlaceContact":{"type":"object","properties":{"id":{"type":"integer"},"account_id":{"type":"integer","nullable":true},"country_id":{"type":"integer"},"is_warehouse":{"type":"integer"},"is_billing":{"type":"integer"},"zip":{"type":"string"},"city":{"type":"string"},"address":{"type":"string"},"position_lat":{"type":"number"},"position_lng":{"type":"number"},"phone":{"type":"string"},"email":{"type":"string"},"family_name":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"company_name":{"type":"string"},"dpd_buCode":{"type":"string","nullable":true},"dpd_customerId":{"type":"string","nullable":true},"dpd_addressId":{"type":"string","nullable":true},"deleted_at":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"country":{"$ref":"#/components/schemas/Country"}}},"Country":{"type":"object","properties":{"id":{"type":"integer","description":"Country ID"},"name":{"type":"string","description":"Country name"},"iso":{"type":"string","description":"ISO country code (lowercase)"},"currency_id":{"type":"integer","description":"Currency ID"},"cod_payout_limit":{"type":"number","description":"Cash on delivery payout limit"},"vat":{"type":"number","description":"VAT rate percentage"}}},"ProviderPlaceProvider":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"slug":{"type":"string"},"tracking_link":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"laravel_through_key":{"type":"integer"}}},"ProviderPlaceService":{"type":"object","properties":{"id":{"type":"integer"},"provider_id":{"type":"integer"},"country_id":{"type":"integer"},"slug":{"type":"string"},"is_default":{"type":"integer"},"full_address_required":{"type":"integer"},"maximum_weight":{"type":"number"},"supported_sizes":{"type":"string","description":"JSON array of supported sizes"},"is_support_amorf":{"type":"integer"},"is_support_fragile":{"type":"integer"},"is_support_priority":{"type":"integer"}}}}}} ``` ## The ProviderPlaceContact object ```json {"openapi":"3.0.3","info":{"title":"Packli API","version":"3.0.0"},"components":{"schemas":{"ProviderPlaceContact":{"type":"object","properties":{"id":{"type":"integer"},"account_id":{"type":"integer","nullable":true},"country_id":{"type":"integer"},"is_warehouse":{"type":"integer"},"is_billing":{"type":"integer"},"zip":{"type":"string"},"city":{"type":"string"},"address":{"type":"string"},"position_lat":{"type":"number"},"position_lng":{"type":"number"},"phone":{"type":"string"},"email":{"type":"string"},"family_name":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"company_name":{"type":"string"},"dpd_buCode":{"type":"string","nullable":true},"dpd_customerId":{"type":"string","nullable":true},"dpd_addressId":{"type":"string","nullable":true},"deleted_at":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"country":{"$ref":"#/components/schemas/Country"}}},"Country":{"type":"object","properties":{"id":{"type":"integer","description":"Country ID"},"name":{"type":"string","description":"Country name"},"iso":{"type":"string","description":"ISO country code (lowercase)"},"currency_id":{"type":"integer","description":"Currency ID"},"cod_payout_limit":{"type":"number","description":"Cash on delivery payout limit"},"vat":{"type":"number","description":"VAT rate percentage"}}}}}} ``` ## The ProviderPlaceProvider object ```json {"openapi":"3.0.3","info":{"title":"Packli API","version":"3.0.0"},"components":{"schemas":{"ProviderPlaceProvider":{"type":"object","properties":{"id":{"type":"integer"},"name":{"type":"string"},"slug":{"type":"string"},"tracking_link":{"type":"string"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"laravel_through_key":{"type":"integer"}}}}}} ``` ## The ProviderPlaceService object ```json {"openapi":"3.0.3","info":{"title":"Packli API","version":"3.0.0"},"components":{"schemas":{"ProviderPlaceService":{"type":"object","properties":{"id":{"type":"integer"},"provider_id":{"type":"integer"},"country_id":{"type":"integer"},"slug":{"type":"string"},"is_default":{"type":"integer"},"full_address_required":{"type":"integer"},"maximum_weight":{"type":"number"},"supported_sizes":{"type":"string","description":"JSON array of supported sizes"},"is_support_amorf":{"type":"integer"},"is_support_fragile":{"type":"integer"},"is_support_priority":{"type":"integer"}}}}}} ``` ## The PaginationLink object ```json {"openapi":"3.0.3","info":{"title":"Packli API","version":"3.0.0"},"components":{"schemas":{"PaginationLink":{"type":"object","properties":{"url":{"type":"string","nullable":true,"description":"Link URL"},"label":{"type":"string","description":"Link label"},"page":{"type":"integer","nullable":true,"description":"Page number"},"active":{"type":"boolean","description":"Whether this is the current page"}}}}}} ``` ## The ParcelService object ```json {"openapi":"3.0.3","info":{"title":"Packli API","version":"3.0.0"},"components":{"schemas":{"ParcelService":{"type":"object","properties":{"id":{"type":"integer"},"provider_id":{"type":"integer"},"country_id":{"type":"integer"},"slug":{"type":"string"},"is_default":{"type":"integer"},"full_address_required":{"type":"integer"},"maximum_weight":{"type":"number"},"supported_sizes":{"type":"string","description":"JSON array of supported sizes"},"is_support_amorf":{"type":"integer"},"is_support_fragile":{"type":"integer"},"is_support_priority":{"type":"integer"},"provider":{"$ref":"#/components/schemas/Provider"}}},"Provider":{"type":"object","properties":{"id":{"type":"integer","description":"Provider ID"},"name":{"type":"string","description":"Provider name"},"slug":{"type":"string","description":"Provider slug"},"tracking_link":{"type":"string","description":"Tracking link template with %foreign_tracking_id% placeholder"}}}}}} ``` ## The ParcelContact object ```json {"openapi":"3.0.3","info":{"title":"Packli API","version":"3.0.0"},"components":{"schemas":{"ParcelContact":{"type":"object","properties":{"id":{"type":"integer"},"account_id":{"type":"integer"},"country_id":{"type":"integer"},"is_warehouse":{"type":"integer"},"is_billing":{"type":"integer"},"zip":{"type":"string"},"city":{"type":"string"},"address":{"type":"string"},"position_lat":{"type":"number","nullable":true},"position_lng":{"type":"number","nullable":true},"phone":{"type":"string"},"email":{"type":"string"},"family_name":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"company_name":{"type":"string","nullable":true},"dpd_buCode":{"type":"string","nullable":true},"dpd_customerId":{"type":"string","nullable":true},"dpd_addressId":{"type":"string","nullable":true},"deleted_at":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"country":{"$ref":"#/components/schemas/Country"}}},"Country":{"type":"object","properties":{"id":{"type":"integer","description":"Country ID"},"name":{"type":"string","description":"Country name"},"iso":{"type":"string","description":"ISO country code (lowercase)"},"currency_id":{"type":"integer","description":"Currency ID"},"cod_payout_limit":{"type":"number","description":"Cash on delivery payout limit"},"vat":{"type":"number","description":"VAT rate percentage"}}}}}} ``` ## The ParcelStatus object ```json {"openapi":"3.0.3","info":{"title":"Packli API","version":"3.0.0"},"components":{"schemas":{"ParcelStatus":{"type":"object","properties":{"id":{"type":"integer"},"parcel_id":{"type":"integer"},"status_code":{"type":"integer"},"status_description":{"type":"string","nullable":true},"status_date":{"type":"string","format":"date-time"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}}}} ``` ## The ParcelOrder object ```json {"openapi":"3.0.3","info":{"title":"Packli API","version":"3.0.0"},"components":{"schemas":{"ParcelOrder":{"type":"object","properties":{"id":{"type":"integer"},"account_id":{"type":"integer"},"user_id":{"type":"integer"},"deleted_at":{"type":"string","nullable":true},"updated_at":{"type":"string","format":"date-time"},"created_at":{"type":"string","format":"date-time"}}}}}} ``` ## The ParcelCreated object ```json {"openapi":"3.0.3","info":{"title":"Packli API","version":"3.0.0"},"components":{"schemas":{"ParcelCreated":{"type":"object","properties":{"contact_id":{"type":"integer"},"warehouse_id":{"type":"integer"},"place_id":{"type":"integer","nullable":true},"service_id":{"type":"integer"},"account_id":{"type":"integer"},"custom_id":{"type":"string","nullable":true},"weight":{"type":"number"},"size":{"type":"string"},"cod":{"type":"number"},"cod_currency_id":{"type":"integer"},"insurance":{"type":"number"},"insurance_currency_id":{"type":"integer"},"is_fragile":{"type":"boolean"},"customer_note":{"type":"string","nullable":true},"is_priority":{"type":"boolean","nullable":true},"updated_at":{"type":"string","format":"date-time"},"created_at":{"type":"string","format":"date-time"},"id":{"type":"integer"},"is_deleteable":{"type":"boolean"},"is_orderable":{"type":"boolean"},"is_editable":{"type":"boolean"},"is_printable":{"type":"boolean"},"service":{"$ref":"#/components/schemas/ParcelService"},"status":{"$ref":"#/components/schemas/ParcelStatus"}}},"ParcelService":{"type":"object","properties":{"id":{"type":"integer"},"provider_id":{"type":"integer"},"country_id":{"type":"integer"},"slug":{"type":"string"},"is_default":{"type":"integer"},"full_address_required":{"type":"integer"},"maximum_weight":{"type":"number"},"supported_sizes":{"type":"string","description":"JSON array of supported sizes"},"is_support_amorf":{"type":"integer"},"is_support_fragile":{"type":"integer"},"is_support_priority":{"type":"integer"},"provider":{"$ref":"#/components/schemas/Provider"}}},"Provider":{"type":"object","properties":{"id":{"type":"integer","description":"Provider ID"},"name":{"type":"string","description":"Provider name"},"slug":{"type":"string","description":"Provider slug"},"tracking_link":{"type":"string","description":"Tracking link template with %foreign_tracking_id% placeholder"}}},"ParcelStatus":{"type":"object","properties":{"id":{"type":"integer"},"parcel_id":{"type":"integer"},"status_code":{"type":"integer"},"status_description":{"type":"string","nullable":true},"status_date":{"type":"string","format":"date-time"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}}}} ``` ## The ContactList object ```json {"openapi":"3.0.3","info":{"title":"Packli API","version":"3.0.0"},"components":{"schemas":{"ContactList":{"type":"object","properties":{"id":{"type":"integer"},"account_id":{"type":"integer"},"country_id":{"type":"integer"},"is_warehouse":{"type":"integer"},"is_billing":{"type":"integer"},"zip":{"type":"string"},"city":{"type":"string"},"address":{"type":"string"},"position_lat":{"type":"number","nullable":true},"position_lng":{"type":"number","nullable":true},"phone":{"type":"string"},"email":{"type":"string"},"family_name":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"company_name":{"type":"string","nullable":true},"dpd_buCode":{"type":"string","nullable":true},"dpd_customerId":{"type":"string","nullable":true},"dpd_addressId":{"type":"string","nullable":true},"deleted_at":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"country":{"$ref":"#/components/schemas/Country"}}},"Country":{"type":"object","properties":{"id":{"type":"integer","description":"Country ID"},"name":{"type":"string","description":"Country name"},"iso":{"type":"string","description":"ISO country code (lowercase)"},"currency_id":{"type":"integer","description":"Currency ID"},"cod_payout_limit":{"type":"number","description":"Cash on delivery payout limit"},"vat":{"type":"number","description":"VAT rate percentage"}}}}}} ``` ## The ContactCreated object ```json {"openapi":"3.0.3","info":{"title":"Packli API","version":"3.0.0"},"components":{"schemas":{"ContactCreated":{"type":"object","properties":{"id":{"type":"integer"},"account_id":{"type":"integer"},"country_id":{"type":"integer"},"is_warehouse":{"type":"integer"},"is_billing":{"type":"integer"},"zip":{"type":"string"},"city":{"type":"string"},"address":{"type":"string"},"position_lat":{"type":"number","nullable":true},"position_lng":{"type":"number","nullable":true},"phone":{"type":"string"},"email":{"type":"string"},"family_name":{"type":"string","nullable":true},"first_name":{"type":"string","nullable":true},"company_name":{"type":"string","nullable":true},"dpd_buCode":{"type":"string","nullable":true},"dpd_customerId":{"type":"string","nullable":true},"dpd_addressId":{"type":"string","nullable":true},"deleted_at":{"type":"string","nullable":true},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"},"country":{"$ref":"#/components/schemas/Country"}}},"Country":{"type":"object","properties":{"id":{"type":"integer","description":"Country ID"},"name":{"type":"string","description":"Country name"},"iso":{"type":"string","description":"ISO country code (lowercase)"},"currency_id":{"type":"integer","description":"Currency ID"},"cod_payout_limit":{"type":"number","description":"Cash on delivery payout limit"},"vat":{"type":"number","description":"VAT rate percentage"}}}}}} ``` ## The Currency object ```json {"openapi":"3.0.3","info":{"title":"Packli API","version":"3.0.0"},"components":{"schemas":{"Currency":{"type":"object","properties":{"id":{"type":"integer","description":"Currency ID"},"name":{"type":"string","description":"Currency name"},"short_text":{"type":"string","description":"Currency short code"},"symbol":{"type":"string","description":"Currency symbol"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time"}}}}}} ``` ## The PaginationMeta object ```json {"openapi":"3.0.3","info":{"title":"Packli API","version":"3.0.0"},"components":{"schemas":{"PaginationMeta":{"type":"object","properties":{"current_page":{"type":"integer","description":"Current page number"},"from":{"type":"integer","description":"First item number on current page"},"last_page":{"type":"integer","description":"Last page number"},"per_page":{"type":"integer","description":"Items per page"},"to":{"type":"integer","description":"Last item number on current page"},"total":{"type":"integer","description":"Total number of items"}}}}}} ``` ## The PaginationLinks object ```json {"openapi":"3.0.3","info":{"title":"Packli API","version":"3.0.0"},"components":{"schemas":{"PaginationLinks":{"type":"object","properties":{"first":{"type":"string","description":"Link to first page"},"last":{"type":"string","description":"Link to last page"},"prev":{"type":"string","nullable":true,"description":"Link to previous page"},"next":{"type":"string","nullable":true,"description":"Link to next page"}}}}}} ``` ## The ErrorResponse object ```json {"openapi":"3.0.3","info":{"title":"Packli API","version":"3.0.0"},"components":{"schemas":{"ErrorResponse":{"type":"object","properties":{"message":{"type":"string","description":"Error message"},"errors":{"type":"object","description":"Validation errors","additionalProperties":{"type":"array","items":{"type":"string"}}}}}}}} ``` --- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.packli.hu/api-integracio/models.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.