Skip to main content
API docs by Redocly

Private Financial Documents API (1.0)

Download OpenAPI specification:Download

Team Checkout: team-checkout@newstore.com URL: https://newstore.com

This API is for internal use only.

Financial Document

Documents related to financial concerns.

Retrieve or regenerate return receipt for order_id and refund_id

Retrieve or regenerate return_receipt for a given order. This endpoint will not generate a return receipt if it hasn't been generated before.

Authorizations:
newStoreAccessToken
header Parameters
request-id
string

ID of the request

X-Newstore-Tenant
required
string
Request Body schema: application/json
order_id
required
string = 36 characters

Identifier for the corresponding sales_order

refund_id
required
string = 36 characters

The identifier of the refund related to this return receipt.

print_type
string

Type of the receipt printing operation (document_printed, document_emailed).

Responses

Request samples

Content type
application/json
{
  • "order_id": "stringstringstringstringstringstring",
  • "refund_id": "stringstringstringstringstringstring",
  • "print_type": "string"
}

Response samples

Content type
application/json
{
  • "permanent_link": "string",
  • "vault_data_id": "string",
  • "return_id": "string",
  • "billing_address": {
    },
  • "order_id": "string",
  • "sales_order_uuid": "stringstringstringstringstringstring",
  • "refund_id": "stringstringstringstringstringstring",
  • "external_id": "string",
  • "store_name": "string"
}

Retrieve or generate sales receipt

Retrieve or generate a sales receipt for a given order.

Authorizations:
newStoreAccessToken
header Parameters
request-id
string

ID of the request

X-Newstore-Tenant
required
string
Request Body schema: application/json
order_id
string

The order_id for which the sales receipt should be generated.

Responses

Request samples

Content type
application/json
{
  • "order_id": "70aebf90-d913-4f57-98c3-47d67a40c1c7"
}

Response samples

Content type
application/json
{
  • "permanent_link": "string",
  • "vault_data_id": "string"
}

Retrieve or generate exchange receipt

Retrieve or generate a exchange receipt for a given order.

Authorizations:
newStoreAccessToken
header Parameters
request-id
string

ID of the request

X-Newstore-Tenant
required
string
Request Body schema: application/json
order_id
string

The order_id for which the exchange receipt should be generated.

original_order_id
string

The original order_id for which the exchange receipt should be generated.

return_id
string

The return_id which the exchange receipt should be generated.

Responses

Request samples

Content type
application/json
{
  • "order_id": "70aebf90-d913-4f57-98c3-47d67a40c1c7",
  • "original_order_id": "2c8a4332-d913-4f57-9f0d-4de13ea9a7db",
  • "return_id": "898286f4-b86f-4d1f-ace9-3220286e2725"
}

Response samples

Content type
application/json
{
  • "permanent_link": "string",
  • "vault_data_id": "string"
}

Republish documents created events for a specific order_id

Republish documents created events for a specific order_id:

  • financial_documents.sales_receipt_created
  • financial_documents.return_receipt_created
  • financial_documents.exchange_receipt_created
  • financial_documents.invoice_created
  • financial_documents.refund_note_created
Authorizations:
newStoreAccessToken
path Parameters
order_id
required
string
header Parameters
request-id
string

ID of the request

X-Newstore-Tenant
required
string
tenant
required
string

Responses