# OfferPackage

## Retrieves the collection of OfferPackage resources.

> The group parameter can be use to load additional data. Use 'groups\[]=translation' to load translations as well.

```json
{"openapi":"3.0.0","info":{"title":"Converia API","version":"3.5.0"},"servers":[{"url":"/","description":""}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"OfferPackage.OfferPackageDTO.jsonld-offer-package.read_translation":{"type":"object","description":"Package","properties":{"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"id":{"type":"integer"},"name":{"type":"string"},"nameTranslations":{"description":"Array of translation objects containing the field translations in all available languages. Not loaded by default, see translation.","type":"array","items":{"$ref":"#/components/schemas/Translation.TranslationDTO.jsonld-offer-package.read_translation"}},"descriptionTranslations":{"description":"Array of translation objects containing the field translations in all available languages. Not loaded by default, see translation.","type":"array","items":{"$ref":"#/components/schemas/Translation.TranslationDTO.jsonld-offer-package.read_translation"}},"frame":{"type":"string","format":"iri-reference"},"category":{"type":"string","format":"iri-reference","nullable":true},"type":{"$ref":"#/components/schemas/OfferPackageTypes","type":"string"},"activityType":{"type":"string","format":"iri-reference","nullable":true},"reverseChargeApplicable":{"$ref":"#/components/schemas/ReverseChargeApplicable","type":"string"},"isSoldByThirdParty":{"type":"boolean"}}},"Translation.TranslationDTO.jsonld-offer-package.read_translation":{"type":"object","description":"Translation","properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"language":{"type":"string","format":"iri-reference"},"content":{"type":"string"}}},"OfferPackageTypes":{"type":"string","enum":["OPKGKIND_NORM","OPKGKIND_CHILD","OPKGKIND_CANCELED"]},"ReverseChargeApplicable":{"type":"string","enum":["inherit","no","yes"]},"OfferPackage.OfferPackageDTO-offer-package.read_translation":{"type":"object","description":"Package","properties":{"id":{"type":"integer"},"name":{"type":"string"},"nameTranslations":{"description":"Array of translation objects containing the field translations in all available languages. Not loaded by default, see translation.","type":"array","items":{"$ref":"#/components/schemas/Translation.TranslationDTO-offer-package.read_translation"}},"descriptionTranslations":{"description":"Array of translation objects containing the field translations in all available languages. Not loaded by default, see translation.","type":"array","items":{"$ref":"#/components/schemas/Translation.TranslationDTO-offer-package.read_translation"}},"frame":{"type":"string","format":"iri-reference"},"category":{"type":"string","format":"iri-reference","nullable":true},"type":{"$ref":"#/components/schemas/OfferPackageTypes","type":"string"},"activityType":{"type":"string","format":"iri-reference","nullable":true},"reverseChargeApplicable":{"$ref":"#/components/schemas/ReverseChargeApplicable","type":"string"},"isSoldByThirdParty":{"type":"boolean"}}},"Translation.TranslationDTO-offer-package.read_translation":{"type":"object","description":"Translation","properties":{"language":{"type":"string","format":"iri-reference"},"content":{"type":"string"}}}}},"paths":{"/api/offer_packages":{"get":{"operationId":"getOfferPackageCollection","tags":["OfferPackage"],"responses":{"200":{"description":"OfferPackage collection","content":{"application/ld+json":{"schema":{"type":"object","properties":{"hydra:member":{"type":"array","items":{"$ref":"#/components/schemas/OfferPackage.OfferPackageDTO.jsonld-offer-package.read_translation"}},"hydra:totalItems":{"type":"integer","minimum":0},"hydra:view":{"type":"object","properties":{"@id":{"type":"string","format":"iri-reference"},"@type":{"type":"string"},"hydra:first":{"type":"string","format":"iri-reference"},"hydra:last":{"type":"string","format":"iri-reference"},"hydra:previous":{"type":"string","format":"iri-reference"},"hydra:next":{"type":"string","format":"iri-reference"}}},"hydra:search":{"type":"object","properties":{"@type":{"type":"string"},"hydra:template":{"type":"string"},"hydra:variableRepresentation":{"type":"string"},"hydra:mapping":{"type":"array","items":{"type":"object","properties":{"@type":{"type":"string"},"variable":{"type":"string"},"property":{"type":"string","nullable":true},"required":{"type":"boolean"}}}}}}},"required":["hydra:member"]}},"text/html":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/OfferPackage.OfferPackageDTO-offer-package.read_translation"}}}}}},"summary":"Retrieves the collection of OfferPackage resources.","description":"The group parameter can be use to load additional data. Use 'groups[]=translation' to load translations as well.","parameters":[{"name":"id[between]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false},{"name":"id[gt]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false},{"name":"id[gte]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false},{"name":"id[lt]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false},{"name":"id[lte]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"string"},"style":"form","explode":false,"allowReserved":false},{"name":"groups[]","in":"query","description":"","required":false,"deprecated":false,"allowEmptyValue":true,"schema":{"type":"array","items":{"type":"string"}},"style":"form","explode":true,"allowReserved":false}],"deprecated":false}}}}
```

## Retrieves a OfferPackage resource.

> The group parameter can be use to load additional data. Use 'groups\[]=translation' to load translations as well.

```json
{"openapi":"3.0.0","info":{"title":"Converia API","version":"3.5.0"},"servers":[{"url":"/","description":""}],"security":[{"bearerAuth":[]}],"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer"}},"schemas":{"OfferPackage.OfferPackageDTO.jsonld-offer-package.read_translation":{"type":"object","description":"Package","properties":{"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"id":{"type":"integer"},"name":{"type":"string"},"nameTranslations":{"description":"Array of translation objects containing the field translations in all available languages. Not loaded by default, see translation.","type":"array","items":{"$ref":"#/components/schemas/Translation.TranslationDTO.jsonld-offer-package.read_translation"}},"descriptionTranslations":{"description":"Array of translation objects containing the field translations in all available languages. Not loaded by default, see translation.","type":"array","items":{"$ref":"#/components/schemas/Translation.TranslationDTO.jsonld-offer-package.read_translation"}},"frame":{"type":"string","format":"iri-reference"},"category":{"type":"string","format":"iri-reference","nullable":true},"type":{"$ref":"#/components/schemas/OfferPackageTypes","type":"string"},"activityType":{"type":"string","format":"iri-reference","nullable":true},"reverseChargeApplicable":{"$ref":"#/components/schemas/ReverseChargeApplicable","type":"string"},"isSoldByThirdParty":{"type":"boolean"}}},"Translation.TranslationDTO.jsonld-offer-package.read_translation":{"type":"object","description":"Translation","properties":{"@context":{"readOnly":true,"oneOf":[{"type":"string"},{"type":"object","properties":{"@vocab":{"type":"string"},"hydra":{"type":"string","enum":["http://www.w3.org/ns/hydra/core#"]}},"required":["@vocab","hydra"],"additionalProperties":true}]},"@id":{"readOnly":true,"type":"string"},"@type":{"readOnly":true,"type":"string"},"language":{"type":"string","format":"iri-reference"},"content":{"type":"string"}}},"OfferPackageTypes":{"type":"string","enum":["OPKGKIND_NORM","OPKGKIND_CHILD","OPKGKIND_CANCELED"]},"ReverseChargeApplicable":{"type":"string","enum":["inherit","no","yes"]},"OfferPackage.OfferPackageDTO-offer-package.read_translation":{"type":"object","description":"Package","properties":{"id":{"type":"integer"},"name":{"type":"string"},"nameTranslations":{"description":"Array of translation objects containing the field translations in all available languages. Not loaded by default, see translation.","type":"array","items":{"$ref":"#/components/schemas/Translation.TranslationDTO-offer-package.read_translation"}},"descriptionTranslations":{"description":"Array of translation objects containing the field translations in all available languages. Not loaded by default, see translation.","type":"array","items":{"$ref":"#/components/schemas/Translation.TranslationDTO-offer-package.read_translation"}},"frame":{"type":"string","format":"iri-reference"},"category":{"type":"string","format":"iri-reference","nullable":true},"type":{"$ref":"#/components/schemas/OfferPackageTypes","type":"string"},"activityType":{"type":"string","format":"iri-reference","nullable":true},"reverseChargeApplicable":{"$ref":"#/components/schemas/ReverseChargeApplicable","type":"string"},"isSoldByThirdParty":{"type":"boolean"}}},"Translation.TranslationDTO-offer-package.read_translation":{"type":"object","description":"Translation","properties":{"language":{"type":"string","format":"iri-reference"},"content":{"type":"string"}}}}},"paths":{"/api/offer_packages/{id}":{"get":{"operationId":"getOfferPackageItem","tags":["OfferPackage"],"responses":{"200":{"description":"OfferPackage resource","content":{"application/ld+json":{"schema":{"$ref":"#/components/schemas/OfferPackage.OfferPackageDTO.jsonld-offer-package.read_translation"}},"text/html":{"schema":{"$ref":"#/components/schemas/OfferPackage.OfferPackageDTO-offer-package.read_translation"}}}},"404":{"description":"Resource not found"}},"summary":"Retrieves a OfferPackage resource.","description":"The group parameter can be use to load additional data. Use 'groups[]=translation' to load translations as well.","parameters":[{"name":"id","in":"path","description":"Resource identifier","required":true,"deprecated":false,"allowEmptyValue":false,"schema":{"type":"string"},"style":"simple","explode":false,"allowReserved":false}],"deprecated":false}}}}
```