CaptureOrder

Capture Order

post

Capture an order by providing the order number and the items to be captured.

Authorizations

Token

AuthorizationstringRequired

Body

application/json

orderstringOptional

Order Number

Example: ORDER12345

Responses

200

Order captured successfully

application/json

pkintegerOptional

Unique identifier for the order.

Example: 1

numberstringRequired

Order number, unique within the context of a channel.

Example: ORDER12345

channelintegerRequired

ID of the channel associated with the order.

customerintegerRequired

ID of the customer who placed the order.

Example: 1

date_placedstring · date-timeRequired

Timestamp when the order was placed.

Example: 2024-11-20T11:22:23.702774Z

payment_optionintegerOptional

ID of the payment option used for the order.

Example: 1

payment_option_slugstring · nullableOptional

Slug of the payment option.

Example: credit-card

bin_numberstring · nullableOptional

First 6 digits of the customer's card used in the transaction.

Example: 123456

installmentintegerOptional

ID of the installment object used for the order.

Example: 1

installment_countinteger · nullableOptional

Number of installments for the payment.

Example: 6

installment_interest_amountnumber · decimalOptional

Interest charged on installment payments.

Example: 50

cargo_companyintegerOptional

ID of the cargo company used for shipping.

Example: 1

is_sendbooleanOptional

Indicates whether the order has been sent.

Example: false

delivery_typestring · enum · nullableOptional

Type of delivery selected for the order.

Example: next_dayPossible values:

cancellation_infoobjectOptional

Details regarding the cancellation of the order.

Example: {"reason":"Customer requested cancellation"}

cancel_statusstring · enum · nullableOptional

Status of the order cancellation.

Example: cancelledPossible values:

shipping_interest_amountnumber · decimalOptional

Interest applied to the shipping cost.

Example: 10

external_statusintegerOptional

ID of the external status associated with the order.

Example: 1

client_typestring · enumOptional

Type of client placing the order.

Example: defaultPossible values:

carrier_shipping_codestring · nullableOptional

Tracking code assigned by the carrier.

Example: TRACK12345

segmentstring · nullableOptional

Customer segment for the order.

Example: premium

checkout_provider_idinteger · nullableOptional

ID of the provider used for checkout.

Example: 12345

statusstring · enumRequired

Status of the order

Example: 200Possible values:

currencystring · enumOptional

Currency type for the order, following ISO 4217 currency codes.

Example: tryPossible values:

amountnumber · decimalRequired

Total amount for the order.

Example: 1000

discount_amountnumber · decimalOptional

Discount applied to the order.

Example: 50

shipping_amountnumber · decimalOptional

Shipping charge for the order.

Example: 20

shipping_tax_ratenumber · decimal · nullableOptional

Tax rate applied to the shipping charge.

Example: 18

refund_amountnumber · decimalOptional

Total refund amount for the order. Shipping refund amount included.

Example: 100

discount_refund_amountnumber · decimalOptional

Refund amount for the discount.

Example: 10

shipping_refund_amountnumber · decimalOptional

Refund amount for the shipping.

Example: 5

invoice_numberstring · nullableOptional

Invoice number for the order.

Example: INV123456

invoice_datestring · date-time · nullableOptional

Invoice date for the order.

Example: 2024-11-21T11:22:23.702774Z

e_archive_urlstring · url · nullableOptional

URL for the e-archive of the invoice.

Example: https://earchive.example.com/invoice/123

tracking_numberstring · nullableOptional

Tracking number for the order.

Example: TRACK12345

defined_tracking_urlstring · url · nullableOptional

URL for tracking the order.

Example: https://tracking.example.com/track/123

shipping_companystring · enumOptional

Shipping company options

Example: yurticiPossible values:

remote_addrstring · ipv4 · nullableOptional

IP address from where the order was placed.

Example: 192.168.0.1

has_gift_boxbooleanOptional

Indicates whether the order has a gift box.

Example: false

gift_box_notestring · nullableOptional

Message for the gift box.

Example: Happy Birthday!

language_codestring · nullableOptional

Language code for the order.

Example: en

notesstring · nullableOptional

Customer instructions for the order.

Example: Leave at the front door.

shipping_option_slugstring · nullableOptional

Slug for the shipping option.

Example: standard-shipping

created_datestring · date-timeOptional

Creation Date

modified_datestring · date-timeOptional

Last Modification Date

401

Unauthorized Access

application/json

post

/api/v1/capture-order/

HTTPcURLJavaScriptPython

POST /api/v1/capture-order/ HTTP/1.1
Authorization: YOUR_API_KEY
Content-Type: application/json
Accept: */*
Content-Length: 39

{
  "order": "ORDER12345",
  "order_items": []
}

{
  "pk": 1,
  "number": "ORDER12345",
  "channel": 1,
  "customer": 1,
  "date_placed": "2024-11-20T11:22:23.702774Z",
  "extra_field": {
    "special_note": "Handle with care"
  },
  "payment_option": 1,
  "payment_option_slug": "credit-card",
  "bin_number": "123456",
  "installment": 1,
  "installment_count": 6,
  "installment_interest_amount": 50,
  "cargo_company": 1,
  "is_send": false,
  "delivery_type": "next_day",
  "cancellation_info": {
    "reason": "Customer requested cancellation"
  },
  "cancel_status": "cancelled",
  "shipping_interest_amount": 10,
  "external_status": 1,
  "client_type": "default",
  "carrier_shipping_code": "TRACK12345",
  "segment": "premium",
  "checkout_provider_id": 12345,
  "status": 200,
  "currency": "try",
  "amount": 1000,
  "discount_amount": 50,
  "shipping_amount": 20,
  "shipping_tax_rate": 18,
  "refund_amount": 100,
  "discount_refund_amount": 10,
  "shipping_refund_amount": 5,
  "invoice_number": "INV123456",
  "invoice_date": "2024-11-21T11:22:23.702774Z",
  "e_archive_url": "https://earchive.example.com/invoice/123",
  "tracking_number": "TRACK12345",
  "defined_tracking_url": "https://tracking.example.com/track/123",
  "shipping_company": "yurtici",
  "remote_addr": "192.168.0.1",
  "has_gift_box": false,
  "gift_box_note": "Happy Birthday!",
  "language_code": "en",
  "notes": "Leave at the front door.",
  "delivery_range": {
    "start": "2026-03-07T03:09:56.475Z",
    "end": "2026-03-07T03:09:56.475Z"
  },
  "shipping_option_slug": "standard-shipping",
  "created_date": "2026-03-07T03:09:56.475Z",
  "modified_date": "2026-03-07T03:09:56.475Z"
}