Atualizar Descrição do Pedido

Atualizar descrição e metadata do pedido

patch

https://api.barte.comhttps://sandbox-api.barte.com

/v2/orders/{uuid}

Atualiza a descrição e/ou metadata de um pedido específico

Authorizations

ApiKeyAuth

X-Token-ApistringRequired

Token de autenticação para acesso à API

Path parameters

uuidstring · uuidRequired

UUID do pedido

Header parameters

X-Token-ApistringRequired

Token de autenticação para acesso à API

Content-Typestring · enumOptional

Tipo de conteúdo da requisição

Possible values:

Body

application/json

descriptionstring · max: 300OptionalExample: Nova descrição do pedido

Responses

200

Pedido atualizado com sucesso

application/json

uuidstring · uuidOptionalExample: e82c66cc-cdf6-4253-87b2-ed339d3b9669

statusstring · enumOptionalExample: PAIDPossible values:

titlestring · max: 60OptionalExample: Teste

descriptionstring · max: 300Optional

valuenumber · doubleOptionalExample: 100

installmentsintegerOptionalExample: 5

startDatestring · dateOptional

Data de início da cobrança.

Example: 2025-10-14

paymentstring · enumOptionalExample: CREDIT_CARD_EARLY_SELLERPossible values:

idempotencyKeystring · uuidOptionalExample: b6cf42ba-3b64-4587-ba91-eec18465d091

204

Pedido atualizado com sucesso (sem conteúdo)

400

Erro de validação

application/json

401

Token inativo ou inexistente

application/json

403

Acesso negado

application/json

404

Pedido não encontrado

application/json

429

Muitas requisições

application/json

500

Erro interno do servidor

application/json

patch

/v2/orders/{uuid}

HTTPcURLJavaScriptPython

PATCH /v2/orders/{uuid} HTTP/1.1
Host: api.barte.com
X-Token-Api: text
Content-Type: application/json
Accept: */*
Content-Length: 89

{
  "metadata": [
    {
      "key": "código",
      "value": "YMC"
    }
  ],
  "description": "Nova descrição do pedido"
}

{
  "uuid": "e82c66cc-cdf6-4253-87b2-ed339d3b9669",
  "status": "PAID",
  "title": "Teste",
  "description": "",
  "value": 100,
  "installments": 5,
  "startDate": "2025-10-14",
  "payment": "CREDIT_CARD_EARLY_SELLER",
  "customer": {
    "uuid": "",
    "document": "001052647",
    "type": "SSN",
    "documentCountry": "US",
    "name": "Joshua Henry",
    "email": "[email protected]",
    "phone": "9409822523",
    "alternativeEmail": ""
  },
  "idempotencyKey": "b6cf42ba-3b64-4587-ba91-eec18465d091",
  "subSellerPaymentResponse": [
    {
      "subSellerPaymentResponse": [
        {}
      ],
      "amountForSubSellers": 0
    }
  ],
  "charges": [
    {
      "uuid": "f337e5a4-62a3-41af-8449-c9898f1de66b",
      "title": "Teste",
      "expirationDate": "2025-10-14",
      "paidDate": "2025-10-14",
      "value": 100,
      "paymentMethod": "CREDIT_CARD_EARLY_SELLER",
      "status": "PAID",
      "customer": {
        "uuid": "",
        "document": "001052647",
        "type": "SSN",
        "documentCountry": "US",
        "name": "Joshua Henry",
        "email": "[email protected]",
        "phone": "9409822523",
        "alternativeEmail": ""
      },
      "authorizationCode": "488713",
      "authorizationNsu": "154054",
      "refunds": [
        {}
      ],
      "retryable": false,
      "fee": 0.49
    }
  ]
}