API docs by Redocly

Repzo API - Cart (1.0.0)

Download OpenAPI specification:Download

OpenAPI specification for Repzo Cart endpoints.

Find carts

query Parameters
object

Query parameters for filtering carts

Responses

Response samples

Content type
application/json
{
  • "data": [
    ],
  • "total_result": 0,
  • "current_count": 0,
  • "total_pages": 0,
  • "current_page": 0,
  • "per_page": 0,
  • "first_page_url": "string",
  • "last_page_url": "string",
  • "next_page_url": "string",
  • "prev_page_url": "string",
  • "path": "string"
}

Create a cart

Request Body schema: application/json
type
required
string
Enum: "invoice" "proforma"

Cart type

processable
boolean

Whether the cart is processable

failure_reasons
required
Array of strings

List of failure reasons

external_serial_number
string

External serial number

skip_promos
boolean

Skip promotions flag

Array of objects

List of skipped promotions

client_id
required
string

Client ID

client_name
required
string

Client name

comment
string

Cart comment

return_comment
string

Return comment

object

Cart creator

object

Cart implementer

latest
required
boolean

Latest version flag

version
number

Cart version

time
number

Cart timestamp

issue_date
required
string <date>

Issue date

delivery_date
string <date>

Delivery date

currency
required
string

Currency code

object

Serial number

required
object

Geographic location

sync_id
required
string

Sync ID

object

Address information

company_namespace
required
Array of strings

Company namespaces

promotions
required
Array of objects

Applied promotions

priceLists
required
Array of objects

Price lists

visit_id
string

Visit ID

teams
required
Array of strings

Team IDs

object

Cart converter

object

Converted proforma serial number

object

Converted proforma return serial number

proforma_reference
string

Proforma reference

converted_at
number

Conversion timestamp

exclude_return_items
boolean

Exclude return items flag

returned_from
string

Returned from

returned_to
string

Returned to

object

Returned from serial number

object

Returned to serial number

partiall_returned_from
string

Partially returned from

object

Partially returned from serial number

due_date
string <date>

Due date

object

Return serial number

origin_warehouse
string

Origin warehouse

msl_sales
string

MSL sales

route
string

Route

required
object

Payment data

required
object

Consumption data

subtotal
number

Subtotal

discount_amount
number

Discount amount

discount_amount_float
number

Discount amount float

taxable_subtotal
number

Taxable subtotal

net_total
number

Net total

tax_amount
number

Tax amount

tax_amount_after_deduction_float
number

Tax amount after deduction float

tax_amount_after_deduction_float_rounded_sum
number

Tax amount after deduction float rounded sum

tax_amount_after_deduction_float_rounded
number

Tax amount after deduction float rounded

total
number

Total amount

total_float
number

Total float

total_float_rounded
number

Total float rounded

total_float_rounded_sum
number

Total float rounded sum

total_before_tax
number

Total before tax

taxable_amount_float
number

Taxable amount float

taxable_amount_float_rounded_sum
number

Taxable amount float rounded sum

taxable_amount_float_rounded
number

Taxable amount float rounded

pre_subtotal
number

Pre-subtotal

pre_discount_amount
number

Pre-discount amount

pre_discount_amount_float
number

Pre-discount amount float

pre_taxable_subtotal
number

Pre-taxable subtotal

pre_net_total
number

Pre-net total

pre_tax_amount
number

Pre-tax amount

pre_tax_amount_after_deduction_float
number

Pre-tax amount after deduction float

pre_tax_amount_after_deduction_float_rounded
number

Pre-tax amount after deduction float rounded

pre_tax_amount_after_deduction_float_rounded_sum
number

Pre-tax amount after deduction float rounded sum

pre_total
number

Pre-total

pre_total_float
number

Pre-total float

pre_total_float_rounded
number

Pre-total float rounded

pre_total_float_rounded_sum
number

Pre-total float rounded sum

pre_total_before_tax
number

Pre-total before tax

pre_taxable_amount_float
number

Pre-taxable amount float

pre_taxable_amount_float_rounded
number

Pre-taxable amount float rounded

pre_taxable_amount_float_rounded_sum
number

Pre-taxable amount float rounded sum

return_subtotal
number

Return subtotal

return_discount_amount
number

Return discount amount

return_discount_amount_float
number

Return discount amount float

return_taxable_subtotal
number

Return taxable subtotal

return_net_total
number

Return net total

return_tax_amount
number

Return tax amount

return_tax_amount_after_deduction_float
number

Return tax amount after deduction float

return_tax_amount_after_deduction_float_rounded
number

Return tax amount after deduction float rounded

return_tax_amount_after_deduction_float_rounded_sum
number

Return tax amount after deduction float rounded sum

return_total
number

Return total

return_total_float
number

Return total float

return_total_float_rounded
number

Return total float rounded

return_total_float_rounded_sum
number

Return total float rounded sum

return_total_before_tax
number

Return total before tax

return_taxable_amount_float
number

Return taxable amount float

return_taxable_amount_float_rounded
number

Return taxable amount float rounded

return_taxable_amount_float_rounded_sum
number

Return taxable amount float rounded sum

deductionRatio
number

Deduction ratio

deductionFixed
number

Fixed deduction

totalDeductedTax
number

Total deducted tax

totalDeductedTaxFloat
number

Total deducted tax float

totalDeduction
number

Total deduction

totalDeductionFloat
number

Total deduction float

totalDeductionBeforeTax
number

Total deduction before tax

totalDeductionBeforeTaxFloat
number

Total deduction before tax float

totalAfterDeduction
number

Total after deduction

totalAfterDeductionFloat
number

Total after deduction float

lines_discount
number

Lines discount

lines_discount_float
number

Lines discount float

object

Tax information

overwriteDeductionFixed
number

Overwrite deduction fixed

overwriteTaxExempt
boolean

Overwrite tax exempt

tax_exempt
boolean

Tax exempt flag

overwriteDeductionRatio
number

Overwrite deduction ratio

object

Shipping zone

object

Payment method

shipping_price
number

Shipping price

shipping_tax
number

Shipping tax

shipping_charge
number

Shipping charge

payment_charge
number

Payment charge

total_with_charges
number

Total with charges

object

Payment information

workorder
string

Work order

asset
string

Asset

asset_unit
string

Asset unit

signature
string

Signature

createdAt
required
string <date-time>

Creation timestamp

updatedAt
required
string <date-time>

Last update timestamp

items
required
Array of objects

Cart items

return_items
Array of objects

Return items

invoice_payment_type
required
string
Enum: "cash" "credit"

Invoice payment type

total_items_base_unit_qty
number

Total items base unit quantity

total_items_qty
number

Total items quantity

total_return_items_base_unit_qty
number

Total return items base unit quantity

total_return_items_qty
number

Total return items quantity

object

Cart data

Responses

Request samples

Content type
application/json
{
  • "type": "invoice",
  • "processable": true,
  • "failure_reasons": [
    ],
  • "external_serial_number": "string",
  • "skip_promos": true,
  • "skipped_promotions": [
    ],
  • "client_id": "string",
  • "client_name": "string",
  • "comment": "string",
  • "return_comment": "string",
  • "creator": {
    },
  • "implemented_by": {
    },
  • "latest": true,
  • "version": 0,
  • "time": 0,
  • "issue_date": "2019-08-24",
  • "delivery_date": "2019-08-24",
  • "currency": "string",
  • "serial_number": {
    },
  • "geo_tag": {
    },
  • "sync_id": "string",
  • "address": { },
  • "company_namespace": [
    ],
  • "promotions": [
    ],
  • "priceLists": [
    ],
  • "visit_id": "string",
  • "teams": [
    ],
  • "converter": {
    },
  • "converted_proforma_serial_number": {
    },
  • "converted_proforma_return_serial_number": {
    },
  • "proforma_reference": "string",
  • "converted_at": 0,
  • "exclude_return_items": true,
  • "returned_from": "string",
  • "returned_to": "string",
  • "returned_from_serial_number": {
    },
  • "returned_to_serial_number": {
    },
  • "partiall_returned_from": "string",
  • "partiall_returned_from_serial_number": {
    },
  • "due_date": "2019-08-24",
  • "return_serial_number": {
    },
  • "origin_warehouse": "string",
  • "msl_sales": "string",
  • "route": "string",
  • "paymentsData": {
    },
  • "consumption": {
    },
  • "subtotal": 0,
  • "discount_amount": 0,
  • "discount_amount_float": 0,
  • "taxable_subtotal": 0,
  • "net_total": 0,
  • "tax_amount": 0,
  • "tax_amount_after_deduction_float": 0,
  • "tax_amount_after_deduction_float_rounded_sum": 0,
  • "tax_amount_after_deduction_float_rounded": 0,
  • "total": 0,
  • "total_float": 0,
  • "total_float_rounded": 0,
  • "total_float_rounded_sum": 0,
  • "total_before_tax": 0,
  • "taxable_amount_float": 0,
  • "taxable_amount_float_rounded_sum": 0,
  • "taxable_amount_float_rounded": 0,
  • "pre_subtotal": 0,
  • "pre_discount_amount": 0,
  • "pre_discount_amount_float": 0,
  • "pre_taxable_subtotal": 0,
  • "pre_net_total": 0,
  • "pre_tax_amount": 0,
  • "pre_tax_amount_after_deduction_float": 0,
  • "pre_tax_amount_after_deduction_float_rounded": 0,
  • "pre_tax_amount_after_deduction_float_rounded_sum": 0,
  • "pre_total": 0,
  • "pre_total_float": 0,
  • "pre_total_float_rounded": 0,
  • "pre_total_float_rounded_sum": 0,
  • "pre_total_before_tax": 0,
  • "pre_taxable_amount_float": 0,
  • "pre_taxable_amount_float_rounded": 0,
  • "pre_taxable_amount_float_rounded_sum": 0,
  • "return_subtotal": 0,
  • "return_discount_amount": 0,
  • "return_discount_amount_float": 0,
  • "return_taxable_subtotal": 0,
  • "return_net_total": 0,
  • "return_tax_amount": 0,
  • "return_tax_amount_after_deduction_float": 0,
  • "return_tax_amount_after_deduction_float_rounded": 0,
  • "return_tax_amount_after_deduction_float_rounded_sum": 0,
  • "return_total": 0,
  • "return_total_float": 0,
  • "return_total_float_rounded": 0,
  • "return_total_float_rounded_sum": 0,
  • "return_total_before_tax": 0,
  • "return_taxable_amount_float": 0,
  • "return_taxable_amount_float_rounded": 0,
  • "return_taxable_amount_float_rounded_sum": 0,
  • "deductionRatio": 0,
  • "deductionFixed": 0,
  • "totalDeductedTax": 0,
  • "totalDeductedTaxFloat": 0,
  • "totalDeduction": 0,
  • "totalDeductionFloat": 0,
  • "totalDeductionBeforeTax": 0,
  • "totalDeductionBeforeTaxFloat": 0,
  • "totalAfterDeduction": 0,
  • "totalAfterDeductionFloat": 0,
  • "lines_discount": 0,
  • "lines_discount_float": 0,
  • "taxes": { },
  • "overwriteDeductionFixed": 0,
  • "overwriteTaxExempt": true,
  • "tax_exempt": true,
  • "overwriteDeductionRatio": 0,
  • "shipping_zone": { },
  • "payment_method": { },
  • "shipping_price": 0,
  • "shipping_tax": 0,
  • "shipping_charge": 0,
  • "payment_charge": 0,
  • "total_with_charges": 0,
  • "payment": {
    },
  • "workorder": "string",
  • "asset": "string",
  • "asset_unit": "string",
  • "signature": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "items": [
    ],
  • "return_items": [
    ],
  • "invoice_payment_type": "cash",
  • "total_items_base_unit_qty": 0,
  • "total_items_qty": 0,
  • "total_return_items_base_unit_qty": 0,
  • "total_return_items_qty": 0,
  • "cart": { }
}

Response samples

Content type
application/json
{
  • "_id": "string",
  • "type": "invoice",
  • "processable": true,
  • "failure_reasons": [
    ],
  • "external_serial_number": "string",
  • "qr_code_tlv": "string",
  • "skip_promos": true,
  • "skipped_promotions": [
    ],
  • "client_id": "string",
  • "client_name": "string",
  • "comment": "string",
  • "return_comment": "string",
  • "creator": {
    },
  • "implemented_by": {
    },
  • "latest": true,
  • "version": 0,
  • "time": 0,
  • "issue_date": "2019-08-24",
  • "delivery_date": "2019-08-24",
  • "currency": "string",
  • "serial_number": {
    },
  • "geo_tag": {
    },
  • "sync_id": "string",
  • "address": { },
  • "company_namespace": [
    ],
  • "promotions": [
    ],
  • "priceLists": [
    ],
  • "visit_id": "string",
  • "teams": [
    ],
  • "converter": {
    },
  • "converted_proforma_serial_number": {
    },
  • "converted_proforma_return_serial_number": {
    },
  • "proforma_reference": "string",
  • "converted_at": 0,
  • "exclude_return_items": true,
  • "returned_from": "string",
  • "returned_to": "string",
  • "returned_from_serial_number": {
    },
  • "returned_to_serial_number": {
    },
  • "partiall_returned_from": "string",
  • "partiall_returned_from_serial_number": {
    },
  • "due_date": "2019-08-24",
  • "return_serial_number": {
    },
  • "origin_warehouse": "string",
  • "msl_sales": "string",
  • "route": "string",
  • "paymentsData": {
    },
  • "consumption": {
    },
  • "subtotal": 0,
  • "discount_amount": 0,
  • "discount_amount_float": 0,
  • "taxable_subtotal": 0,
  • "net_total": 0,
  • "tax_amount": 0,
  • "tax_amount_after_deduction_float": 0,
  • "tax_amount_after_deduction_float_rounded_sum": 0,
  • "tax_amount_after_deduction_float_rounded": 0,
  • "total": 0,
  • "total_float": 0,
  • "total_float_rounded": 0,
  • "total_float_rounded_sum": 0,
  • "total_before_tax": 0,
  • "taxable_amount_float": 0,
  • "taxable_amount_float_rounded_sum": 0,
  • "taxable_amount_float_rounded": 0,
  • "pre_subtotal": 0,
  • "pre_discount_amount": 0,
  • "pre_discount_amount_float": 0,
  • "pre_taxable_subtotal": 0,
  • "pre_net_total": 0,
  • "pre_tax_amount": 0,
  • "pre_tax_amount_after_deduction_float": 0,
  • "pre_tax_amount_after_deduction_float_rounded": 0,
  • "pre_tax_amount_after_deduction_float_rounded_sum": 0,
  • "pre_total": 0,
  • "pre_total_float": 0,
  • "pre_total_float_rounded": 0,
  • "pre_total_float_rounded_sum": 0,
  • "pre_total_before_tax": 0,
  • "pre_taxable_amount_float": 0,
  • "pre_taxable_amount_float_rounded": 0,
  • "pre_taxable_amount_float_rounded_sum": 0,
  • "return_subtotal": 0,
  • "return_discount_amount": 0,
  • "return_discount_amount_float": 0,
  • "return_taxable_subtotal": 0,
  • "return_net_total": 0,
  • "return_tax_amount": 0,
  • "return_tax_amount_after_deduction_float": 0,
  • "return_tax_amount_after_deduction_float_rounded": 0,
  • "return_tax_amount_after_deduction_float_rounded_sum": 0,
  • "return_total": 0,
  • "return_total_float": 0,
  • "return_total_float_rounded": 0,
  • "return_total_float_rounded_sum": 0,
  • "return_total_before_tax": 0,
  • "return_taxable_amount_float": 0,
  • "return_taxable_amount_float_rounded": 0,
  • "return_taxable_amount_float_rounded_sum": 0,
  • "deductionRatio": 0,
  • "deductionFixed": 0,
  • "totalDeductedTax": 0,
  • "totalDeductedTaxFloat": 0,
  • "totalDeduction": 0,
  • "totalDeductionFloat": 0,
  • "totalDeductionBeforeTax": 0,
  • "totalDeductionBeforeTaxFloat": 0,
  • "totalAfterDeduction": 0,
  • "totalAfterDeductionFloat": 0,
  • "lines_discount": 0,
  • "lines_discount_float": 0,
  • "taxes": { },
  • "overwriteDeductionFixed": 0,
  • "overwriteTaxExempt": true,
  • "tax_exempt": true,
  • "overwriteDeductionRatio": 0,
  • "shipping_zone": { },
  • "payment_method": { },
  • "shipping_price": 0,
  • "shipping_tax": 0,
  • "shipping_charge": 0,
  • "payment_charge": 0,
  • "total_with_charges": 0,
  • "payment": {
    },
  • "workorder": "string",
  • "asset": "string",
  • "asset_unit": "string",
  • "signature": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "items": [
    ],
  • "return_items": [
    ],
  • "invoice_payment_type": "cash",
  • "total_items_base_unit_qty": 0,
  • "total_items_qty": 0,
  • "total_return_items_base_unit_qty": 0,
  • "total_return_items_qty": 0,
  • "cart": { },
  • "__v": 0
}

Get a cart by ID

path Parameters
id
required
string

Responses

Response samples

Content type
application/json
{
  • "_id": "string",
  • "type": "invoice",
  • "processable": true,
  • "failure_reasons": [
    ],
  • "external_serial_number": "string",
  • "qr_code_tlv": "string",
  • "skip_promos": true,
  • "skipped_promotions": [
    ],
  • "client_id": "string",
  • "client_name": "string",
  • "comment": "string",
  • "return_comment": "string",
  • "creator": {
    },
  • "implemented_by": {
    },
  • "latest": true,
  • "version": 0,
  • "time": 0,
  • "issue_date": "2019-08-24",
  • "delivery_date": "2019-08-24",
  • "currency": "string",
  • "serial_number": {
    },
  • "geo_tag": {
    },
  • "sync_id": "string",
  • "address": { },
  • "company_namespace": [
    ],
  • "promotions": [
    ],
  • "priceLists": [
    ],
  • "visit_id": "string",
  • "teams": [
    ],
  • "converter": {
    },
  • "converted_proforma_serial_number": {
    },
  • "converted_proforma_return_serial_number": {
    },
  • "proforma_reference": "string",
  • "converted_at": 0,
  • "exclude_return_items": true,
  • "returned_from": "string",
  • "returned_to": "string",
  • "returned_from_serial_number": {
    },
  • "returned_to_serial_number": {
    },
  • "partiall_returned_from": "string",
  • "partiall_returned_from_serial_number": {
    },
  • "due_date": "2019-08-24",
  • "return_serial_number": {
    },
  • "origin_warehouse": "string",
  • "msl_sales": "string",
  • "route": "string",
  • "paymentsData": {
    },
  • "consumption": {
    },
  • "subtotal": 0,
  • "discount_amount": 0,
  • "discount_amount_float": 0,
  • "taxable_subtotal": 0,
  • "net_total": 0,
  • "tax_amount": 0,
  • "tax_amount_after_deduction_float": 0,
  • "tax_amount_after_deduction_float_rounded_sum": 0,
  • "tax_amount_after_deduction_float_rounded": 0,
  • "total": 0,
  • "total_float": 0,
  • "total_float_rounded": 0,
  • "total_float_rounded_sum": 0,
  • "total_before_tax": 0,
  • "taxable_amount_float": 0,
  • "taxable_amount_float_rounded_sum": 0,
  • "taxable_amount_float_rounded": 0,
  • "pre_subtotal": 0,
  • "pre_discount_amount": 0,
  • "pre_discount_amount_float": 0,
  • "pre_taxable_subtotal": 0,
  • "pre_net_total": 0,
  • "pre_tax_amount": 0,
  • "pre_tax_amount_after_deduction_float": 0,
  • "pre_tax_amount_after_deduction_float_rounded": 0,
  • "pre_tax_amount_after_deduction_float_rounded_sum": 0,
  • "pre_total": 0,
  • "pre_total_float": 0,
  • "pre_total_float_rounded": 0,
  • "pre_total_float_rounded_sum": 0,
  • "pre_total_before_tax": 0,
  • "pre_taxable_amount_float": 0,
  • "pre_taxable_amount_float_rounded": 0,
  • "pre_taxable_amount_float_rounded_sum": 0,
  • "return_subtotal": 0,
  • "return_discount_amount": 0,
  • "return_discount_amount_float": 0,
  • "return_taxable_subtotal": 0,
  • "return_net_total": 0,
  • "return_tax_amount": 0,
  • "return_tax_amount_after_deduction_float": 0,
  • "return_tax_amount_after_deduction_float_rounded": 0,
  • "return_tax_amount_after_deduction_float_rounded_sum": 0,
  • "return_total": 0,
  • "return_total_float": 0,
  • "return_total_float_rounded": 0,
  • "return_total_float_rounded_sum": 0,
  • "return_total_before_tax": 0,
  • "return_taxable_amount_float": 0,
  • "return_taxable_amount_float_rounded": 0,
  • "return_taxable_amount_float_rounded_sum": 0,
  • "deductionRatio": 0,
  • "deductionFixed": 0,
  • "totalDeductedTax": 0,
  • "totalDeductedTaxFloat": 0,
  • "totalDeduction": 0,
  • "totalDeductionFloat": 0,
  • "totalDeductionBeforeTax": 0,
  • "totalDeductionBeforeTaxFloat": 0,
  • "totalAfterDeduction": 0,
  • "totalAfterDeductionFloat": 0,
  • "lines_discount": 0,
  • "lines_discount_float": 0,
  • "taxes": { },
  • "overwriteDeductionFixed": 0,
  • "overwriteTaxExempt": true,
  • "tax_exempt": true,
  • "overwriteDeductionRatio": 0,
  • "shipping_zone": { },
  • "payment_method": { },
  • "shipping_price": 0,
  • "shipping_tax": 0,
  • "shipping_charge": 0,
  • "payment_charge": 0,
  • "total_with_charges": 0,
  • "payment": {
    },
  • "workorder": "string",
  • "asset": "string",
  • "asset_unit": "string",
  • "signature": "string",
  • "createdAt": "2019-08-24T14:15:22Z",
  • "updatedAt": "2019-08-24T14:15:22Z",
  • "items": [
    ],
  • "return_items": [
    ],
  • "invoice_payment_type": "cash",
  • "total_items_base_unit_qty": 0,
  • "total_items_qty": 0,
  • "total_return_items_base_unit_qty": 0,
  • "total_return_items_qty": 0,
  • "cart": { },
  • "__v": 0
}