Skip to main content
POST
Adicionar endereço

Authorizations

Authorization
string
header
required

Autenticação via chave de API. Use publicKey:secretKey codificado em Base64 no header Authorization: Basic {credentials}.

Path Parameters

id
string
required

ID do submerchant

Body

application/json
street
string
required

Logradouro

Required string length: 1 - 255
number
string
required

Número

Required string length: 1 - 20
neighborhood
string
required

Bairro

Required string length: 1 - 100
city
string
required

Cidade

Required string length: 1 - 100
state
string
required

UF

Required string length: 2
zip_code
string
required

CEP

Required string length: 8 - 10
type
enum<string>
Available options:
billing,
shipping,
both
complement
string

Complemento

Maximum string length: 100
country
string
Required string length: 2
is_primary
boolean

Response

Endereço criado

success
boolean
Example:

true

message
string
data
object