> ## Documentation Index
> Fetch the complete documentation index at: https://br.developers.hubspot.com/docs/llms.txt
> Use this file to discover all available pages before exploring further.

# Retrieve shipping settings

> Recupere as configurações de envio atuais da sua conta HubSpot. Este endpoint fornece informações sobre as opções de envio configuradas, o que pode ser útil para gerenciar e revisar suas políticas e configurações de envio.

> **Supported products**

> **Required Scopes**


## OpenAPI

````yaml specs/2027-03-beta/commerce-payments-settings-v2027-03-beta.json GET /commerce/payments-settings/2027-03-beta/payments-settings/shipping
openapi: 3.0.1
info:
  title: Commerce Payments Settings
  description: Basepom for all HubSpot Projects
  version: 2027-03-beta
  x-hubspot-product-tier-requirements:
    marketing: FREE
    sales: FREE
    service: FREE
    cms: FREE
    commerce: FREE
    crmHub: FREE
    dataHub: FREE
servers:
  - url: https://api.hubapi.com
security: []
tags:
  - name: Basic
paths:
  /commerce/payments-settings/2027-03-beta/payments-settings/shipping:
    get:
      tags:
        - Basic
      summary: Recuperar configurações de envio
      description: >-
        Recupere as configurações de envio atuais da sua conta HubSpot. Este
        endpoint fornece informações sobre as opções de envio configuradas, o
        que pode ser útil para gerenciar e revisar suas políticas e
        configurações de envio.
      operationId: get-/commerce/payments-settings/2027-03-beta/payments-settings/shipping
      parameters: []
      responses:
        '200':
          description: successful operation
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetShippingSettingsPublicResponse'
        default:
          $ref: '#/components/responses/Error'
          description: ''
      security:
        - oauth2:
            - crm.objects.invoices.read
        - oauth2:
            - crm.schemas.invoices.read
        - oauth2:
            - cpq.quotes.write
        - oauth2:
            - crm.objects.quotes.read
        - oauth2:
            - crm.schemas.quotes.read
        - oauth2:
            - cpq.quotes.read
        - oauth2:
            - crm.schemas.subscriptions.read
        - oauth2:
            - crm.objects.subscriptions.read
components:
  schemas:
    GetShippingSettingsPublicResponse:
      required:
        - collectShippingAddressByDefault
        - countriesShippedTo
      type: object
      properties:
        collectShippingAddressByDefault:
          type: boolean
          description: >-
            Um booleano que indica se o endereço de entrega é coletado por
            padrão.
        countriesShippedTo:
          type: array
          description: >-
            Uma matriz de strings que representa a lista de países para os quais
            o envio está disponível. São usados códigos de país ISO de dois
            dígitos.
          items:
            type: string
    Error:
      required:
        - category
        - correlationId
        - message
      type: object
      properties:
        category:
          type: string
          description: A categoria de erro.
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: >-
            Contexto sobre a condição de erro, representado como um objeto com
            propriedades adicionais.
          example: >-
            {invalidPropertyName=[propertyValue], missingScopes=[scope1,
            scope2]}
        correlationId:
          type: string
          description: >-
            Um identificador exclusivo para a solicitação. Inclua este valor em
            quaisquer relatórios de erro ou tickets de suporte. Formato: UUID.
          format: uuid
          example: aeb5f871-7f07-4993-9211-075dc63e7cbf
        errors:
          type: array
          description: >-
            Mais informações sobre o erro, representadas como uma matriz de
            objetos ErrorDetail.
          items:
            $ref: '#/components/schemas/ErrorDetail'
        links:
          type: object
          additionalProperties:
            type: string
          description: >-
            Um mapa de nomes de links para URIs associados que contêm
            documentação sobre o erro ou etapas de correção recomendadas.
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado.
          example: An error occurred
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém detalhes mais específicos sobre
            o erro. Esta é uma propriedade de string.
      description: >-
        Representa uma resposta de erro retornada pela API quando uma operação
        falha. Este componente é usado em vários endpoints para fornecer
        informações detalhadas sobre o erro encontrado.
      example:
        message: Invalid input (details will vary based on the error)
        correlationId: aeb5f871-7f07-4993-9211-075dc63e7cbf
        category: VALIDATION_ERROR
        links:
          knowledge-base: https://www.hubspot.com/products/service/knowledge-base
    ErrorDetail:
      required:
        - message
      type: object
      properties:
        code:
          type: string
          description: >-
            O código de status associado ao detalhe do erro, representado como
            uma string.
        context:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: >-
            Contexto sobre a condição de erro, representado como um objeto. Pode
            incluir propriedades adicionais, cada uma contendo um array de
            strings, para fornecer informações mais detalhadas sobre o erro.
          example: '{missingScopes=[scope1, scope2]}'
        in:
          type: string
          description: >-
            O nome do campo ou parâmetro em que o erro foi encontrado. É uma
            string que ajuda a identificar a origem do erro.
        message:
          type: string
          description: >-
            Uma mensagem legível por humanos que descreve o erro, juntamente com
            as etapas de correção, quando apropriado. Esta é uma propriedade de
            string obrigatória.
        subCategory:
          type: string
          description: >-
            Uma categoria específica que contém detalhes mais específicos sobre
            o erro, fornecendo uma classificação adicional.
      description: >-
        Representa informações detalhadas sobre um erro ocorrido na API. Este
        componente é usado para fornecer contexto e detalhes adicionais sobre os
        erros, geralmente como parte de uma resposta de erro.
  responses:
    Error:
      description: An error occurred.
      content:
        '*/*':
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    oauth2:
      type: oauth2
      flows:
        authorizationCode:
          authorizationUrl: https://app.hubspot.com/oauth/authorize
          tokenUrl: https://api.hubapi.com/oauth/v1/token
          scopes:
            cpq.quotes.read: ''
            cpq.quotes.write: ''
            crm.objects.invoices.read: ''
            crm.objects.quotes.read: ''
            crm.objects.subscriptions.read: ''
            crm.schemas.invoices.read: ''
            crm.schemas.quotes.read: ''
            crm.schemas.subscriptions.read: ''

````