REST API DOCUMENTATION
  • Show/hide List Operations Expand Operations

    Accessory

    • /api/product-offers/{productId}/accessories-groups
        • GET /api/product-offers/{productId}/accessories-groups dev

          • Get all accessories group
          • Documentation
          • Sandbox

          Requirements

          Name Requirement Type Description
          productId \d+ integer Product identifier

          Headers

          Name Required? Description
          Accept true Required header + version
          Content-Type true
          Authorization true Authentication & Authorization

          Return

          Parameter Type Versions Description

          200 - OK

          [] array of objects (AccessoryGroupDTO) *
          [][id] custom handler result for (int) >=1.0
          [][name] string >=1.0
          [][type] string >=1.0
          [][product_id] custom handler result for (int) >=1.0

          Status Codes

          Status Code Description
          200
          • OK
          400
          • Validation failed
          401
          • Unauthorized
          404
          • Not found
          Input

          Requirements

          = -

          Headers

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/product-offers/{productId}/accessories-groups/{groupId}
        • GET /api/product-offers/{productId}/accessories-groups/{groupId} dev

          • Get accessory group data
          • Documentation
          • Sandbox

          Requirements

          Name Requirement Type Description
          productId \d+ integer Product identifier
          groupId \d+ integer Accessory group identifier

          Headers

          Name Required? Description
          Accept true Required header + version
          Content-Type true
          Authorization true Authentication & Authorization

          Return

          Parameter Type Versions Description

          200 - OK

          id custom handler result for (int) >=1.0
          name string >=1.0
          type string >=1.0
          product_id custom handler result for (int) >=1.0

          Status Codes

          Status Code Description
          200
          • OK
          400
          • Validation failed
          401
          • Unauthorized
          404
          • Not found
          Input

          Requirements

          = -

          = -

          Headers

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/product-offers/{productId}/accessories-groups/{groupId}/accessories
        • GET /api/product-offers/{productId}/accessories-groups/{groupId}/accessories dev

          • Get accessory from group
          • Documentation
          • Sandbox

          Requirements

          Name Requirement Type Description
          productId \d+ integer Product identifier
          groupId \d+ integer Accessory group identifier

          Headers

          Name Required? Description
          Accept true Required header + version
          Content-Type true
          Authorization true Authentication & Authorization

          Return

          Parameter Type Versions Description

          200 - OK

          [] array of objects (ProductOfferDTO) *
          [][id] integer >=1.0
          [][name] string >=1.0
          [][product_id] integer >=1.0
          [][product_parent_id] integer >=1.0
          [][stock_shop] integer >=1.0
          [][stock_shipment] integer >=1.0
          [][availability] object (ProductAvailabilityDTO) >=1.0
          [][availability][id] integer >=1.0
          [][availability][name] string >=1.0
          [][availability][display_name] string >=1.0
          [][availability][display_name_operator] string >=1.0
          [][availability][description] string >=1.0
          [][availability][description_details] string >=1.0
          [][availability][color_hash] string >=1.0
          [][availability][icon] string >=1.0
          [][availability][weight] custom handler result for (int) >=1.0
          [][availability][is_default] custom handler result for (bool) >=1.0
          [][availability][type] string >=1.0
          [][add_to_cart] boolean >=1.0
          [][add_to_cart_link] string >=1.0
          [][price_gross] integer >=1.0
          [][price_net] integer >=1.0
          [][club_price] integer >=1.0
          [][discount] object (PriceModifierDiscountDTO) >=1.0
          [][discount][value] custom handler result for (Enp\Bundle\CoreBundle\Model\MoneyInterface) >=1.0
          [][discount][old_price] custom handler result for (Enp\Bundle\CoreBundle\Model\MoneyInterface) >=1.0
          [][discount][date_time_start] DateTime >=1.0
          [][discount][date_time_end] DateTime >=1.0
          [][promo_price_gross] integer >=1.0
          [][promo_price_net] integer >=1.0
          [][link] string >=1.0
          [][gallery] array >=1.0
          [][gallery_thumbnails][] array of arrays >=1.0
          [][emblems][] array of objects (EmblemDTO) >=1.0
          [][emblems][][id] integer >=1.0
          [][emblems][][name] string >=1.0
          [][emblems][][place] string >=1.0
          [][emblems][][zone] string >=1.0
          [][emblems][][content] string >=1.0
          [][emblems][][raw] string >=1.0
          [][emblems][][raw_content] string >=1.0
          [][emblems][][raw_tooltip] string >=1.0
          [][emblems][][deeplink] string >=1.0
          [][emblems][][url] string >=1.0
          [][emblems][][tooltip] string >=1.0
          [][emblems][][discount] string >=1.0
          [][emblems][][gtm_name_ads] string >=1.0
          [][emblems][][gtm_position_ads] string >=1.0
          [][categories][] array of objects (CategoryDTO) >=1.0
          [][categories][][id] integer >=1.0
          [][categories][][name] string >=1.0
          [][categories][][main_category] custom handler result for (bool) >=1.0
          [][system_attributes][] array of objects (AttributeDTO) >=1.0
          [][system_attributes][][id] custom handler result for (int) >=1.0
          [][system_attributes][][name] string >=1.0
          [][system_attributes][][is_hint_long] custom handler result for (bool) >=1.0
          [][system_attributes][][values] array >=1.0
          [][system_attributes][][original_name] string >=1.0
          [][system_attributes][][extended_values] array >=1.0
          [][system_attributes][][validation_type] string >=1.0
          [][unassigned_attributes][] array of objects (AttributeDTO) >=1.0
          [][key_attributes][] array of objects (AttributeDTO) >=1.0
          [][menu_item_attributes][] array of objects (AttributeDTO) >=1.0
          [][specification][] array of objects (PropertyDTO) >=1.0
          [][specification][][name] string >=1.0
          [][specification][][attributes][] array of objects (AttributeDTO) >=1.0
          [][is_product_set] boolean >=1.0
          [][attribute_settings] array >=1.0
          [][description] string >=1.0
          [][variants][] array of objects (VariantDTO) >=1.0
          [][variants][][label] string >=1.0
          [][variants][][display_method] string >=1.0
          [][variants][][hide_single_value] custom handler result for (bool) >=1.0
          [][variants][][offers][] array of objects (VariantProductOfferDTO) >=1.0
          [][variants][][offers][][id] integer >=1.0
          [][variants][][offers][][name] string >=1.0
          [][variants][][offers][][price_gross] integer >=1.0
          [][variants][][offers][][price_net] integer >=1.0
          [][variants][][offers][][club_price] integer >=1.0
          [][variants][][offers][][discount] object (PriceModifierDiscountDTO) >=1.0
          [][variants][][offers][][_embedded[promoPrice]] object (PromoPriceDTO) >=1.0
          [][variants][][offers][][_embedded[promoPrice]][campaign_id] integer >=1.0
          [][variants][][offers][][_embedded[promoPrice]][action_id] integer >=1.0
          [][variants][][offers][][_embedded[promoPrice]][show_new_price] boolean >=1.0
          [][variants][][offers][][_embedded[promoPrice]][show_old_price] boolean >=1.0
          [][variants][][offers][][_embedded[promoPrice]][club_price] integer >=1.0
          [][variants][][offers][][_embedded[promoPrice]][for_action_price] integer >=1.0
          [][variants][][offers][][_embedded[promoPrice]][for_action_campaign_id] custom handler result for (int) >=1.0
          [][variants][][offers][][_embedded[promoPrice]][for_action_code] string >=1.0
          [][variants][][offers][][_embedded[promoPrice]][new_price] integer >=1.0
          [][variants][][offers][][_embedded[promoPrice]][new_price_net] integer >=1.0
          [][variants][][offers][][_embedded[promoPrice]][old_price] integer >=1.0
          [][variants][][offers][][_embedded[promoPrice]][discount_info_collection] array >=1.0
          [][variants][][offers][][_embedded[promoPrice]][discount_info_basic_collection] array >=1.0
          [][variants][][offers][][_embedded[promoPrice]][product_price] integer >=1.0
          [][variants][][offers][][_embedded[promoPrice]][date_from] string >=1.0
          [][variants][][offers][][_embedded[promoPrice]][date_to] string >=1.0
          [][variants][][offers][][promo_price_gross] integer >=1.0
          [][variants][][offers][][promo_price_net] integer >=1.0
          [][variants][][offers][][product_id] integer >=1.0
          [][variants][][offers][][product_parent_id] integer >=1.0
          [][variants][][offers][][link] string >=1.0
          [][variants][][offers][][gallery] array >=1.0
          [][variants][][offers][][availability] object (ProductAvailabilityDTO) >=1.0
          [][variants][][color] string >=1.0
          [][variants][][size_offers] custom handler result for (ArrayCollection) >=1.0
          [][published_date] string >=1.0
          [][template] object (TemplateDTO) >=1.0
          [][template][id] integer >=1.0
          [][template][name] string >=1.0
          [][template][template_type] string >=1.0
          [][_embedded[opinionsAverage]] object (ProductOpinionAverageDTO) >=1.0
          [][_embedded[opinionsAverage]][product_id] integer >=1.0
          [][_embedded[opinionsAverage]][average] float >=1.0
          [][_embedded[opinionsAverage]][count] integer >=1.0
          [][switches][] array of objects (bool) >=1.0
          [][flags][] array of objects (bool) >=1.0
          [][_embedded[postscripts]][] array of objects (PostscriptDTO) >=1.0
          [][_embedded[postscripts]][][id] integer >=1.0
          [][_embedded[postscripts]][][name] string >=1.0
          [][_embedded[postscripts]][][url] string >=1.0
          [][_embedded[postscripts]][][display_price_strategy] custom handler result for (int) >=1.0
          [][_embedded[postscripts]][][tooltip] string >=1.0
          [][_embedded[postscripts]][][place] string >=1.0
          [][_embedded[postscripts]][][zone] string >=1.0
          [][_embedded[postscripts]][][gtm_position] string >=1.0
          [][_embedded[postscripts]][][gtm_name] string >=1.0
          [][_embedded[promoPrice]] object (PromoPriceDTO) >=1.0
          [][_embedded[promoPrice]][campaign_id] integer >=1.0
          [][_embedded[promoPrice]][action_id] integer >=1.0
          [][_embedded[promoPrice]][show_new_price] boolean >=1.0
          [][_embedded[promoPrice]][show_old_price] boolean >=1.0
          [][_embedded[promoPrice]][club_price] integer >=1.0
          [][_embedded[promoPrice]][for_action_price] integer >=1.0
          [][_embedded[promoPrice]][for_action_campaign_id] custom handler result for (int) >=1.0
          [][_embedded[promoPrice]][for_action_code] string >=1.0
          [][_embedded[promoPrice]][new_price] integer >=1.0
          [][_embedded[promoPrice]][new_price_net] integer >=1.0
          [][_embedded[promoPrice]][old_price] integer >=1.0
          [][_embedded[promoPrice]][discount_info_collection] array >=1.0
          [][_embedded[promoPrice]][discount_info_basic_collection] array >=1.0
          [][_embedded[promoPrice]][product_price] integer >=1.0
          [][_embedded[promoPrice]][date_from] string >=1.0
          [][_embedded[promoPrice]][date_to] string >=1.0
          [][_embedded[relations]] custom handler result for (Enp\Bundle\Api\ProductOfferBundle\DTO\Versions\V1) >=1.0
          [][_embedded[quality]] custom handler result for (Enp\Bundle\Api\ProductOfferBundle\DTO\Versions\V1) >=1.0
          [][type] string >=1.0
          [][service_type] string >=1.0
          [][internal_code] string >=1.0
          [][_embedded[services]] array >=1.0
          [][_embedded[bestPaymentBankOffer]] object (BestPaymentBankOffersDTO) >=1.0
          [][_embedded[bestPaymentBankOffer]][installments_number] integer >=1.0
          [][_embedded[bestPaymentBankOffer]][interest_on_loan] float >=1.0
          [][_embedded[bestPaymentBankOffer]][display_strategy] integer >=1.0
          [][_embedded[bestPaymentBankOffer]][general_information] string >=1.0
          [][_embedded[bestPaymentBankOffer]][installment_amount] custom handler result for (Enp\Bundle\CoreBundle\Model\MoneyInterface) >=1.0
          [][_embedded[hotDeals]][] array of objects (HotDealDTO) >=1.0
          [][_embedded[hotDeals]][][quantity_promoted] custom handler result for (int) >=1.0
          [][_embedded[hotDeals]][][remaining_quantity] custom handler result for (int) >=1.0
          [][_embedded[hotDeals]][][promotion_name] string >=1.0
          [][other_prices][] array of objects (OtherPriceDTO) >=1.0
          [][other_prices][][type] string >=1.0
          [][other_prices][][gross] integer >=1.0
          [][other_prices][][net] integer >=1.0
          [][auto_text] array >=1.0

          Status Codes

          Status Code Description
          200
          • OK
          400
          • Validation failed
          401
          • Unauthorized
          404
          • Not found
          Input

          Requirements

          = -

          = -

          Headers

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
  • Show/hide List Operations Expand Operations

    AdServer

    • /api/{domain}
        • GET /api/{domain} deprecated

          • Return ad list
          • Documentation
          • Sandbox

          Requirements

          Name Requirement Type Description
          domain (ad|announcements)

          Filters

          Name Information
          place
          Datatype integer
          Description Ad place id
          Required false
          zone
          Datatype string
          Description Ad zone id
          Required false

          Parameters

          Parameter Type Required? Format Description
          sort string false ?(-)field_name Sorting by field name. Prepend with - to sort descending. Available sort fields: order, place, zone

          Headers

          Name Required? Description
          Accept true Required header + version
          Authorization true Authentication & Authorization
          Content-Type true Content type
          Pagination-Page true Page number
          Pagination-Limit true Limit of elements
          Content-Website true Set website in api

          Return

          Parameter Type Versions Description

          200 - OK

          [] array of objects (AdDTO) *
          [][id] integer >=1.0
          [][place] integer >=1.0
          [][zone] integer >=1.0
          [][content] string >=1.0
          [][raw] string >=1.0
          [][content_images] array >=1.0
          [][order] integer >=1.0
          [][widget_configuration] array >=1.0
          [][gtm_position] string >=1.0
          [][gtm_name] string >=1.0

          Status Codes

          Status Code Description
          200
          • OK
          400
          • Bad request
          401
          • Unauthorized
          403
          • Forbidden
          Input

          Requirements

          = -

          Filters

          = -

          = -

          Parameters

          = -

          Headers

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/{domain}/list
        • GET /api/{domain}/list stable

          • Return ad list
          • Documentation
          • Sandbox

          Requirements

          Name Requirement Type Description
          domain (ad|announcements)

          Filters

          Name Information
          place
          Datatype string
          Description Ad place type
          Required false
          zone
          Datatype string
          Description Ad zone type
          Required false
          places
          Datatype array
          Description Ad places types
          Required false
          zones
          Datatype array
          Description Ad zones aliases
          Required false
          menuItems
          Datatype array
          Description Menu item id
          Required false
          offerId
          Datatype integer
          Description product offer id
          Required false
          include_uncategorized
          Datatype boolean
          Description Include in result adserver without assigned specific menu item
          Required false
          search_term
          Datatype string
          Description Finds adservers with given search_term condition
          Required false

          Headers

          Name Required? Description
          Accept true Required header + version
          Authorization true Authentication & Authorization
          Content-Type true Content type
          Pagination-Page true Page number
          Pagination-Limit true Limit of elements
          Content-Website true Set website in api

          Return

          Parameter Type Versions Description

          200 - OK

          [] array of objects (AdServerDTO) *
          [][id] integer >=1.0
          [][place] string >=1.0
          [][name] string >=1.0
          [][zone] string >=1.0
          [][content] string >=1.0
          [][raw] string >=1.0
          [][content_images] array >=1.0
          [][link] string >=1.0
          [][order] integer >=1.0
          [][menu_items] array >=1.0
          [][widget_configuration] array >=1.0
          [][gtm_position] string >=1.0
          [][gtm_name] string >=1.0
          [][tooltip] string >=1.0

          Status Codes

          Status Code Description
          200
          • OK
          400
          • Bad request
          401
          • Unauthorized
          Input

          Requirements

          = -

          Filters

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          Headers

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/{domain}/places
        • GET /api/{domain}/places dev

          • Return ad server place list
          • Documentation
          • Sandbox

          Requirements

          Name Requirement Type Description
          domain (ad|announcements)

          Filters

          Name Information
          id
          Datatype integer
          Description Place id
          Required false
          system_name
          Datatype string
          Description Place system name
          Required false

          Parameters

          Parameter Type Required? Format Description
          sort string false ?(-)field_name Sorting by field name. Prepend with - to sort descending. Available sort fields: id, system_name

          Headers

          Name Required? Description
          Accept true Required header + version
          Authorization true Authentication & Authorization
          Content-Type true Content type
          Pagination-Page true Page number
          Pagination-Limit true Limit of elements
          Content-Website true Sets website in api

          Return

          Parameter Type Versions Description

          200 - OK

          [] array of objects (PlaceDTO) *
          [][id] integer >=1.0
          [][name] string >=1.0
          [][system_name] string >=1.0

          Status Codes

          Status Code Description
          200
          • OK
          400
          • Bad request
          401
          • Unauthorized
          Input

          Requirements

          = -

          Filters

          = -

          = -

          Parameters

          = -

          Headers

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/{domain}/places/{slug}/zones
        • GET /api/{domain}/places/{slug}/zones dev

          • Return ad server zone list in selected place
          • Documentation
          • Sandbox

          Requirements

          Name Requirement Type Description
          slug \d+ integer Place identifier from /ad/places resource
          domain (ad|announcements)

          Filters

          Name Information
          id
          Datatype integer
          Description Zone id
          Required false
          system_name
          Datatype string
          Description Zone system name
          Required false

          Parameters

          Parameter Type Required? Format Description
          sort string false ?(-)field_name Sorting by field name. Prepend with - to sort descending. Available sort fields: id, system_name

          Headers

          Name Required? Description
          Accept true Required header + version
          Authorization true Authentication & Authorization
          Content-Type true Content type
          Pagination-Page true Page number
          Pagination-Limit true Limit of elements
          Content-Website true Sets website in api

          Return

          Parameter Type Versions Description

          200 - OK

          [] array of objects (ZoneDTO) *
          [][id] integer >=1.0
          [][name] string >=1.0
          [][system_name] string >=1.0
          [][width] integer >=1.0
          [][height] integer >=1.0

          Status Codes

          Status Code Description
          200
          • OK
          400
          • Bad request
          401
          • Unauthorized
          403
          • Forbidden
          404
          • Not found
          Input

          Requirements

          = -

          = -

          Filters

          = -

          = -

          Parameters

          = -

          Headers

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/{domain}/{slug}
        • GET /api/{domain}/{slug} dev

          • Return ad item
          • Documentation
          • Sandbox

          Requirements

          Name Requirement Type Description
          slug \d+ integer Ad identifier from /ad resource
          domain (ad|announcements)

          Headers

          Name Required? Description
          Accept true Required header + version
          Authorization true Authentication & Authorization
          Content-Type true Content type
          Content-Website true Sets website in api

          Return

          Parameter Type Versions Description

          200 - OK

          id integer >=1.0
          place integer >=1.0
          zone integer >=1.0
          content string >=1.0
          raw string >=1.0
          content_images array >=1.0
          order integer >=1.0
          widget_configuration array >=1.0
          gtm_position string >=1.0
          gtm_name string >=1.0

          Status Codes

          Status Code Description
          200
          • OK
          400
          • Bad request
          401
          • Unauthorized
          403
          • Forbidden
          404
          • Not found
          Input

          Requirements

          = -

          = -

          Headers

          = -

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
  • Show/hide List Operations Expand Operations

    Allegro

    • /api/allegro/account/{slug}
        • GET /api/allegro/account/{slug} dev

          • Returns data for specified Allegro account
          • Documentation
          • Sandbox

          Requirements

          Name Requirement Type Description
          slug \s+ string Account identifier

          Headers

          Name Required? Description
          Accept true Required header + version
          Content-Type true
          Authorization true Authentication & Authorization

          Return

          Parameter Type Versions Description

          200 - OK

          Status Codes

          Status Code Description
          200
          • OK
          400
          • Validation failed
          401
          • Unauthorized
          403
          • Forbidden
          404
          • Not found
          Input

          Requirements

          = -

          Headers

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/allegro/orders/{login}/{number}
        • GET /api/allegro/orders/{login}/{number} dev

          • Returns orders list
          • Documentation
          • Sandbox

          Requirements

          Name Requirement Type Description
          login \s+ string Allegro login
          number \s+ string Allegro order number

          Headers

          Name Required? Description
          Accept true Required header + version
          Content-Type true
          Content-Website true Sets website in api
          Authorization true Authentication & Authorization

          Return

          Parameter Type Versions Description

          200 - OK

          Status Codes

          Status Code Description
          200
          • OK
          400
          • Validation failed
          401
          • Unauthorized
          404
          • Not found
          Input

          Requirements

          = -

          = -

          Headers

          = -

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/allegro/products/{login}/{number}/order-numbers/{orderNumber}
        • GET /api/allegro/products/{login}/{number}/order-numbers/{orderNumber} dev

          • Returns products by order number
          • Documentation
          • Sandbox

          Requirements

          Name Requirement Type Description
          login \s+ string Allegro login
          number \s+ string Allegro order number
          orderNumber \s+ string Adafir order number

          Headers

          Name Required? Description
          Accept true Required header + version
          Content-Type true
          Authorization true Authentication & Authorization

          Return

          Parameter Type Versions Description

          200 - OK

          Status Codes

          Status Code Description
          200
          • OK
          400
          • Validation failed
          401
          • Unauthorized
          404
          • Not found
          Input

          Requirements

          = -

          = -

          = -

          Headers

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
  • Show/hide List Operations Expand Operations

    Archival Product Recommendation

    • /api/archival/products/recommendations/{slug}
        • GET /api/archival/products/recommendations/{slug} dev

          • Return recommendation list of product for archival product
          • Documentation
          • Sandbox

          Documentation

          Module to return recommended products

          Requirements

          Name Requirement Type Description
          slug \d+ int

          Headers

          Name Required? Description
          Accept true Required header + version
          Content-Type true
          Authorization true Authentication & Authorization
          Pagination-Limit true Limit for recommendation elements
          Content-Website true Sets website in api

          Return

          Parameter Type Versions Description

          200 - OK

          [] array of objects (ProductOfferDTO) *
          [][id] integer >=1.0
          [][name] string >=1.0
          [][product_id] integer >=1.0
          [][product_parent_id] integer >=1.0
          [][stock_shop] integer >=1.0
          [][stock_shipment] integer >=1.0
          [][availability] object (ProductAvailabilityDTO) >=1.0
          [][availability][id] integer >=1.0
          [][availability][name] string >=1.0
          [][availability][display_name] string >=1.0
          [][availability][display_name_operator] string >=1.0
          [][availability][description] string >=1.0
          [][availability][description_details] string >=1.0
          [][availability][color_hash] string >=1.0
          [][availability][icon] string >=1.0
          [][availability][weight] custom handler result for (int) >=1.0
          [][availability][is_default] custom handler result for (bool) >=1.0
          [][availability][type] string >=1.0
          [][add_to_cart] boolean >=1.0
          [][add_to_cart_link] string >=1.0
          [][price_gross] integer >=1.0
          [][price_net] integer >=1.0
          [][club_price] integer >=1.0
          [][discount] object (PriceModifierDiscountDTO) >=1.0
          [][discount][value] custom handler result for (Enp\Bundle\CoreBundle\Model\MoneyInterface) >=1.0
          [][discount][old_price] custom handler result for (Enp\Bundle\CoreBundle\Model\MoneyInterface) >=1.0
          [][discount][date_time_start] DateTime >=1.0
          [][discount][date_time_end] DateTime >=1.0
          [][promo_price_gross] integer >=1.0
          [][promo_price_net] integer >=1.0
          [][link] string >=1.0
          [][gallery] array >=1.0
          [][gallery_thumbnails][] array of arrays >=1.0
          [][emblems][] array of objects (EmblemDTO) >=1.0
          [][emblems][][id] integer >=1.0
          [][emblems][][name] string >=1.0
          [][emblems][][place] string >=1.0
          [][emblems][][zone] string >=1.0
          [][emblems][][content] string >=1.0
          [][emblems][][raw] string >=1.0
          [][emblems][][raw_content] string >=1.0
          [][emblems][][raw_tooltip] string >=1.0
          [][emblems][][deeplink] string >=1.0
          [][emblems][][url] string >=1.0
          [][emblems][][tooltip] string >=1.0
          [][emblems][][discount] string >=1.0
          [][emblems][][gtm_name_ads] string >=1.0
          [][emblems][][gtm_position_ads] string >=1.0
          [][categories][] array of objects (CategoryDTO) >=1.0
          [][categories][][id] integer >=1.0
          [][categories][][name] string >=1.0
          [][categories][][main_category] custom handler result for (bool) >=1.0
          [][system_attributes][] array of objects (AttributeDTO) >=1.0
          [][system_attributes][][id] custom handler result for (int) >=1.0
          [][system_attributes][][name] string >=1.0
          [][system_attributes][][is_hint_long] custom handler result for (bool) >=1.0
          [][system_attributes][][values] array >=1.0
          [][system_attributes][][original_name] string >=1.0
          [][system_attributes][][extended_values] array >=1.0
          [][system_attributes][][validation_type] string >=1.0
          [][unassigned_attributes][] array of objects (AttributeDTO) >=1.0
          [][key_attributes][] array of objects (AttributeDTO) >=1.0
          [][menu_item_attributes][] array of objects (AttributeDTO) >=1.0
          [][specification][] array of objects (PropertyDTO) >=1.0
          [][specification][][name] string >=1.0
          [][specification][][attributes][] array of objects (AttributeDTO) >=1.0
          [][is_product_set] boolean >=1.0
          [][attribute_settings] array >=1.0
          [][description] string >=1.0
          [][variants][] array of objects (VariantDTO) >=1.0
          [][variants][][label] string >=1.0
          [][variants][][display_method] string >=1.0
          [][variants][][hide_single_value] custom handler result for (bool) >=1.0
          [][variants][][offers][] array of objects (VariantProductOfferDTO) >=1.0
          [][variants][][offers][][id] integer >=1.0
          [][variants][][offers][][name] string >=1.0
          [][variants][][offers][][price_gross] integer >=1.0
          [][variants][][offers][][price_net] integer >=1.0
          [][variants][][offers][][club_price] integer >=1.0
          [][variants][][offers][][discount] object (PriceModifierDiscountDTO) >=1.0
          [][variants][][offers][][_embedded[promoPrice]] object (PromoPriceDTO) >=1.0
          [][variants][][offers][][_embedded[promoPrice]][campaign_id] integer >=1.0
          [][variants][][offers][][_embedded[promoPrice]][action_id] integer >=1.0
          [][variants][][offers][][_embedded[promoPrice]][show_new_price] boolean >=1.0
          [][variants][][offers][][_embedded[promoPrice]][show_old_price] boolean >=1.0
          [][variants][][offers][][_embedded[promoPrice]][club_price] integer >=1.0
          [][variants][][offers][][_embedded[promoPrice]][for_action_price] integer >=1.0
          [][variants][][offers][][_embedded[promoPrice]][for_action_campaign_id] custom handler result for (int) >=1.0
          [][variants][][offers][][_embedded[promoPrice]][for_action_code] string >=1.0
          [][variants][][offers][][_embedded[promoPrice]][new_price] integer >=1.0
          [][variants][][offers][][_embedded[promoPrice]][new_price_net] integer >=1.0
          [][variants][][offers][][_embedded[promoPrice]][old_price] integer >=1.0
          [][variants][][offers][][_embedded[promoPrice]][discount_info_collection] array >=1.0
          [][variants][][offers][][_embedded[promoPrice]][discount_info_basic_collection] array >=1.0
          [][variants][][offers][][_embedded[promoPrice]][product_price] integer >=1.0
          [][variants][][offers][][_embedded[promoPrice]][date_from] string >=1.0
          [][variants][][offers][][_embedded[promoPrice]][date_to] string >=1.0
          [][variants][][offers][][promo_price_gross] integer >=1.0
          [][variants][][offers][][promo_price_net] integer >=1.0
          [][variants][][offers][][product_id] integer >=1.0
          [][variants][][offers][][product_parent_id] integer >=1.0
          [][variants][][offers][][link] string >=1.0
          [][variants][][offers][][gallery] array >=1.0
          [][variants][][offers][][availability] object (ProductAvailabilityDTO) >=1.0
          [][variants][][color] string >=1.0
          [][variants][][size_offers] custom handler result for (ArrayCollection) >=1.0
          [][published_date] string >=1.0
          [][template] object (TemplateDTO) >=1.0
          [][template][id] integer >=1.0
          [][template][name] string >=1.0
          [][template][template_type] string >=1.0
          [][_embedded[opinionsAverage]] object (ProductOpinionAverageDTO) >=1.0
          [][_embedded[opinionsAverage]][product_id] integer >=1.0
          [][_embedded[opinionsAverage]][average] float >=1.0
          [][_embedded[opinionsAverage]][count] integer >=1.0
          [][switches][] array of objects (bool) >=1.0
          [][flags][] array of objects (bool) >=1.0
          [][_embedded[postscripts]][] array of objects (PostscriptDTO) >=1.0
          [][_embedded[postscripts]][][id] integer >=1.0
          [][_embedded[postscripts]][][name] string >=1.0
          [][_embedded[postscripts]][][url] string >=1.0
          [][_embedded[postscripts]][][display_price_strategy] custom handler result for (int) >=1.0
          [][_embedded[postscripts]][][tooltip] string >=1.0
          [][_embedded[postscripts]][][place] string >=1.0
          [][_embedded[postscripts]][][zone] string >=1.0
          [][_embedded[postscripts]][][gtm_position] string >=1.0
          [][_embedded[postscripts]][][gtm_name] string >=1.0
          [][_embedded[promoPrice]] object (PromoPriceDTO) >=1.0
          [][_embedded[promoPrice]][campaign_id] integer >=1.0
          [][_embedded[promoPrice]][action_id] integer >=1.0
          [][_embedded[promoPrice]][show_new_price] boolean >=1.0
          [][_embedded[promoPrice]][show_old_price] boolean >=1.0
          [][_embedded[promoPrice]][club_price] integer >=1.0
          [][_embedded[promoPrice]][for_action_price] integer >=1.0
          [][_embedded[promoPrice]][for_action_campaign_id] custom handler result for (int) >=1.0
          [][_embedded[promoPrice]][for_action_code] string >=1.0
          [][_embedded[promoPrice]][new_price] integer >=1.0
          [][_embedded[promoPrice]][new_price_net] integer >=1.0
          [][_embedded[promoPrice]][old_price] integer >=1.0
          [][_embedded[promoPrice]][discount_info_collection] array >=1.0
          [][_embedded[promoPrice]][discount_info_basic_collection] array >=1.0
          [][_embedded[promoPrice]][product_price] integer >=1.0
          [][_embedded[promoPrice]][date_from] string >=1.0
          [][_embedded[promoPrice]][date_to] string >=1.0
          [][_embedded[relations]] custom handler result for (Enp\Bundle\Api\ProductOfferBundle\DTO\Versions\V1) >=1.0
          [][_embedded[quality]] custom handler result for (Enp\Bundle\Api\ProductOfferBundle\DTO\Versions\V1) >=1.0
          [][type] string >=1.0
          [][service_type] string >=1.0
          [][internal_code] string >=1.0
          [][_embedded[services]] array >=1.0
          [][_embedded[bestPaymentBankOffer]] object (BestPaymentBankOffersDTO) >=1.0
          [][_embedded[bestPaymentBankOffer]][installments_number] integer >=1.0
          [][_embedded[bestPaymentBankOffer]][interest_on_loan] float >=1.0
          [][_embedded[bestPaymentBankOffer]][display_strategy] integer >=1.0
          [][_embedded[bestPaymentBankOffer]][general_information] string >=1.0
          [][_embedded[bestPaymentBankOffer]][installment_amount] custom handler result for (Enp\Bundle\CoreBundle\Model\MoneyInterface) >=1.0
          [][_embedded[hotDeals]][] array of objects (HotDealDTO) >=1.0
          [][_embedded[hotDeals]][][quantity_promoted] custom handler result for (int) >=1.0
          [][_embedded[hotDeals]][][remaining_quantity] custom handler result for (int) >=1.0
          [][_embedded[hotDeals]][][promotion_name] string >=1.0
          [][other_prices][] array of objects (OtherPriceDTO) >=1.0
          [][other_prices][][type] string >=1.0
          [][other_prices][][gross] integer >=1.0
          [][other_prices][][net] integer >=1.0
          [][auto_text] array >=1.0

          Status Codes

          Status Code Description
          200
          • OK
          400
          • Bad request
          401
          • Unauthorized
          404
          • Not found
          Input

          Requirements

          = -

          Headers

          = -

          = -

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
  • Show/hide List Operations Expand Operations

    Captcha

    • /api/captchas/images
        • GET /api/captchas/images dev

          • Get captcha image
          • Documentation
          • Sandbox

          Headers

          Name Required? Description
          Accept true Required header + version
          Content-Type true
          Authorization true Authentication & Authorization
          Content-Website true Sets website in api

          Status Codes

          Status Code Description
          200
          • OK
          401
          • Unauthorized
          Input
          Headers

          = -

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
  • Show/hide List Operations Expand Operations

    Cart

    • /api/carts
        • DELETE /api/carts stable

          • Delete cart
          • Documentation
          • Sandbox

          Headers

          Name Required? Description
          Accept true Required header + version
          Content-Type true
          Authorization true Authentication & Authorization
          Content-Website true Sets website in api

          Return

          Parameter Type Versions Description

          200 - OK

          cart_number string >=1.0
          cart_link string >=1.0
          code string >=1.0
          total integer >=1.0
          total_net integer >=1.0
          total_before_promo integer >=1.0
          additional_total integer >=1.0
          additional_total_net integer >=1.0
          items_total integer >=1.0
          items_total_net integer >=1.0
          items_quantity integer >=1.0
          currency string >=1.0
          transport_total integer >=1.0
          payment_total integer >=1.0
          invoice boolean >=1.0
          _embedded[items][] array of objects (CartItemDTO) >=1.0
          _embedded[items][][product_id] integer >=1.0
          _embedded[items][][name] string >=1.0
          _embedded[items][][price_gross] integer >=1.0
          _embedded[items][][total] integer >=1.0
          _embedded[items][][price_net] integer >=1.0
          _embedded[items][][postscript] string >=1.0
          _embedded[items][][price_original_gross] integer >=1.0
          _embedded[items][][currency] string >=1.0
          _embedded[items][][hash] string >=1.0
          _embedded[items][][_embedded[offer]] object (ProductOfferDTO) >=1.0
          _embedded[items][][_embedded[offer]][id] integer >=1.0
          _embedded[items][][_embedded[offer]][name] string >=1.0
          _embedded[items][][_embedded[offer]][product_id] integer >=1.0
          _embedded[items][][_embedded[offer]][product_parent_id] integer >=1.0
          _embedded[items][][_embedded[offer]][stock_shop] integer >=1.0
          _embedded[items][][_embedded[offer]][stock_shipment] integer >=1.0
          _embedded[items][][_embedded[offer]][availability] object (ProductAvailabilityDTO) >=1.0
          _embedded[items][][_embedded[offer]][availability][id] integer >=1.0
          _embedded[items][][_embedded[offer]][availability][name] string >=1.0
          _embedded[items][][_embedded[offer]][availability][display_name] string >=1.0
          _embedded[items][][_embedded[offer]][availability][display_name_operator] string >=1.0
          _embedded[items][][_embedded[offer]][availability][description] string >=1.0
          _embedded[items][][_embedded[offer]][availability][description_details] string >=1.0
          _embedded[items][][_embedded[offer]][availability][color_hash] string >=1.0
          _embedded[items][][_embedded[offer]][availability][icon] string >=1.0
          _embedded[items][][_embedded[offer]][availability][weight] custom handler result for (int) >=1.0
          _embedded[items][][_embedded[offer]][availability][is_default] custom handler result for (bool) >=1.0
          _embedded[items][][_embedded[offer]][availability][type] string >=1.0
          _embedded[items][][_embedded[offer]][add_to_cart] boolean >=1.0
          _embedded[items][][_embedded[offer]][add_to_cart_link] string >=1.0
          _embedded[items][][_embedded[offer]][price_gross] integer >=1.0
          _embedded[items][][_embedded[offer]][price_net] integer >=1.0
          _embedded[items][][_embedded[offer]][club_price] integer >=1.0
          _embedded[items][][_embedded[offer]][discount] object (PriceModifierDiscountDTO) >=1.0
          _embedded[items][][_embedded[offer]][discount][value] custom handler result for (Enp\Bundle\CoreBundle\Model\MoneyInterface) >=1.0
          _embedded[items][][_embedded[offer]][discount][old_price] custom handler result for (Enp\Bundle\CoreBundle\Model\MoneyInterface) >=1.0
          _embedded[items][][_embedded[offer]][discount][date_time_start] DateTime >=1.0
          _embedded[items][][_embedded[offer]][discount][date_time_end] DateTime >=1.0
          _embedded[items][][_embedded[offer]][promo_price_gross] integer >=1.0
          _embedded[items][][_embedded[offer]][promo_price_net] integer >=1.0
          _embedded[items][][_embedded[offer]][link] string >=1.0
          _embedded[items][][_embedded[offer]][gallery] array >=1.0
          _embedded[items][][_embedded[offer]][gallery_thumbnails][] array of arrays >=1.0
          _embedded[items][][_embedded[offer]][emblems][] array of objects (EmblemDTO) >=1.0
          _embedded[items][][_embedded[offer]][emblems][][id] integer >=1.0
          _embedded[items][][_embedded[offer]][emblems][][name] string >=1.0
          _embedded[items][][_embedded[offer]][emblems][][place] string >=1.0
          _embedded[items][][_embedded[offer]][emblems][][zone] string >=1.0
          _embedded[items][][_embedded[offer]][emblems][][content] string >=1.0
          _embedded[items][][_embedded[offer]][emblems][][raw] string >=1.0
          _embedded[items][][_embedded[offer]][emblems][][raw_content] string >=1.0
          _embedded[items][][_embedded[offer]][emblems][][raw_tooltip] string >=1.0
          _embedded[items][][_embedded[offer]][emblems][][deeplink] string >=1.0
          _embedded[items][][_embedded[offer]][emblems][][url] string >=1.0
          _embedded[items][][_embedded[offer]][emblems][][tooltip] string >=1.0
          _embedded[items][][_embedded[offer]][emblems][][discount] string >=1.0
          _embedded[items][][_embedded[offer]][emblems][][gtm_name_ads] string >=1.0
          _embedded[items][][_embedded[offer]][emblems][][gtm_position_ads] string >=1.0
          _embedded[items][][_embedded[offer]][categories][] array of objects (CategoryDTO) >=1.0
          _embedded[items][][_embedded[offer]][categories][][id] integer >=1.0
          _embedded[items][][_embedded[offer]][categories][][name] string >=1.0
          _embedded[items][][_embedded[offer]][categories][][main_category] custom handler result for (bool) >=1.0
          _embedded[items][][_embedded[offer]][system_attributes][] array of objects (AttributeDTO) >=1.0
          _embedded[items][][_embedded[offer]][system_attributes][][id] custom handler result for (int) >=1.0
          _embedded[items][][_embedded[offer]][system_attributes][][name] string >=1.0
          _embedded[items][][_embedded[offer]][system_attributes][][is_hint_long] custom handler result for (bool) >=1.0
          _embedded[items][][_embedded[offer]][system_attributes][][values] array >=1.0
          _embedded[items][][_embedded[offer]][system_attributes][][original_name] string >=1.0
          _embedded[items][][_embedded[offer]][system_attributes][][extended_values] array >=1.0
          _embedded[items][][_embedded[offer]][system_attributes][][validation_type] string >=1.0
          _embedded[items][][_embedded[offer]][unassigned_attributes][] array of objects (AttributeDTO) >=1.0
          _embedded[items][][_embedded[offer]][key_attributes][] array of objects (AttributeDTO) >=1.0
          _embedded[items][][_embedded[offer]][menu_item_attributes][] array of objects (AttributeDTO) >=1.0
          _embedded[items][][_embedded[offer]][specification][] array of objects (PropertyDTO) >=1.0
          _embedded[items][][_embedded[offer]][specification][][name] string >=1.0
          _embedded[items][][_embedded[offer]][specification][][attributes][] array of objects (AttributeDTO) >=1.0
          _embedded[items][][_embedded[offer]][is_product_set] boolean >=1.0
          _embedded[items][][_embedded[offer]][attribute_settings] array >=1.0
          _embedded[items][][_embedded[offer]][description] string >=1.0
          _embedded[items][][_embedded[offer]][variants][] array of objects (VariantDTO) >=1.0
          _embedded[items][][_embedded[offer]][variants][][label] string >=1.0
          _embedded[items][][_embedded[offer]][variants][][display_method] string >=1.0
          _embedded[items][][_embedded[offer]][variants][][hide_single_value] custom handler result for (bool) >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][] array of objects (VariantProductOfferDTO) >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][id] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][name] string >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][price_gross] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][price_net] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][club_price] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][discount] object (PriceModifierDiscountDTO) >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]] object (PromoPriceDTO) >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][campaign_id] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][action_id] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][show_new_price] boolean >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][show_old_price] boolean >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][club_price] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][for_action_price] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][for_action_campaign_id] custom handler result for (int) >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][for_action_code] string >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][new_price] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][new_price_net] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][old_price] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][discount_info_collection] array >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][discount_info_basic_collection] array >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][product_price] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][date_from] string >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][date_to] string >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][promo_price_gross] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][promo_price_net] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][product_id] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][product_parent_id] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][link] string >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][gallery] array >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][availability] object (ProductAvailabilityDTO) >=1.0
          _embedded[items][][_embedded[offer]][variants][][color] string >=1.0
          _embedded[items][][_embedded[offer]][variants][][size_offers] custom handler result for (ArrayCollection) >=1.0
          _embedded[items][][_embedded[offer]][published_date] string >=1.0
          _embedded[items][][_embedded[offer]][template] object (TemplateDTO) >=1.0
          _embedded[items][][_embedded[offer]][template][id] integer >=1.0
          _embedded[items][][_embedded[offer]][template][name] string >=1.0
          _embedded[items][][_embedded[offer]][template][template_type] string >=1.0
          _embedded[items][][_embedded[offer]][_embedded[opinionsAverage]] object (ProductOpinionAverageDTO) >=1.0
          _embedded[items][][_embedded[offer]][_embedded[opinionsAverage]][product_id] integer >=1.0
          _embedded[items][][_embedded[offer]][_embedded[opinionsAverage]][average] float >=1.0
          _embedded[items][][_embedded[offer]][_embedded[opinionsAverage]][count] integer >=1.0
          _embedded[items][][_embedded[offer]][switches][] array of objects (bool) >=1.0
          _embedded[items][][_embedded[offer]][flags][] array of objects (bool) >=1.0
          _embedded[items][][_embedded[offer]][_embedded[postscripts]][] array of objects (PostscriptDTO) >=1.0
          _embedded[items][][_embedded[offer]][_embedded[postscripts]][][id] integer >=1.0
          _embedded[items][][_embedded[offer]][_embedded[postscripts]][][name] string >=1.0
          _embedded[items][][_embedded[offer]][_embedded[postscripts]][][url] string >=1.0
          _embedded[items][][_embedded[offer]][_embedded[postscripts]][][display_price_strategy] custom handler result for (int) >=1.0
          _embedded[items][][_embedded[offer]][_embedded[postscripts]][][tooltip] string >=1.0
          _embedded[items][][_embedded[offer]][_embedded[postscripts]][][place] string >=1.0
          _embedded[items][][_embedded[offer]][_embedded[postscripts]][][zone] string >=1.0
          _embedded[items][][_embedded[offer]][_embedded[postscripts]][][gtm_position] string >=1.0
          _embedded[items][][_embedded[offer]][_embedded[postscripts]][][gtm_name] string >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]] object (PromoPriceDTO) >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][campaign_id] integer >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][action_id] integer >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][show_new_price] boolean >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][show_old_price] boolean >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][club_price] integer >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][for_action_price] integer >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][for_action_campaign_id] custom handler result for (int) >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][for_action_code] string >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][new_price] integer >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][new_price_net] integer >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][old_price] integer >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][discount_info_collection] array >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][discount_info_basic_collection] array >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][product_price] integer >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][date_from] string >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][date_to] string >=1.0
          _embedded[items][][_embedded[offer]][_embedded[relations]] custom handler result for (Enp\Bundle\Api\ProductOfferBundle\DTO\Versions\V1) >=1.0
          _embedded[items][][_embedded[offer]][_embedded[quality]] custom handler result for (Enp\Bundle\Api\ProductOfferBundle\DTO\Versions\V1) >=1.0
          _embedded[items][][_embedded[offer]][type] string >=1.0
          _embedded[items][][_embedded[offer]][service_type] string >=1.0
          _embedded[items][][_embedded[offer]][internal_code] string >=1.0
          _embedded[items][][_embedded[offer]][_embedded[services]] array >=1.0
          _embedded[items][][_embedded[offer]][_embedded[bestPaymentBankOffer]] object (BestPaymentBankOffersDTO) >=1.0
          _embedded[items][][_embedded[offer]][_embedded[bestPaymentBankOffer]][installments_number] integer >=1.0
          _embedded[items][][_embedded[offer]][_embedded[bestPaymentBankOffer]][interest_on_loan] float >=1.0
          _embedded[items][][_embedded[offer]][_embedded[bestPaymentBankOffer]][display_strategy] integer >=1.0
          _embedded[items][][_embedded[offer]][_embedded[bestPaymentBankOffer]][general_information] string >=1.0
          _embedded[items][][_embedded[offer]][_embedded[bestPaymentBankOffer]][installment_amount] custom handler result for (Enp\Bundle\CoreBundle\Model\MoneyInterface) >=1.0
          _embedded[items][][_embedded[offer]][_embedded[hotDeals]][] array of objects (HotDealDTO) >=1.0
          _embedded[items][][_embedded[offer]][_embedded[hotDeals]][][quantity_promoted] custom handler result for (int) >=1.0
          _embedded[items][][_embedded[offer]][_embedded[hotDeals]][][remaining_quantity] custom handler result for (int) >=1.0
          _embedded[items][][_embedded[offer]][_embedded[hotDeals]][][promotion_name] string >=1.0
          _embedded[items][][_embedded[offer]][other_prices][] array of objects (OtherPriceDTO) >=1.0
          _embedded[items][][_embedded[offer]][other_prices][][type] string >=1.0
          _embedded[items][][_embedded[offer]][other_prices][][gross] integer >=1.0
          _embedded[items][][_embedded[offer]][other_prices][][net] integer >=1.0
          _embedded[items][][_embedded[offer]][auto_text] array >=1.0
          _embedded[items][][discount] custom handler result for (Enp\Bundle\CoreBundle\Model\MoneyInterface) >=1.0
          _embedded[items][][is_available_for_cart_pos] custom handler result for (bool) >=1.0
          _embedded[items][][_embedded[esizeme_recommendation]] custom handler result for (Enp\Bundle\Api\PromotionActionBundle\Infrastructure\DTO\Versions\V1\ItemRecommendationDTO) >=1.0
          _embedded[items][][gratis_to_choose_collection] custom handler result for (ArrayCollection) >=1.0
          _embedded[items][][applied_promo_actions][] array of objects (PromoActionDTO) >=1.0
          _embedded[items][][applied_promo_actions][][id] integer >=1.0
          promo_codes[] array of objects (PromoCodeDTO) >=1.0
          promo_codes[][code] string >=1.0
          promo_codes[][promo_action_id] integer >=1.0
          promo_codes[][promo_action_name] string >=1.0
          promo_codes[][promo_action_description] string >=1.0
          _embedded[deliveryPos] object (PosDTO) >=1.0
          _embedded[deliveryPos][id] integer >=1.0
          _embedded[deliveryPos][name] string >=1.0
          _embedded[deliveryPos][code] string >=1.0
          _embedded[deliveryPos][warehouse_id] integer >=1.0
          _embedded[deliveryPos][warehouse] string >=1.0
          _embedded[deliveryPos][street] string >=1.0
          _embedded[deliveryPos][house_number] string >=1.0
          _embedded[deliveryPos][apartment_number] string >=1.0
          _embedded[deliveryPos][postcode] string >=1.0
          _embedded[deliveryPos][city] string >=1.0
          _embedded[deliveryPos][phone] string >=1.0
          _embedded[deliveryPos][email] string >=1.0
          _embedded[deliveryPos][province] string >=1.0
          _embedded[deliveryPos][distance] float >=1.0
          _embedded[deliveryPos][latitude] float >=1.0
          _embedded[deliveryPos][longitude] float >=1.0
          _embedded[deliveryPos][open_hours][] array of objects (OpenHourDTO) >=1.0
          _embedded[deliveryPos][open_hours][][week_day] custom handler result for (int) >=1.0
          _embedded[deliveryPos][open_hours][][open_hour_from] string >=1.0
          _embedded[deliveryPos][open_hours][][open_hour_to] string >=1.0
          _embedded[deliveryPos][periodical] string >=1.0
          _embedded[deliveryPos][availability_variants][] array of objects (AvailabilityVariantsDTO) >=1.0
          _embedded[deliveryPos][availability_variants][][offer_id] integer >=1.0
          _embedded[deliveryPos][availability_variants][][product_id] integer >=1.0
          _embedded[deliveryPos][availability_variants][][stock] integer >=1.0
          _embedded[deliveryPos][availability_variants][][availability_id] integer >=1.0
          _embedded[deliveryPos][availability_variants][][availability_name] string >=1.0
          _embedded[deliveryPos][availability_variants][][availability_type] string >=1.0
          _embedded[deliveryPos][availability_variants][][add_to_cart] custom handler result for (bool) >=1.0
          _embedded[deliveryPos][products_availability] custom handler result for (bool) >=1.0
          _embedded[deliveryPos][possible_exposition] custom handler result for (bool) >=1.0
          _embedded[deliveryPos][availability_type] string >=1.0
          _embedded[deliveryPos][button_label] string >=1.0
          _embedded[deliveryPos][pos_delivery_day_label] string >=1.0
          _embedded[deliveryPos][krs] string >=1.0
          _embedded[deliveryPos][nip] string >=1.0
          _embedded[deliveryPos][company] string >=1.0
          _embedded[deliveryPos][location_description] string >=1.0
          _embedded[realizePos] object (PosDTO) >=1.0
          _embedded[customerPos] object (PosDTO) >=1.0
          _embedded[transport] object (TransportDTO) >=1.0
          _embedded[transport][id] integer >=1.0
          _embedded[transport][name] string >=1.0
          _embedded[transport][display_name] string >=1.0
          _embedded[transport][amount] integer >=1.0
          _embedded[transport][standard_amount] integer >=1.0
          _embedded[transport][code] string >=1.0
          _embedded[transport][ref_number] string >=1.0
          _embedded[transport][icon] string >=1.0
          _embedded[transport][type] object (TransportTypeDTO) >=1.0
          _embedded[transport][type][id] integer >=1.0
          _embedded[transport][type][name] string >=1.0
          _embedded[transport][type][code] string >=1.0
          _embedded[transport][tracking_urls] array >=1.0
          _embedded[payment] object (PaymentDTO) >=1.0
          _embedded[payment][id] integer >=1.0
          _embedded[payment][name] string >=1.0
          _embedded[payment][display_name] string >=1.0
          _embedded[payment][description] string >=1.0
          _embedded[payment][amount] integer >=1.0
          _embedded[payment][ref_number] string >=1.0
          _embedded[payment][icon] string >=1.0
          _embedded[payment][type] object (PaymentTypeDTO) >=1.0
          _embedded[payment][type][id] integer >=1.0
          _embedded[payment][type][name] string >=1.0
          _embedded[payment][type][display_name] string >=1.0
          _embedded[payment][type][code] string >=1.0
          _embedded[payment][_embedded[configuration]][] array of objects (PaymentConfigurationDTO) >=1.0
          _embedded[payment][_embedded[configuration]][][id] integer >=1.0
          _embedded[payment][_embedded[configuration]][][config_name] string >=1.0
          _embedded[payment][_embedded[configuration]][][config_value] string >=1.0
          _embedded[payment][_embedded[configuration]][][payment_id] integer >=1.0
          _embedded[payment][payment_link] string >=1.0
          _embedded[payment][is_installment] custom handler result for (bool) >=1.0
          _embedded[payment][has_private_strategy] custom handler result for (bool) >=1.0
          _embedded[paymentGroup] object (PaymentGroupDTO) >=1.0
          _embedded[paymentGroup][id] integer >=1.0
          _embedded[paymentGroup][name] string >=1.0
          _embedded[paymentGroup][display_name] string >=1.0
          _embedded[paymentGroup][display_description] string >=1.0
          _embedded[paymentGroup][sort_order] integer >=1.0
          _embedded[paymentGroup][default_group] custom handler result for (bool) >=1.0
          _embedded[paymentGroup][payment][] array of objects (PaymentDTO) >=1.0
          _embedded[paymentGroup][icon] string >=1.0
          _embedded[transsportGroup] object (TransportGroupDTO) >=1.0
          _embedded[transsportGroup][id] integer >=1.0
          _embedded[transsportGroup][default_group] custom handler result for (bool) >=1.0
          _embedded[transsportGroup][name] string >=1.0
          _embedded[transsportGroup][description] string >=1.0
          _embedded[transsportGroup][sort_order] integer >=1.0
          _embedded[transsportGroup][transport][] array of objects (TransportDTO) >=1.0
          _embedded[customerComment] object (CommentDTO) >=1.0
          _embedded[shipmentComment] object (CommentDTO) >=1.0
          _embedded[deliveryInpost] object (InpostDTO) >=1.0
          _embedded[deliveryInpost][id] string >=1.0
          _embedded[deliveryInpost][street] string >=1.0
          _embedded[deliveryInpost][number] string >=1.0
          _embedded[deliveryInpost][post_code] string >=1.0
          _embedded[deliveryInpost][town] string >=1.0
          _embedded[deliveryInpost][latitude] float >=1.0
          _embedded[deliveryInpost][longitude] float >=1.0
          _embedded[deliveryInpost][description] string >=1.0
          _embedded[deliveryInpost][payment_type] string >=1.0
          _embedded[deliveryInpost][distance] float >=1.0
          _embedded[deliveryPickupPoint] object (PickupDTO) >=1.0
          _embedded[deliveryPickupPoint][id] string >=1.0
          _embedded[deliveryPickupPoint][name] string >=1.0
          _embedded[deliveryPickupPoint][address_country] string >=1.0
          _embedded[deliveryPickupPoint][address_postcode] string >=1.0
          _embedded[deliveryPickupPoint][address_city] string >=1.0
          _embedded[deliveryPickupPoint][address_street] string >=1.0
          _embedded[deliveryPickupPoint][address_house_number] string >=1.0
          _embedded[deliveryPickupPoint][longitude] string >=1.0
          _embedded[deliveryPickupPoint][latitude] string >=1.0
          _embedded[deliveryPickupPoint][opening_hours] string >=1.0
          _embedded[deliveryPickupPoint][additional_data] array >=1.0
          _embedded[deliveryDhl] object (DhlPointDTO) >=1.0
          _embedded[deliveryDhl][name] string >=1.0
          _embedded[deliveryDhl][type] string >=1.0
          _embedded[deliveryDhl][address] object (DhlPointAddressDTO) >=1.0
          _embedded[deliveryDhl][address][country] string >=1.0
          _embedded[deliveryDhl][address][name] string >=1.0
          _embedded[deliveryDhl][address][postcode] string >=1.0
          _embedded[deliveryDhl][address][city] string >=1.0
          _embedded[deliveryDhl][address][street] string >=1.0
          _embedded[deliveryDhl][address][house_number] string >=1.0
          _embedded[deliveryDhl][address][apartment_number] string >=1.0
          _embedded[deliveryDhl][description] string >=1.0
          _embedded[deliveryDhl][latitude] float >=1.0
          _embedded[deliveryDhl][longitude] float >=1.0
          _embedded[deliveryDhl][sap_code] string >=1.0
          _embedded[deliveryDhl][open_hours][] array of objects (OpenHourDTO) >=1.0
          _embedded[deliveryDhl][open_hours][][week_day] custom handler result for (int) >=1.0
          _embedded[deliveryDhl][open_hours][][open_hour_from] string >=1.0
          _embedded[deliveryDhl][open_hours][][open_hour_to] string >=1.0
          _embedded[deliveryDhl][work_in_holiday] custom handler result for (bool) >=1.0
          _embedded[accountAddress] object (AddressDTO) >=1.0
          _embedded[accountAddress][id] integer >=1.0
          _embedded[accountAddress][first_name] string >=1.0
          _embedded[accountAddress][last_name] string >=1.0
          _embedded[accountAddress][email] string >=1.0
          _embedded[accountAddress][phone_number] string >=1.0
          _embedded[accountAddress][phone_prefix] string >=1.0
          _embedded[accountAddress][street] string >=1.0
          _embedded[accountAddress][city] string >=1.0
          _embedded[accountAddress][house_number] string >=1.0
          _embedded[accountAddress][apartment_number] string >=1.0
          _embedded[accountAddress][postcode] string >=1.0
          _embedded[accountAddress][province] string >=1.0
          _embedded[accountAddress][country] string >=1.0
          _embedded[accountAddress][nip] string >=1.0
          _embedded[accountAddress][company] string >=1.0
          _embedded[accountAddress][regon] string >=1.0
          _embedded[accountAddress][krs] string >=1.0
          _embedded[accountAddress][lat] string >=1.0
          _embedded[accountAddress][lng] string >=1.0
          _embedded[accountAddress][salutation] string >=1.0
          _embedded[accountAddress][address_type] string >=1.0
          _embedded[transportAddress] object (AddressDTO) >=1.0
          _embedded[billingAddress] object (AddressDTO) >=1.0
          _embedded[display_free_transport] boolean >=1.0
          warranty_total integer >=1.0
          services_total integer >=1.0
          discount_total integer >=1.0
          invoice_type integer >=1.0
          _embedded[shipmentDate] DateTime >=1.0

          Status Codes

          Status Code Description
          200
          • OK
          401
          • Unauthorized
          403
          • Forbidden
          Input
          Headers

          = -

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • GET /api/carts stable

          • Get cart
          • Documentation
          • Sandbox

          Headers

          Name Required? Description
          Accept true Required header + version
          Content-Type true
          Authorization true Authentication & Authorization
          Content-Website true Sets website in api

          Return

          Parameter Type Versions Description

          200 - OK

          cart_number string >=1.0
          cart_link string >=1.0
          code string >=1.0
          total integer >=1.0
          total_net integer >=1.0
          total_before_promo integer >=1.0
          additional_total integer >=1.0
          additional_total_net integer >=1.0
          items_total integer >=1.0
          items_total_net integer >=1.0
          items_quantity integer >=1.0
          currency string >=1.0
          transport_total integer >=1.0
          payment_total integer >=1.0
          invoice boolean >=1.0
          _embedded[items][] array of objects (CartItemDTO) >=1.0
          _embedded[items][][product_id] integer >=1.0
          _embedded[items][][name] string >=1.0
          _embedded[items][][price_gross] integer >=1.0
          _embedded[items][][total] integer >=1.0
          _embedded[items][][price_net] integer >=1.0
          _embedded[items][][postscript] string >=1.0
          _embedded[items][][price_original_gross] integer >=1.0
          _embedded[items][][currency] string >=1.0
          _embedded[items][][hash] string >=1.0
          _embedded[items][][_embedded[offer]] object (ProductOfferDTO) >=1.0
          _embedded[items][][_embedded[offer]][id] integer >=1.0
          _embedded[items][][_embedded[offer]][name] string >=1.0
          _embedded[items][][_embedded[offer]][product_id] integer >=1.0
          _embedded[items][][_embedded[offer]][product_parent_id] integer >=1.0
          _embedded[items][][_embedded[offer]][stock_shop] integer >=1.0
          _embedded[items][][_embedded[offer]][stock_shipment] integer >=1.0
          _embedded[items][][_embedded[offer]][availability] object (ProductAvailabilityDTO) >=1.0
          _embedded[items][][_embedded[offer]][availability][id] integer >=1.0
          _embedded[items][][_embedded[offer]][availability][name] string >=1.0
          _embedded[items][][_embedded[offer]][availability][display_name] string >=1.0
          _embedded[items][][_embedded[offer]][availability][display_name_operator] string >=1.0
          _embedded[items][][_embedded[offer]][availability][description] string >=1.0
          _embedded[items][][_embedded[offer]][availability][description_details] string >=1.0
          _embedded[items][][_embedded[offer]][availability][color_hash] string >=1.0
          _embedded[items][][_embedded[offer]][availability][icon] string >=1.0
          _embedded[items][][_embedded[offer]][availability][weight] custom handler result for (int) >=1.0
          _embedded[items][][_embedded[offer]][availability][is_default] custom handler result for (bool) >=1.0
          _embedded[items][][_embedded[offer]][availability][type] string >=1.0
          _embedded[items][][_embedded[offer]][add_to_cart] boolean >=1.0
          _embedded[items][][_embedded[offer]][add_to_cart_link] string >=1.0
          _embedded[items][][_embedded[offer]][price_gross] integer >=1.0
          _embedded[items][][_embedded[offer]][price_net] integer >=1.0
          _embedded[items][][_embedded[offer]][club_price] integer >=1.0
          _embedded[items][][_embedded[offer]][discount] object (PriceModifierDiscountDTO) >=1.0
          _embedded[items][][_embedded[offer]][discount][value] custom handler result for (Enp\Bundle\CoreBundle\Model\MoneyInterface) >=1.0
          _embedded[items][][_embedded[offer]][discount][old_price] custom handler result for (Enp\Bundle\CoreBundle\Model\MoneyInterface) >=1.0
          _embedded[items][][_embedded[offer]][discount][date_time_start] DateTime >=1.0
          _embedded[items][][_embedded[offer]][discount][date_time_end] DateTime >=1.0
          _embedded[items][][_embedded[offer]][promo_price_gross] integer >=1.0
          _embedded[items][][_embedded[offer]][promo_price_net] integer >=1.0
          _embedded[items][][_embedded[offer]][link] string >=1.0
          _embedded[items][][_embedded[offer]][gallery] array >=1.0
          _embedded[items][][_embedded[offer]][gallery_thumbnails][] array of arrays >=1.0
          _embedded[items][][_embedded[offer]][emblems][] array of objects (EmblemDTO) >=1.0
          _embedded[items][][_embedded[offer]][emblems][][id] integer >=1.0
          _embedded[items][][_embedded[offer]][emblems][][name] string >=1.0
          _embedded[items][][_embedded[offer]][emblems][][place] string >=1.0
          _embedded[items][][_embedded[offer]][emblems][][zone] string >=1.0
          _embedded[items][][_embedded[offer]][emblems][][content] string >=1.0
          _embedded[items][][_embedded[offer]][emblems][][raw] string >=1.0
          _embedded[items][][_embedded[offer]][emblems][][raw_content] string >=1.0
          _embedded[items][][_embedded[offer]][emblems][][raw_tooltip] string >=1.0
          _embedded[items][][_embedded[offer]][emblems][][deeplink] string >=1.0
          _embedded[items][][_embedded[offer]][emblems][][url] string >=1.0
          _embedded[items][][_embedded[offer]][emblems][][tooltip] string >=1.0
          _embedded[items][][_embedded[offer]][emblems][][discount] string >=1.0
          _embedded[items][][_embedded[offer]][emblems][][gtm_name_ads] string >=1.0
          _embedded[items][][_embedded[offer]][emblems][][gtm_position_ads] string >=1.0
          _embedded[items][][_embedded[offer]][categories][] array of objects (CategoryDTO) >=1.0
          _embedded[items][][_embedded[offer]][categories][][id] integer >=1.0
          _embedded[items][][_embedded[offer]][categories][][name] string >=1.0
          _embedded[items][][_embedded[offer]][categories][][main_category] custom handler result for (bool) >=1.0
          _embedded[items][][_embedded[offer]][system_attributes][] array of objects (AttributeDTO) >=1.0
          _embedded[items][][_embedded[offer]][system_attributes][][id] custom handler result for (int) >=1.0
          _embedded[items][][_embedded[offer]][system_attributes][][name] string >=1.0
          _embedded[items][][_embedded[offer]][system_attributes][][is_hint_long] custom handler result for (bool) >=1.0
          _embedded[items][][_embedded[offer]][system_attributes][][values] array >=1.0
          _embedded[items][][_embedded[offer]][system_attributes][][original_name] string >=1.0
          _embedded[items][][_embedded[offer]][system_attributes][][extended_values] array >=1.0
          _embedded[items][][_embedded[offer]][system_attributes][][validation_type] string >=1.0
          _embedded[items][][_embedded[offer]][unassigned_attributes][] array of objects (AttributeDTO) >=1.0
          _embedded[items][][_embedded[offer]][key_attributes][] array of objects (AttributeDTO) >=1.0
          _embedded[items][][_embedded[offer]][menu_item_attributes][] array of objects (AttributeDTO) >=1.0
          _embedded[items][][_embedded[offer]][specification][] array of objects (PropertyDTO) >=1.0
          _embedded[items][][_embedded[offer]][specification][][name] string >=1.0
          _embedded[items][][_embedded[offer]][specification][][attributes][] array of objects (AttributeDTO) >=1.0
          _embedded[items][][_embedded[offer]][is_product_set] boolean >=1.0
          _embedded[items][][_embedded[offer]][attribute_settings] array >=1.0
          _embedded[items][][_embedded[offer]][description] string >=1.0
          _embedded[items][][_embedded[offer]][variants][] array of objects (VariantDTO) >=1.0
          _embedded[items][][_embedded[offer]][variants][][label] string >=1.0
          _embedded[items][][_embedded[offer]][variants][][display_method] string >=1.0
          _embedded[items][][_embedded[offer]][variants][][hide_single_value] custom handler result for (bool) >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][] array of objects (VariantProductOfferDTO) >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][id] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][name] string >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][price_gross] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][price_net] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][club_price] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][discount] object (PriceModifierDiscountDTO) >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]] object (PromoPriceDTO) >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][campaign_id] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][action_id] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][show_new_price] boolean >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][show_old_price] boolean >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][club_price] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][for_action_price] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][for_action_campaign_id] custom handler result for (int) >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][for_action_code] string >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][new_price] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][new_price_net] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][old_price] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][discount_info_collection] array >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][discount_info_basic_collection] array >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][product_price] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][date_from] string >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][_embedded[promoPrice]][date_to] string >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][promo_price_gross] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][promo_price_net] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][product_id] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][product_parent_id] integer >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][link] string >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][gallery] array >=1.0
          _embedded[items][][_embedded[offer]][variants][][offers][][availability] object (ProductAvailabilityDTO) >=1.0
          _embedded[items][][_embedded[offer]][variants][][color] string >=1.0
          _embedded[items][][_embedded[offer]][variants][][size_offers] custom handler result for (ArrayCollection) >=1.0
          _embedded[items][][_embedded[offer]][published_date] string >=1.0
          _embedded[items][][_embedded[offer]][template] object (TemplateDTO) >=1.0
          _embedded[items][][_embedded[offer]][template][id] integer >=1.0
          _embedded[items][][_embedded[offer]][template][name] string >=1.0
          _embedded[items][][_embedded[offer]][template][template_type] string >=1.0
          _embedded[items][][_embedded[offer]][_embedded[opinionsAverage]] object (ProductOpinionAverageDTO) >=1.0
          _embedded[items][][_embedded[offer]][_embedded[opinionsAverage]][product_id] integer >=1.0
          _embedded[items][][_embedded[offer]][_embedded[opinionsAverage]][average] float >=1.0
          _embedded[items][][_embedded[offer]][_embedded[opinionsAverage]][count] integer >=1.0
          _embedded[items][][_embedded[offer]][switches][] array of objects (bool) >=1.0
          _embedded[items][][_embedded[offer]][flags][] array of objects (bool) >=1.0
          _embedded[items][][_embedded[offer]][_embedded[postscripts]][] array of objects (PostscriptDTO) >=1.0
          _embedded[items][][_embedded[offer]][_embedded[postscripts]][][id] integer >=1.0
          _embedded[items][][_embedded[offer]][_embedded[postscripts]][][name] string >=1.0
          _embedded[items][][_embedded[offer]][_embedded[postscripts]][][url] string >=1.0
          _embedded[items][][_embedded[offer]][_embedded[postscripts]][][display_price_strategy] custom handler result for (int) >=1.0
          _embedded[items][][_embedded[offer]][_embedded[postscripts]][][tooltip] string >=1.0
          _embedded[items][][_embedded[offer]][_embedded[postscripts]][][place] string >=1.0
          _embedded[items][][_embedded[offer]][_embedded[postscripts]][][zone] string >=1.0
          _embedded[items][][_embedded[offer]][_embedded[postscripts]][][gtm_position] string >=1.0
          _embedded[items][][_embedded[offer]][_embedded[postscripts]][][gtm_name] string >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]] object (PromoPriceDTO) >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][campaign_id] integer >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][action_id] integer >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][show_new_price] boolean >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][show_old_price] boolean >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][club_price] integer >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][for_action_price] integer >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][for_action_campaign_id] custom handler result for (int) >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][for_action_code] string >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][new_price] integer >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][new_price_net] integer >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][old_price] integer >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][discount_info_collection] array >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][discount_info_basic_collection] array >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][product_price] integer >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][date_from] string >=1.0
          _embedded[items][][_embedded[offer]][_embedded[promoPrice]][date_to] string >=1.0
          _embedded[items][][_embedded[offer]][_embedded[relations]] custom handler result for (Enp\Bundle\Api\ProductOfferBundle\DTO\Versions\V1) >=1.0
          _embedded[items][][_embedded[offer]][_embedded[quality]] custom handler result for (Enp\Bundle\Api\ProductOfferBundle\DTO\Versions\V1) >=1.0
          _embedded[items][][_embedded[offer]][type] string >=1.0
          _embedded[items][][_embedded[offer]][service_type] string >=1.0
          _embedded[items][][_embedded[offer]][internal_code] string >=1.0
          _embedded[items][][_embedded[offer]][_embedded[services]] array >=1.0
          _embedded[items][][_embedded[offer]][_embedded[bestPaymentBankOffer]] object (BestPaymentBankOffersDTO) >=1.0
          _embedded[items][][_embedded[offer]][_embedded[bestPaymentBankOffer]][installments_number] integer >=1.0
          _embedded[items][][_embedded[offer]][_embedded[bestPaymentBankOffer]][interest_on_loan] float >=1.0
          _embedded[items][][_embedded[offer]][_embedded[bestPaymentBankOffer]][display_strategy] integer >=1.0
          _embedded[items][][_embedded[offer]][_embedded[bestPaymentBankOffer]][general_information] string >=1.0
          _embedded[items][][_embedded[offer]][_embedded[bestPaymentBankOffer]][installment_amount] custom handler result for (Enp\Bundle\CoreBundle\Model\MoneyInterface) >=1.0
          _embedded[items][][_embedded[offer]][_embedded[hotDeals]][] array of objects (HotDealDTO) >=1.0
          _embedded[items][][_embedded[offer]][_embedded[hotDeals]][][quantity_promoted] custom handler result for (int) >=1.0
          _embedded[items][][_embedded[offer]][_embedded[hotDeals]][][remaining_quantity] custom handler result for (int) >=1.0
          _embedded[items][][_embedded[offer]][_embedded[hotDeals]][][promotion_name] string >=1.0
          _embedded[items][][_embedded[offer]][other_prices][] array of objects (OtherPriceDTO) >=1.0
          _embedded[items][][_embedded[offer]][other_prices][][type] string >=1.0
          _embedded[items][][_embedded[offer]][other_prices][][gross] integer >=1.0
          _embedded[items][][_embedded[offer]][other_prices][][net] integer >=1.0
          _embedded[items][][_embedded[offer]][auto_text] array >=1.0
          _embedded[items][][discount] custom handler result for (Enp\Bundle\CoreBundle\Model\MoneyInterface) >=1.0
          _embedded[items][][is_available_for_cart_pos] custom handler result for (bool) >=1.0
          _embedded[items][][_embedded[esizeme_recommendation]] custom handler result for (Enp\Bundle\Api\PromotionActionBundle\Infrastructure\DTO\Versions\V1\ItemRecommendationDTO) >=1.0
          _embedded[items][][gratis_to_choose_collection] custom handler result for (ArrayCollection) >=1.0
          _embedded[items][][applied_promo_actions][] array of objects (PromoActionDTO) >=1.0
          _embedded[items][][applied_promo_actions][][id] integer >=1.0
          promo_codes[] array of objects (PromoCodeDTO) >=1.0
          promo_codes[][code] string >=1.0
          promo_codes[][promo_action_id] integer >=1.0
          promo_codes[][promo_action_name] string >=1.0
          promo_codes[][promo_action_description] string >=1.0
          _embedded[deliveryPos] object (PosDTO) >=1.0
          _embedded[deliveryPos][id] integer >=1.0
          _embedded[deliveryPos][name] string >=1.0
          _embedded[deliveryPos][code] string >=1.0
          _embedded[deliveryPos][warehouse_id] integer >=1.0
          _embedded[deliveryPos][warehouse] string >=1.0
          _embedded[deliveryPos][street] string >=1.0
          _embedded[deliveryPos][house_number] string >=1.0
          _embedded[deliveryPos][apartment_number] string >=1.0
          _embedded[deliveryPos][postcode] string >=1.0
          _embedded[deliveryPos][city] string >=1.0
          _embedded[deliveryPos][phone] string >=1.0
          _embedded[deliveryPos][email] string >=1.0
          _embedded[deliveryPos][province] string >=1.0
          _embedded[deliveryPos][distance] float >=1.0
          _embedded[deliveryPos][latitude] float >=1.0
          _embedded[deliveryPos][longitude] float >=1.0
          _embedded[deliveryPos][open_hours][] array of objects (OpenHourDTO) >=1.0
          _embedded[deliveryPos][open_hours][][week_day] custom handler result for (int) >=1.0
          _embedded[deliveryPos][open_hours][][open_hour_from] string >=1.0
          _embedded[deliveryPos][open_hours][][open_hour_to] string >=1.0
          _embedded[deliveryPos][periodical] string >=1.0
          _embedded[deliveryPos][availability_variants][] array of objects (AvailabilityVariantsDTO) >=1.0
          _embedded[deliveryPos][availability_variants][][offer_id] integer >=1.0
          _embedded[deliveryPos][availability_variants][][product_id] integer >=1.0
          _embedded[deliveryPos][availability_variants][][stock] integer >=1.0
          _embedded[deliveryPos][availability_variants][][availability_id] integer >=1.0
          _embedded[deliveryPos][availability_variants][][availability_name] string >=1.0
          _embedded[deliveryPos][availability_variants][][availability_type] string >=1.0
          _embedded[deliveryPos][availability_variants][][add_to_cart] custom handler result for (bool) >=1.0
          _embedded[deliveryPos][products_availability] custom handler result for (bool) >=1.0
          _embedded[deliveryPos][possible_exposition] custom handler result for (bool) >=1.0
          _embedded[deliveryPos][availability_type] string >=1.0
          _embedded[deliveryPos][button_label] string >=1.0
          _embedded[deliveryPos][pos_delivery_day_label] string >=1.0
          _embedded[deliveryPos][krs] string >=1.0
          _embedded[deliveryPos][nip] string >=1.0
          _embedded[deliveryPos][company] string >=1.0
          _embedded[deliveryPos][location_description] string >=1.0
          _embedded[realizePos] object (PosDTO) >=1.0
          _embedded[customerPos] object (PosDTO) >=1.0
          _embedded[transport] object (TransportDTO) >=1.0
          _embedded[transport][id] integer >=1.0
          _embedded[transport][name] string >=1.0
          _embedded[transport][display_name] string >=1.0
          _embedded[transport][amount] integer >=1.0
          _embedded[transport][standard_amount] integer >=1.0
          _embedded[transport][code] string >=1.0
          _embedded[transport][ref_number] string >=1.0
          _embedded[transport][icon] string >=1.0
          _embedded[transport][type] object (TransportTypeDTO) >=1.0
          _embedded[transport][type][id] integer >=1.0
          _embedded[transport][type][name] string >=1.0
          _embedded[transport][type][code] string >=1.0
          _embedded[transport][tracking_urls] array >=1.0
          _embedded[payment] object (PaymentDTO) >=1.0
          _embedded[payment][id] integer >=1.0
          _embedded[payment][name] string >=1.0
          _embedded[payment][display_name] string >=1.0
          _embedded[payment][description] string >=1.0
          _embedded[payment][amount] integer >=1.0
          _embedded[payment][ref_number] string >=1.0
          _embedded[payment][icon] string >=1.0
          _embedded[payment][type] object (PaymentTypeDTO) >=1.0
          _embedded[payment][type][id] integer >=1.0
          _embedded[payment][type][name] string >=1.0
          _embedded[payment][type][display_name] string >=1.0
          _embedded[payment][type][code] string >=1.0
          _embedded[payment][_embedded[configuration]][] array of objects (PaymentConfigurationDTO) >=1.0
          _embedded[payment][_embedded[configuration]][][id] integer >=1.0
          _embedded[payment][_embedded[configuration]][][config_name] string >=1.0
          _embedded[payment][_embedded[configuration]][][config_value] string >=1.0
          _embedded[payment][_embedded[configuration]][][payment_id] integer >=1.0
          _embedded[payment][payment_link] string >=1.0
          _embedded[payment][is_installment] custom handler result for (bool) >=1.0
          _embedded[payment][has_private_strategy] custom handler result for (bool) >=1.0
          _embedded[paymentGroup] object (PaymentGroupDTO) >=1.0
          _embedded[paymentGroup][id] integer >=1.0
          _embedded[paymentGroup][name] string >=1.0
          _embedded[paymentGroup][display_name] string >=1.0
          _embedded[paymentGroup][display_description] string >=1.0
          _embedded[paymentGroup][sort_order] integer >=1.0
          _embedded[paymentGroup][default_group] custom handler result for (bool) >=1.0
          _embedded[paymentGroup][payment][] array of objects (PaymentDTO) >=1.0
          _embedded[paymentGroup][icon] string >=1.0
          _embedded[transsportGroup] object (TransportGroupDTO) >=1.0
          _embedded[transsportGroup][id] integer >=1.0
          _embedded[transsportGroup][default_group] custom handler result for (bool) >=1.0
          _embedded[transsportGroup][name] string >=1.0
          _embedded[transsportGroup][description] string >=1.0
          _embedded[transsportGroup][sort_order] integer >=1.0
          _embedded[transsportGroup][transport][] array of objects (TransportDTO) >=1.0
          _embedded[customerComment] object (CommentDTO) >=1.0
          _embedded[shipmentComment] object (CommentDTO) >=1.0
          _embedded[deliveryInpost] object (InpostDTO) >=1.0
          _embedded[deliveryInpost][id] string >=1.0
          _embedded[deliveryInpost][street] string >=1.0
          _embedded[deliveryInpost][number] string >=1.0
          _embedded[deliveryInpost][post_code] string >=1.0
          _embedded[deliveryInpost][town] string >=1.0
          _embedded[deliveryInpost][latitude] float >=1.0
          _embedded[deliveryInpost][longitude] float >=1.0
          _embedded[deliveryInpost][description] string >=1.0
          _embedded[deliveryInpost][payment_type] string >=1.0
          _embedded[deliveryInpost][distance] float >=1.0
          _embedded[deliveryPickupPoint] object (PickupDTO) >=1.0
          _embedded[deliveryPickupPoint][id] string >=1.0
          _embedded[deliveryPickupPoint][name] string >=1.0
          _embedded[deliveryPickupPoint][address_country] string >=1.0
          _embedded[deliveryPickupPoint][address_postcode] string >=1.0
          _embedded[deliveryPickupPoint][address_city] string >=1.0
          _embedded[deliveryPickupPoint][address_street] string >=1.0
          _embedded[deliveryPickupPoint][address_house_number] string >=1.0
          _embedded[deliveryPickupPoint][longitude] string >=1.0
          _embedded[deliveryPickupPoint][latitude] string >=1.0
          _embedded[deliveryPickupPoint][opening_hours] string >=1.0
          _embedded[deliveryPickupPoint][additional_data] array >=1.0
          _embedded[deliveryDhl] object (DhlPointDTO) >=1.0
          _embedded[deliveryDhl][name] string >=1.0
          _embedded[deliveryDhl][type] string >=1.0
          _embedded[deliveryDhl][address] object (DhlPointAddressDTO) >=1.0
          _embedded[deliveryDhl][address][country] string >=1.0
          _embedded[deliveryDhl][address][name] string >=1.0
          _embedded[deliveryDhl][address][postcode] string >=1.0
          _embedded[deliveryDhl][address][city] string >=1.0
          _embedded[deliveryDhl][address][street] string >=1.0
          _embedded[deliveryDhl][address][house_number] string >=1.0
          _embedded[deliveryDhl][address][apartment_number] string >=1.0
          _embedded[deliveryDhl][description] string >=1.0
          _embedded[deliveryDhl][latitude] float >=1.0
          _embedded[deliveryDhl][longitude] float >=1.0
          _embedded[deliveryDhl][sap_code] string >=1.0
          _embedded[deliveryDhl][open_hours][] array of objects (OpenHourDTO) >=1.0
          _embedded[deliveryDhl][open_hours][][week_day] custom handler result for (int) >=1.0
          _embedded[deliveryDhl][open_hours][][open_hour_from] string >=1.0
          _embedded[deliveryDhl][open_hours][][open_hour_to] string >=1.0
          _embedded[deliveryDhl][work_in_holiday] custom handler result for (bool) >=1.0
          _embedded[accountAddress] object (AddressDTO) >=1.0
          _embedded[accountAddress][id] integer >=1.0
          _embedded[accountAddress][first_name] string >=1.0
          _embedded[accountAddress][last_name] string >=1.0
          _embedded[accountAddress][email] string >=1.0
          _embedded[accountAddress][phone_number] string >=1.0
          _embedded[accountAddress][phone_prefix] string >=1.0
          _embedded[accountAddress][street] string >=1.0
          _embedded[accountAddress][city] string >=1.0
          _embedded[accountAddress][house_number] string >=1.0
          _embedded[accountAddress][apartment_number] string >=1.0
          _embedded[accountAddress][postcode] string >=1.0
          _embedded[accountAddress][province] string >=1.0
          _embedded[accountAddress][country] string >=1.0
          _embedded[accountAddress][nip] string >=1.0
          _embedded[accountAddress][company] string >=1.0
          _embedded[accountAddress][regon] string >=1.0
          _embedded[accountAddress][krs] string >=1.0
          _embedded[accountAddress][lat] string >=1.0
          _embedded[accountAddress][lng] string >=1.0
          _embedded[accountAddress][salutation] string >=1.0
          _embedded[accountAddress][address_type] string >=1.0
          _embedded[transportAddress] object (AddressDTO) >=1.0
          _embedded[billingAddress] object (AddressDTO) >=1.0
          _embedded[display_free_transport] boolean >=1.0
          warranty_total integer >=1.0
          services_total integer >=1.0
          discount_total integer >=1.0
          invoice_type integer >=1.0
          _embedded[shipmentDate] DateTime >=1.0

          Status Codes

          Status Code Description
          200
          • OK
          401
          • Unauthorized
          403
          • Forbidden
          Input
          Headers

          = -

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • PUT /api/carts stable

          • Init cart
          • Documentation
          • Sandbox

          Headers

          Name Required? Description
          Accept true Required header + version
          Content-Type true
          Authorization true Authentication & Authorization
          Content-Website true Sets website in api

          Status Codes

          Status Code Description
          204
          • No content
          400
          • Validation failed
          401
          • Unauthorized
          403
          • Forbidden
          Input
          Headers

          = -

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/carts/account-address-choices
        • GET /api/carts/account-address-choices dev

          • Account address for choice context form
          • Documentation
          • Sandbox

          Headers

          Name Required? Description
          Accept true Required header + version
          Content-Type true
          Authorization true Authentication & Authorization
          Content-Website true Sets website in api

          Return

          Parameter Type Versions Description

          200 - OK

          account_address_choice object (AccountAddressChoiceType) *
          account_address_choice[account_address_choice] choice *

          Status Codes

          Status Code Description
          200
          • OK
          401
          • Unauthorized
          403
          • Forbidden
          Input
          Headers

          = -

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/carts/account-address-companies
        • GET /api/carts/account-address-companies dev

          • Account address for company form
          • Documentation
          • Sandbox

          Headers

          Name Required? Description
          Accept true Required header + version
          Content-Type true
          Authorization true Authentication & Authorization
          Content-Website true Sets website in api

          Return

          Parameter Type Versions Description

          200 - OK

          enp_address_type object (AccountAddressCompanyType) *
          enp_address_type[default] choice *
          enp_address_type[enabled] choice *
          enp_address_type[address_name] string *
          enp_address_type[email] string * enp.address.email
          enp_address_type[company] string * enp.address.company
          enp_address_type[phone] string * enp.address.phone
          enp_address_type[street] string * enp.address.street
          enp_address_type[postcode] string * enp.address.postcode
          enp_address_type[city] string * enp.address.city
          enp_address_type[first_name] string * enp.address.firstName
          enp_address_type[last_name] string * enp.address.lastName
          enp_address_type[house_number] string * enp.address.houseNumber

          Status Codes

          Status Code Description
          200
          • OK
          401
          • Unauthorized
          403
          • Forbidden
          Input
          Headers

          = -

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/carts/account-address-companies dev

          • Set account address for company in cart
          • Documentation
          • Sandbox

          Parameters

          Parameter Type Required? Format Description
          enp_address_type object (AccountAddressCompanyType) true
          enp_address_type[default] choice false [false,true]
          enp_address_type[enabled] choice false [false,true]
          enp_address_type[address_name] string false
          enp_address_type[email] string false enp.address.email
          enp_address_type[company] string false enp.address.company
          enp_address_type[phone] string false enp.address.phone
          enp_address_type[street] string false enp.address.street
          enp_address_type[postcode] string false enp.address.postcode
          enp_address_type[city] string false enp.address.city
          enp_address_type[first_name] string false enp.address.firstName
          enp_address_type[last_name] string false enp.address.lastName
          enp_address_type[house_number] string false enp.address.houseNumber

          Headers

          Name Required? Description
          Accept true Required header + version
          Content-Type true
          Authorization true Authentication & Authorization
          Content-Website true Sets website in api

          Return

          Parameter Type Versions Description

          200 - OK

          id integer >=1.0
          default custom handler result for (bool) >=1.0
          first_name string >=1.0
          last_name string >=1.0
          email string >=1.0
          phone_number string >=1.0
          phone_prefix string >=1.0
          street string >=1.0
          city string >=1.0
          house_number string >=1.0
          apartment_number string >=1.0
          postcode string >=1.0
          province string >=1.0
          country string >=1.0
          nip string >=1.0
          company string >=1.0
          address_type string >=1.0
          enabled custom handler result for (bool) >=1.0
          name string >=1.0

          Status Codes

          Status Code Description
          200
          • OK
          401
          • Unauthorized
          403
          • Forbidden
          Input

          Parameters

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          Headers

          = -

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/carts/account-address-companies/statuses
        • GET /api/carts/account-address-companies/statuses dev

          • Set account address in cart
          • Documentation
          • Sandbox

          Headers

          Name Required? Description
          Accept true Required header + version
          Content-Type true
          Authorization true Authentication & Authorization
          Content-Website true Sets website in api

          Return

          Parameter Type Versions Description

          200 - OK

          id integer >=1.0
          default custom handler result for (bool) >=1.0
          first_name string >=1.0
          last_name string >=1.0
          email string >=1.0
          phone_number string >=1.0
          phone_prefix string >=1.0
          street string >=1.0
          city string >=1.0
          house_number string >=1.0
          apartment_number string >=1.0
          postcode string >=1.0
          province string >=1.0
          country string >=1.0
          nip string >=1.0
          company string >=1.0
          address_type string >=1.0
          enabled custom handler result for (bool) >=1.0
          name string >=1.0

          Status Codes

          Status Code Description
          200
          • OK
          401
          • Unauthorized
          403
          • Forbidden
          Input
          Headers

          = -

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/carts/account-address-private-persons
        • GET /api/carts/account-address-private-persons dev

          • Account address for private person form
          • Documentation
          • Sandbox

          Headers

          Name Required? Description
          Accept true Required header + version
          Content-Type true
          Authorization true Authentication & Authorization
          Content-Website true Sets website in api

          Return

          Parameter Type Versions Description

          200 - OK

          enp_address_type object (AccountAddressPrivatePersonType) *
          enp_address_type[default] choice *
          enp_address_type[enabled] choice *
          enp_address_type[address_name] string *
          enp_address_type[email] string * enp.address.email
          enp_address_type[company] string * enp.address.company
          enp_address_type[phone] string * enp.address.phone
          enp_address_type[street] string * enp.address.street
          enp_address_type[postcode] string * enp.address.postcode
          enp_address_type[city] string * enp.address.city
          enp_address_type[first_name] string * enp.address.firstName
          enp_address_type[last_name] string * enp.address.lastName
          enp_address_type[house_number] string * enp.address.houseNumber

          Status Codes

          Status Code Description
          200
          • OK
          401
          • Unauthorized
          403
          • Forbidden
          Input
          Headers

          = -

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/carts/account-address-private-persons dev

          • Set account address for private person in cart
          • Documentation
          • Sandbox

          Parameters

          Parameter Type Required? Format Description
          enp_address_type object (AccountAddressPrivatePersonType) true
          enp_address_type[default] choice false [false,true]
          enp_address_type[enabled] choice false [false,true]
          enp_address_type[address_name] string false
          enp_address_type[email] string false enp.address.email
          enp_address_type[company] string false enp.address.company
          enp_address_type[phone] string false enp.address.phone
          enp_address_type[street] string false enp.address.street
          enp_address_type[postcode] string false enp.address.postcode
          enp_address_type[city] string false enp.address.city
          enp_address_type[first_name] string false enp.address.firstName
          enp_address_type[last_name] string false enp.address.lastName
          enp_address_type[house_number] string false enp.address.houseNumber

          Headers

          Name Required? Description
          Accept true Required header + version
          Content-Type true
          Authorization true Authentication & Authorization
          Content-Website true Sets website in api

          Return

          Parameter Type Versions Description

          200 - OK

          id integer >=1.0
          default custom handler result for (bool) >=1.0
          first_name string >=1.0
          last_name string >=1.0
          email string >=1.0
          phone_number string >=1.0
          phone_prefix string >=1.0
          street string >=1.0
          city string >=1.0
          house_number string >=1.0
          apartment_number string >=1.0
          postcode string >=1.0
          province string >=1.0
          country string >=1.0
          address_type string >=1.0
          enabled custom handler result for (bool) >=1.0
          name string >=1.0

          Status Codes

          Status Code Description
          200
          • OK
          401
          • Unauthorized
          403
          • Forbidden
          Input

          Parameters

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          Headers

          = -

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/carts/account-address-private-persons/statuses
        • GET /api/carts/account-address-private-persons/statuses dev

          • Set account address in cart
          • Documentation
          • Sandbox

          Headers

          Name Required? Description
          Accept true Required header + version
          Content-Type true
          Authorization true Authentication & Authorization
          Content-Website true Sets website in api

          Return

          Parameter Type Versions Description

          200 - OK

          id integer >=1.0
          default custom handler result for (bool) >=1.0
          first_name string >=1.0
          last_name string >=1.0
          email string >=1.0
          phone_number string >=1.0
          phone_prefix string >=1.0
          street string >=1.0
          city string >=1.0
          house_number string >=1.0
          apartment_number string >=1.0
          postcode string >=1.0
          province string >=1.0
          country string >=1.0
          address_type string >=1.0
          enabled custom handler result for (bool) >=1.0
          name string >=1.0

          Status Codes

          Status Code Description
          200
          • OK
          401
          • Unauthorized
          403
          • Forbidden
          Input
          Headers

          = -

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/carts/billing-address-companies
        • GET /api/carts/billing-address-companies dev

          • Billing address for company form
          • Documentation
          • Sandbox

          Headers

          Name Required? Description
          Accept true Required header + version
          Content-Type true
          Authorization true Authentication & Authorization
          Content-Website true Sets website in api

          Return

          Parameter Type Versions Description

          200 - OK

          enp_address_type object (BillingAddressCompanyType) *
          enp_address_type[default] choice *
          enp_address_type[enabled] choice *
          enp_address_type[address_name] string *
          enp_address_type[email] string * enp.address.email
          enp_address_type[company] string * enp.address.company
          enp_address_type[phone] string * enp.address.phone
          enp_address_type[street] string * enp.address.street
          enp_address_type[postcode] string * enp.address.postcode
          enp_address_type[city] string * enp.address.city
          enp_address_type[first_name] string * enp.address.firstName
          enp_address_type[last_name] string * enp.address.lastName
          enp_address_type[house_number] string * enp.address.houseNumber

          Status Codes

          Status Code Description
          200
          • OK
          401
          • Unauthorized
          403
          • Forbidden
          Input
          Headers

          = -

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/carts/billing-address-companies dev

          • Set billing address for company in cart
          • Documentation
          • Sandbox

          Parameters

          Parameter Type Required? Format Description
          enp_address_type object (BillingAddressCompanyType) true
          enp_address_type[default] choice false [false,true]
          enp_address_type[enabled] choice false [false,true]
          enp_address_type[address_name] string false
          enp_address_type[email] string false enp.address.email
          enp_address_type[company] string false enp.address.company
          enp_address_type[phone] string false enp.address.phone
          enp_address_type[street] string false enp.address.street
          enp_address_type[postcode] string false enp.address.postcode
          enp_address_type[city] string false enp.address.city
          enp_address_type[first_name] string false enp.address.firstName
          enp_address_type[last_name] string false enp.address.lastName
          enp_address_type[house_number] string false enp.address.houseNumber

          Headers

          Name Required? Description
          Accept true Required header + version
          Content-Type true
          Authorization true Authentication & Authorization
          Content-Website true Sets website in api

          Return

          Parameter Type Versions Description

          200 - OK

          id integer >=1.0
          default custom handler result for (bool) >=1.0
          first_name string >=1.0
          last_name string >=1.0
          phone_number string >=1.0
          phone_prefix string >=1.0
          street string >=1.0
          city string >=1.0
          house_number string >=1.0
          apartment_number string >=1.0
          postcode string >=1.0
          province string >=1.0
          country string >=1.0
          nip string >=1.0
          company string >=1.0
          address_type string >=1.0
          email string >=1.0
          enabled custom handler result for (bool) >=1.0
          name string >=1.0

          Status Codes

          Status Code Description
          200
          • OK
          401
          • Unauthorized
          403
          • Forbidden
          Input

          Parameters

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          Headers

          = -

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/carts/billing-address-companies/statuses
        • GET /api/carts/billing-address-companies/statuses dev

          • Set billing address private person in cart
          • Documentation
          • Sandbox

          Headers

          Name Required? Description
          Accept true Required header + version
          Content-Type true
          Authorization true Authentication & Authorization
          Content-Website true Sets website in api

          Return

          Parameter Type Versions Description

          200 - OK

          id integer >=1.0
          default custom handler result for (bool) >=1.0
          first_name string >=1.0
          last_name string >=1.0
          phone_number string >=1.0
          phone_prefix string >=1.0
          street string >=1.0
          city string >=1.0
          house_number string >=1.0
          apartment_number string >=1.0
          postcode string >=1.0
          province string >=1.0
          country string >=1.0
          nip string >=1.0
          company string >=1.0
          address_type string >=1.0
          email string >=1.0
          enabled custom handler result for (bool) >=1.0
          name string >=1.0

          Status Codes

          Status Code Description
          200
          • OK
          401
          • Unauthorized
          403
          • Forbidden
          Input
          Headers

          = -

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/carts/billing-address-private-persons
        • GET /api/carts/billing-address-private-persons dev

          • Billing address for private person form
          • Documentation
          • Sandbox

          Headers

          Name Required? Description
          Accept true Required header + version
          Content-Type true
          Authorization true Authentication & Authorization
          Content-Website true Sets website in api

          Return

          Parameter Type Versions Description

          200 - OK

          enp_address_type object (BillingAddressPrivatePersonType) *
          enp_address_type[default] choice *
          enp_address_type[enabled] choice *
          enp_address_type[address_name] string *
          enp_address_type[email] string * enp.address.email
          enp_address_type[company] string * enp.address.company
          enp_address_type[phone] string * enp.address.phone
          enp_address_type[street] string * enp.address.street
          enp_address_type[postcode] string * enp.address.postcode
          enp_address_type[city] string * enp.address.city
          enp_address_type[first_name] string * enp.address.firstName
          enp_address_type[last_name] string * enp.address.lastName
          enp_address_type[house_number] string * enp.address.houseNumber

          Status Codes

          Status Code Description
          200
          • OK
          401
          • Unauthorized
          403
          • Forbidden
          Input
          Headers

          = -

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/carts/billing-address-private-persons dev

          • Set billing address for private person in cart
          • Documentation
          • Sandbox

          Parameters

          Parameter Type Required? Format Description
          enp_address_type object (BillingAddressPrivatePersonType) true
          enp_address_type[default] choice false [false,true]
          enp_address_type[enabled] choice false [false,true]
          enp_address_type[address_name] string false
          enp_address_type[email] string false enp.address.email
          enp_address_type[company] string false enp.address.company
          enp_address_type[phone] string false enp.address.phone
          enp_address_type[street] string false enp.address.street
          enp_address_type[postcode] string false enp.address.postcode
          enp_address_type[city] string false enp.address.city
          enp_address_type[first_name] string false enp.address.firstName
          enp_address_type[last_name] string false enp.address.lastName
          enp_address_type[house_number] string false enp.address.houseNumber

          Headers

          Name Required? Description
          Accept true Required header + version
          Content-Type true
          Authorization true Authentication & Authorization
          Content-Website true Sets website in api

          Return

          Parameter Type Versions Description

          200 - OK

          id integer >=1.0
          default custom handler result for (bool) >=1.0
          first_name string >=1.0
          last_name string >=1.0
          phone_number string >=1.0
          phone_prefix string >=1.0
          street string >=1.0
          city string >=1.0
          house_number string >=1.0
          apartment_number string >=1.0
          postcode string >=1.0
          province string >=1.0
          country string >=1.0
          address_type string >=1.0
          email string >=1.0
          enabled custom handler result for (bool) >=1.0
          name string >=1.0

          Status Codes

          Status Code Description
          200
          • OK
          401
          • Unauthorized
          403
          • Forbidden
          Input

          Parameters

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          = -

          Headers

          = -

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/carts/billing-address-private-persons/statuses
        • GET /api/carts/billing-address-private-persons/statuses dev

          • Set billing address private person in cart
          • Documentation
          • Sandbox

          Headers

          Name Required? Description
          Accept true Required header + version
          Content-Type true
          Authorization true Authentication & Authorization
          Content-Website true Sets website in api

          Return

          Parameter Type Versions Description

          200 - OK

          id integer >=1.0
          default custom handler result for (bool) >=1.0
          first_name string >=1.0
          last_name string >=1.0
          phone_number string >=1.0
          phone_prefix string >=1.0
          street string >=1.0
          city string >=1.0
          house_number string >=1.0
          apartment_number string >=1.0
          postcode string >=1.0
          province string >=1.0
          country string >=1.0
          address_type string >=1.0
          email string >=1.0
          enabled custom handler result for (bool) >=1.0
          name string >=1.0

          Status Codes

          Status Code Description
          200
          • OK
          401
          • Unauthorized
          403
          • Forbidden
          Input
          Headers

          = -

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
    • /api/carts/comments/orders
        • GET /api/carts/comments/orders dev

          • Get order comment
          • Documentation
          • Sandbox

          Headers

          Name Required? Description
          Accept true Required header + version
          Content-Type true
          Authorization true Authentication & Authorization
          Content-Website true Sets website in api

          Return

          Parameter Type Versions Description

          200 - OK

          Status Codes

          Status Code Description
          200
          • OK
          401
          • Unauthorized
          403
          • Forbidden
          404
          • Not found
          Input
          Headers

          = -

          = -

          = -

          = -

          = -

          Content

          = Replaces header if set

          Request URL

          
          
                                      

          Request body

          
          
                                      

          Response Headers [Expand] [Profiler]

          
          
                                      

          Response Body [Raw]

          
          
                                      

          Curl Command Line

          
                                  
        • POST /api/carts/comments/orders dev

          • Set comment for order
          • Documentation
          • Sandbox

          Requirements

          Name Requirement Type Description
          comment \s+ string Order comment

          Headers

          Name Required? Description
          Accept true Required header + version
          Content-Type true
          Authorization true Authentication & Authorization
          Content-Website true Sets website in api

          Status Codes

          Status Code Description
          201
          • Created
          400
          • Bad request
          401
          • Unauthorized
          403
          • Forbidden
          Input

          Requirements

          = -

          Headers

          = -

          = -

          = -

          = -

          = -

          Content