--- title: "Retrieves a list of draft orders" method: GET path: "/admin/draft_orders.json" tags: ["DraftOrder"] --- # Retrieves a list of draft orders `GET /admin/draft_orders.json` Retrieves a list of draft orders. ## Path parameters - `fields` string, required - `limit` number, required - `since_id` number, required - `updated_at_min` string, required - `updated_at_max` string, required - `ids` number, required - `status` string, required ## Response `200` OK - DraftOrdersSwaggerResponse - `draft_orders` OrderDto[] - `access_key` string — Access key - `additional_information` AdditionalInformation - `ASN` integer — ASN - `IPS` string — Internet Service Provider - `city` string — City - `country` string — Country - `hostname` string — Host name - `latitude` string — Latitude - `longitude` string — Longtitude - `organization` string — Organization - `region` string — Region - `timezone` string — Time zone - `applied_discount` AppliedDiscount - `amount` string — Discount amount - `description` string — Discount description - `title` string — Discount title - `value` string — Discount value - `value_type` string — Discount value type - `balance` number — Order balance - `billing_address` CustomerAddressDetail - `address1` string — The customer's mailing address. - `address2` string — An additional field for the customer's mailing address. - `city` string — The customer's city, town, or village. - `company` string — The customer's company. - `country` string — The customer's country. - `country_code` string — The two-letter country code corresponding to the customer's country. - `country_id` integer — A unique identifier for the customer. - `country_name` string — The customer's normalized country name. - `cpf_number` string — Brazil CPF Number - `cpf_or_cnpj_number` string — CPF/CNPJ number - `created_at` string, date-time — Created at time - `default` boolean — Whether this address is the default address for the customer. - `first_name` string — The customer's first name. - `id` integer — A unique identifier for the address. - `last_name` string — The customer's last name. - `latitude` number — Latitude - `longitude` number — Longtitude - `name` string — Address name - `phone` string — Phone number Example 555-555-5555 - `province` string — Province - `province_code` string — The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada. - `updated_at` string, date-time — Updated at time - `zip` string — ZIP - `buyer_accepts_marketing` boolean — Whether the customer consented to receive email updates from the shop. - `cancel_reason` string — The reason why the order was canceled.
**customer**: The customer canceled the order.
**fraud**: The order was fraudulent.
**inventory**: Items in the order were not in inventory.
**declined**: The payment was declined.
**other**: A reason not in this list. - `cancelled_at` string — The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the order was canceled. - `cart_token` string — Cart token - `chargeback_amount` number — The amount of chargeback. - `chargeback_deadline_at` string — The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the order's chargeback end. - `chargeback_dispute_id` string — The id of dispute - `chargeback_status` string — The order's chargeback status. Valid values
**null**: The order does not have any disputes.
**open**: The order's dispute is open.
**lost**: Merchant lost the chargeback.
**won**: Merchant won the chargeback. - `checkout_token` string — Checkout token, unsing for checkout action - `client_details` ClientDetailsDto - `accept_language` string — The languages and locales that the browser understands. - `browser_height` integer — The browser screen height in pixels, if available - `browser_ip` string — The IP address of the browser used by the customer when they placed the order. - `browser_width` integer — The browser screen width in pixels, if available. - `session_hash` string — A hash of the session. - `user_agent` string — Details of the browsing client, including software and operating versions. - `closed_at` string — The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the order was closed. - `created_at` string — The autogenerated date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the order was created in ShopBase. The value for this property cannot be changed. - `created_at_in_timezone` string — The autogenerated date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the order was created by timezone in ShopBase. The value for this property cannot be changed. - `currency` string — The three-letter code ([ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217)) for the shop currency. - `customer_locale` string — The two or three-letter language code, optionally followed by a region modifier. - `discount_applications` OrderDiscountApplicationDto[] — An ordered list of stacked discount applications. - `allocation_method` string — The method by which the discount application value has been allocated to entitled lines. Valid values * across: The value is spread across all entitled lines. * each: The value is applied onto every entitled line. * one: The value is applied onto a single line. - `code` string — The discount code that was used to apply the discount. Available only for discount code applications. - `description` string — The description of the discount application, as defined by the merchant or the ShopBase Script. Available only for manual and script discount applications. - `discount_type` string — The type of the discount. Valid values * fixed_amount: A fixed amount discount value in the currency of the order. * percentage: A percentage discount value. * buy_x_get_y: Buy X get Y. * free_shipping: Free shipping for order. - `is_applied_entire_order` boolean — Determine discount applied for items separately or entire order. Valid values * true: applied entire order. * false: only applied for specific items. - `target_selection` string — The lines on the order, of the type defined by target_type, that the discount is allocated over. Valid values * all: The discount is allocated onto all lines. * entitled: The discount is allocated only onto lines it is entitled for. * explicit: The discount is allocated onto explicitly selected lines. - `target_type` string — The type of line on the order that the discount is applicable on. Valid values * line_item: The discount applies to line items. * shipping_line: The discount applies to shipping lines. - `title` string — The title of the discount application, as defined by the merchant. Available only for manual discount applications. - `type` string — The discount application type. Valid values * manual: The discount was manually applied by the merchant (for example, by using an app or creating a draft order). * script: The discount was applied by a ShopBase Script. * discount_code: The discount was applied by a discount code. - `value` number — The value of the discount application as a decimal. This represents the intention of the discount application. For example, if the intent was to apply a 20% discount, then the value will be 20.0. If the intent was to apply a $15 discount, then the value will be 15.0. - `value_type` string — The type of the value. Valid values * fixed_amount: A fixed amount discount value in the currency of the order. * percentage: A percentage discount value. - `discount_code` OrderDiscountCodeDto[] — A list of discount codes to apply to the order. - `amount` number — The value of the discount to be deducted from the order total. The type field determines how this value is calculated. After an order is created, this field returns the calculated amount. - `code` string — The discount code. - `discount_type` string — Discount type - `price_rule_id` integer — Price rule id - `price_rule_type` string — Price rule type - `scope` string - `type` string — The type of discount. Default value: `fixed_amount` - `email` string — The customer's email address. - `financial_status` string — The status of payments associated with the order. Can only be set when the order is created. Valid values
**pending**: The payments are pending. Payment might fail in this state. Check again to confirm whether the payments have been paid successfully.
**authorized**: The payments have been authorized.
**partially_paid**: The order have been partially paid.
**paid**: The payments have been paid.
**partially_refunded**: The payments have been partially refunded.
**refunded**: The payments have been refunded.
**voided**: The payments have been voided. - `fulfillment_status` string — The order's status in terms of fulfilled line items. Valid values
**fulfilled**: Every line item in the order has been fulfilled.
**null**: None of the line items in the order have been fulfilled.
**partial**: At least one line item in the order has been fulfilled.
**restocked**: Every line item in the order has been restocked and the order canceled.
**processing**: Every line item in the order is in processing. (except Printbase plan)
**processing**: Use Printbase plan - Order has been placed to supplier.
**partial-processing**: At least one line item in the order is in processing. - `fulfillments` FulfillmentDto[] — List fulfillments - `claim_id` integer — the claim id of fulfillment - `created_at` integer — The date and time when the fulfillment was created. The API returns this value in ISO 8601 format. - `date_done` integer — The date and time (ISO 8601 format) when the fulfillment was fulfilled. - `detected_tracking_company` string — Detected tracking company - `first_tracking_step_at` integer — The date and time when the first tracking step created - `id` integer — The ID for the fulfillment. - `last_crawled_at` integer — The date and time when the fulfillment was last crawled - `last_mile_tracking_company` string — The tracking company when the package arrived at destination country - `last_mile_tracking_number` string — The tracking number of packages when arrived at destination country - `last_tracking_step_at` integer — The date and time when the last tracking step created - `name` string — The uniquely identifying fulfillment name, consisting of two parts separated by a `.`. The first part represents the order name and the second part represents the fulfillment number. The fulfillment number automatically increments depending on how many fulfillments are in an order (e.g. #1001.1, #1001.2). - `notify_customer` boolean — Whether the customer should be notified. If set to true, then an email will be sent when the fulfillment is created or updated. For orders that were initially created using the API, the default value is false. For all other orders, the default value is true. - `order_id` integer — The unique numeric identifier for the order. - `send_delay_mail` boolean — check send email delay shipping - `service` string — The uniquely identifying fulfillment name, consisting of two parts separated by a `.`. The first part represents the order name and the second part represents the fulfillment number. The fulfillment number automatically increments depending on how many fulfillments are in an order (e.g. #1001.1, #1001.2). - `shipment_status` string — The current shipment status of the fulfillment. Valid values
**label_printed**: A label for the shipment was purchased and printed.
**label_purchased**: A label for the shipment was purchased, but not printed.
**attempted_delivery**: Delivery of the shipment was attempted, but unable to be completed.
**ready_for_pickup**: The shipment is ready for pickup at a shipping depot.
**confirmed**: The carrier is aware of the shipment, but hasn't received it yet.
**in_transit**: The shipment is being transported between shipping facilities on the way to its destination.
**out_for_delivery**: The shipment is being delivered to its final destination.
**delivered**: The shipment was succesfully delivered.
**failure**: Something went wrong when pulling tracking information for the shipment, such as an invalid tracking number or the shipment was cancelled. - `status` string — The status of the fulfillment. Valid values
**pending**: The fulfillment is pending.
**open**: The fulfillment has been acknowledged by the service and is in processing.
**success**: The fulfillment was successful.
**cancelled**: The fulfillment was cancelled.
**error**: There was an error with the fulfillment request.
**failure**: the fulfillment request failed.
**processing**: the fulfillment request is in processing. - `tracking_company` string — The name of the tracking company. - `tracking_number` string — A trackping number, provided by the shipping company - `tracking_numbers` string[] — A list of tracking numbers, provided by the shipping company. - `tracking_steps` object — Tracking steps object - `tracking_url` string — Link to tracking pag - `tracking_urls` string[] — The URLs of tracking pages for the fulfillment. - `updated_at` integer — The date and time (ISO 8601 format) when the fulfillment was last modified. - `variant_inventory_management` string — The name of the inventory management service. - `id` integer — Order ID - `is_in_post_purchase` boolean — Whether in post purchase or not - `is_risk` boolean — Is order risk - `line_items` OrderLineItemDto[] — A list of line item objects, each containing information about an item in the order. Each object has the following properties - `discount_allocations` OrderLineItemDiscountApplicationDto[] — An ordered list of amounts allocated by discount applications. - `amount` number — The discount amount allocated to the line in the shop currency. - `discount_application_index` integer — The index of the associated discount application in the order's discount_applications list. - `discount_amount` number — Discount amount - `fulfillable_quantity` integer — The amount available to fulfill, calculated as follows: `quantity - max(refunded_quantity, fulfilled_quantity) - pending_fulfilled_quantity - open_fulfilled_quantity` - `fulfillment_service` string — The service provider that's fulfilling the item. Valid values: manual, or the name of the provider, such as `amazon` or `shipwire`. - `fulfillment_status` string — How far along an order is in terms line items fulfilled. Valid values: null, processing, partial-processing, fulfilled, partial, and not_eligible. - `gift_card` boolean — Whether the item is a gift card. If `true`, then the item is not taxed or considered for shipping charges. - `image_src` string — Image source - `is_post_purchase_item` boolean — Is post purchase item - `item_discount_price` number — Item discount price - `line_item_discount_amount` number — Line item discount amount - `line_item_discount_price` number — Line item discount price - `line_item_price` number — Line item price - `line_item_price_after_discount` number — Line item price after discount - `line_item_price_before_discount` number — Line item price before discount - `line_item_price_with_explicit_discount` number — Line item price with explicit discount - `line_item_weight` number — Line item weight - `name` string — The name of the product variant. - `not_explicit_discount_price` number — Not explitcit discount price - `order_id` integer — Order ID - `price` number — The price of the item before discounts have been applied in the shop currency. - `product_id` integer — Product ID - `product_is_deleted` boolean — The status of product of this line item - `product_type` string — Product type - `properties` unknown[] — An array of custom information for the item that has been added to the cart. Often used to provide product customization options. - unknown - `quantity` number — Quantity items - `raw_price` number — Raw price - `raw_weight` number — Raw weight - `requires_shipping` boolean — Whether the item requires shipping. - `shipping_rate` LineItemShippingRate - `code` string — A reference to the combined shipping method. - `id` integer — The Shipping Rate Id - `is_post_purchase` boolean — Is post purchase - `price` number — The total price of this shipping rate for a variant in the order - `title` string — The title of the shipping method. - `type` string — The Shipping Rate Type - `variant_id` integer — The variant in which this shipping rate is applied for - `sku` string — The item's SKU (stock keeping unit). - `tags` string — A string of comma-separated product tags - `tax_amount` number — Tax amount - `tax_lines` TaxLineDto[] — An array of tax line objects, each of which details a tax applicable to the order. - `price` number — The amount added to the order for this tax in the shop currency. - `rate` number — The tax rate applied to the order to calculate the tax price. - `title` string — The name of the tax. - `tax_rate` number — Tax rate - `taxable` boolean — Whether the item was taxable. - `tip_payment_gateway` string — The payment gateway used to tender the tip, such as shopbase_payments. Present only on tips. - `tip_payment_method` string — The payment method used to tender the tip, such as Visa. Present only on tips. - `title` string — The title of the product. - `total_discount` number — The total discount amount applied to this line item in the shop currency. This value is not subtracted in the line item price. - `total_item_discount_price` number — Total item discount price - `total_line_with_discount_price` number — Total line with discount price - `total_tax_amount` number — Total tax amount - `variant_id` integer — Variant ID - `variant_title` string — The title of the product variant. - `vendor` string — The name of the item's supplier. - `weight` number — The weight of the item - `weight_unit` string — The weight unit of the item - `name` string — Order name - `not_explicit_discount` number — Not explicit discount - `note` string — An optional note that a shop owner can attach to the order. - `note_attributes` unknown[] — Extra information that is added to the order. Appears in the **Additional details** section of an order details page. Each array entry must contain a hash with `name` and `value` keys. - unknown - `order_number` integer — The ID of the order used by the shop owner and customer. This is different from the `id` property, which is the ID of the order used by the API. - `order_status_url` string — The URL pointing to the order status web page, if applicable. - `original_total_price` number — Original total price - `payment_gateway` string — Payment gateway - `payment_gateway_names` string[] — The list of payment gateways used for the order. - `phone` string — The customer's phone number. - `post_purchase_timeout_at` string — Post purchase timeout at time - `previous_shipping_fee` number — Previous shiping fee - `processed_at` string — Time this order be processed - `referring_site` string — The website where the customer clicked a link to the shop. - `refunds` RefundDto[] — A list of refunds applied to the order. For more information, see the Refund API. - `created_at` integer — The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the refund was created. - `id` integer — The unique identifier for the refund. - `is_dont_withdraw_from_balance_of_seller` boolean - `note` string — An optional note attached to a refund. - `order_adjustments` RefundOrderAdjustmentDto[] - `amount` number — The value of the discrepancy between the calculated refund and the actual refund. If the kind property's value is shipping_refund, then amount returns the value of shipping charges refunded to the customer. - `kind` string — The order adjustment type. Valid values: `shipping_refund` and `refund_discrepancy`. - `order_id` integer — The unique identifier for the order that the order adjustment is associated with. - `reason` string — The reason for the order adjustment. To set this value, include `discrepancy_reason` when you create a refund. - `tax_amount` number — The taxes that are added to amount, such as applicable shipping taxes added to a shipping refund. - `order_dto` OrderDto — recursive - `order_id` integer — The unique identifier for the order that the order adjustment is associated with. - `payment_fee` number - `processed_at` integer — The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the refund was imported. This value can be set to a date in the past when importing from other systems. If no value is provided, then it will be auto-generated as the current time in ShopBase. - `refund_line_items` RefundLineItemDto[] - `discount_amount` number — The discount of the refund line item. - `line_item` OrderLineItemDto - `discount_allocations` OrderLineItemDiscountApplicationDto[] — An ordered list of amounts allocated by discount applications. - `amount` number — The discount amount allocated to the line in the shop currency. - `discount_application_index` integer — The index of the associated discount application in the order's discount_applications list. - `discount_amount` number — Discount amount - `fulfillable_quantity` integer — The amount available to fulfill, calculated as follows: `quantity - max(refunded_quantity, fulfilled_quantity) - pending_fulfilled_quantity - open_fulfilled_quantity` - `fulfillment_service` string — The service provider that's fulfilling the item. Valid values: manual, or the name of the provider, such as `amazon` or `shipwire`. - `fulfillment_status` string — How far along an order is in terms line items fulfilled. Valid values: null, processing, partial-processing, fulfilled, partial, and not_eligible. - `gift_card` boolean — Whether the item is a gift card. If `true`, then the item is not taxed or considered for shipping charges. - `image_src` string — Image source - `is_post_purchase_item` boolean — Is post purchase item - `item_discount_price` number — Item discount price - `line_item_discount_amount` number — Line item discount amount - `line_item_discount_price` number — Line item discount price - `line_item_price` number — Line item price - `line_item_price_after_discount` number — Line item price after discount - `line_item_price_before_discount` number — Line item price before discount - `line_item_price_with_explicit_discount` number — Line item price with explicit discount - `line_item_weight` number — Line item weight - `name` string — The name of the product variant. - `not_explicit_discount_price` number — Not explitcit discount price - `order_id` integer — Order ID - `price` number — The price of the item before discounts have been applied in the shop currency. - `product_id` integer — Product ID - `product_is_deleted` boolean — The status of product of this line item - `product_type` string — Product type - `properties` unknown[] — An array of custom information for the item that has been added to the cart. Often used to provide product customization options. - unknown - `quantity` number — Quantity items - `raw_price` number — Raw price - `raw_weight` number — Raw weight - `requires_shipping` boolean — Whether the item requires shipping. - `shipping_rate` LineItemShippingRate - `code` string — A reference to the combined shipping method. - `id` integer — The Shipping Rate Id - `is_post_purchase` boolean — Is post purchase - `price` number — The total price of this shipping rate for a variant in the order - `title` string — The title of the shipping method. - `type` string — The Shipping Rate Type - `variant_id` integer — The variant in which this shipping rate is applied for - `sku` string — The item's SKU (stock keeping unit). - `tags` string — A string of comma-separated product tags - `tax_amount` number — Tax amount - `tax_lines` TaxLineDto[] — An array of tax line objects, each of which details a tax applicable to the order. - `price` number — The amount added to the order for this tax in the shop currency. - `rate` number — The tax rate applied to the order to calculate the tax price. - `title` string — The name of the tax. - `tax_rate` number — Tax rate - `taxable` boolean — Whether the item was taxable. - `tip_payment_gateway` string — The payment gateway used to tender the tip, such as shopbase_payments. Present only on tips. - `tip_payment_method` string — The payment method used to tender the tip, such as Visa. Present only on tips. - `title` string — The title of the product. - `total_discount` number — The total discount amount applied to this line item in the shop currency. This value is not subtracted in the line item price. - `total_item_discount_price` number — Total item discount price - `total_line_with_discount_price` number — Total line with discount price - `total_tax_amount` number — Total tax amount - `variant_id` integer — Variant ID - `variant_title` string — The title of the product variant. - `vendor` string — The name of the item's supplier. - `weight` number — The weight of the item - `weight_unit` string — The weight unit of the item - `line_item_id` integer — The ID of the related line item in the order. - `quantity` integer — The quantity of the associated line item that was returned. - `restock_type` string — How this refund line item affects inventory levels. Valid values
**no_restock**: Refunding these items won't affect inventory. The number of fulfillable units for this line item will remain unchanged. For example, a refund payment can be issued but no items will be returned or made available for sale again.
**cancel**: The items have not yet been fulfilled. The canceled quantity will be added back to the available count. The number of fulfillable units for this line item will decrease.
**return**: The items were already delivered, and will be returned to the merchant. The returned quantity will be added back to the available count. The number of fulfillable units for this line item will remain unchanged.
**legacy_restock**: The deprecated `restock` property was used for this refund. These items were made available for sale again. This value is not accepted when creating new refunds. - `subtotal` number — The subtotal of the refund line item. - `title` string — The title of the refund line item. - `total_refund` number — The total refund on the refund line item. - `total_tax` number — The total tax on the refund line item. - `variant_title` string — The variant title of the refund line item. - `restock` boolean — Whether to add the line items back to the store's inventory. ``` Provide a restock_type to influence how this refund affects inventory instead ``` - `shipping` Shipping - `amount` number — Shipping amount - `full_refund` boolean — Whether full refund or not - `transactions` RefundTransactionDto[] - `amount` number — The amount of money included in the transaction. If you don't provide a value for amount, then it defaults to the total cost of the order (even if a previous transaction has been made towards it). - `authorization` string — The authorization code associated with the transaction. - `conversion_rate` number — the conversion rate used in the transaction in case amount need to be converted - `created_at` integer — The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when the transaction was created. - `currency` string — The three-letter code ([ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217)) for the currency used for the payment. - `currency_exchange_adjustment` string — An adjustment on the transaction showing the amount lost or gained due to fluctuations in the currency exchange rate. It has the following properties
**ID**: The ID of the adjustment.
**adjustment**: The difference between the amounts on the associated transaction and the parent transaction.
**original_amount**: The amount of the parent transaction in the shop currency.
**final_amount**: The amount of the associated transaction in the shop currency.
**currency**: The shop currency. - `error_code` string — A standardized error code, independent of the payment provider. Valid values
**incorrect_number**
**invalid_number**
**invalid_expiry_date**
**invalid_cvc**
**expired_card**
**incorrect_cvc**
**incorrect_zip**
**incorrect_address**
**card_declined**
**processing_error**
**call_issuer**
**pick_up_card** - `gateway` string — The name of the gateway the transaction was issued through. A list of gateways can be found on ShopBase's payment gateways page. - `id` integer — The ID for the transaction. - `kind` string — The transaction's type. Valid values
**authorization**: Money that the customer has agreed to pay. The authorization period can be between 7 and 30 days (depending on your payment service) while a store waits for a payment to be captured.
**capture**: A transfer of money that was reserved during the authorization of a shop.
**sale**: The authorization and capture of a payment performed in one single step.
**void**: The cancellation of a pending authorization or capture.
**refund**: The partial or full return of captured money to the customer. - `message` string — A string generated by the payment provider with additional information about why the transaction succeeded or failed. - `order_id` integer — The ID for the order that the transaction is associated with. - `parent_id` integer — The ID of an associated transaction. * For ```capture``` transactions, the parent needs to be an ```authorization``` transaction. * For ```void``` transactions, the parent needs to be an ```authorization``` transaction. For ```refund``` transactions, the parent needs to be a ```capture``` or ```sale``` transaction. - `payment_details` string — Information about the credit card used for this transaction. It has the following properties
**avs_result_code**: The response code from the address verification system. The code is a single letter; see this chart for the codes and their definitions.
**credit_card_bin**: The issuer identification number (IIN), formerly known as bank identification number (BIN) of the customer's credit card. This is made up of the first few digits of the credit card number.
**credit_card_company**: The name of the company that issued the customer's credit card.
**credit_card_number**: The customer's credit card number, with most of the leading digits redacted.
**cvv_result_code**: The response code from the credit card company indicating whether the customer entered the card security code, or card verification value, correctly. The code is a single letter or empty string; see this chart for the codes and their definitions. - `processed_at` integer — The date and time ([ISO 8601 format](https://en.wikipedia.org/wiki/ISO_8601)) when a transaction was processed. This value is the date that's used in the analytic reports. By default, it matches the created_at value. If you're importing transactions from an app or another platform, then you can set processed_at to a date and time in the past to match when the original transaction was processed. - `receipt` string — Receipt - `source_name` string — The origin of the transaction. This is set by ShopBase and can't be overridden. Example values: web, pos, iphone, and android. - `status` string — The status of the transaction. Valid values: ```pending```, ```failure```, ```success```, and ```error```. - `test` boolean — Whether the transaction is a test transaction. - `transaction_amount` number — The amount of money included in the payment gateway's transaction. - `transaction_currency` string — The three-letter code ([ISO 4217 format](https://en.wikipedia.org/wiki/ISO_4217)) for the payment provider's transaction currency used for the payment. - `user_id` integer — The unique identifier of the user who performed the refund. - `shipping_address` CustomerAddressDetail - `address1` string — The customer's mailing address. - `address2` string — An additional field for the customer's mailing address. - `city` string — The customer's city, town, or village. - `company` string — The customer's company. - `country` string — The customer's country. - `country_code` string — The two-letter country code corresponding to the customer's country. - `country_id` integer — A unique identifier for the customer. - `country_name` string — The customer's normalized country name. - `cpf_number` string — Brazil CPF Number - `cpf_or_cnpj_number` string — CPF/CNPJ number - `created_at` string, date-time — Created at time - `default` boolean — Whether this address is the default address for the customer. - `first_name` string — The customer's first name. - `id` integer — A unique identifier for the address. - `last_name` string — The customer's last name. - `latitude` number — Latitude - `longitude` number — Longtitude - `name` string — Address name - `phone` string — Phone number Example 555-555-5555 - `province` string — Province - `province_code` string — The code for the region of the address, such as the province, state, or district. For example QC for Quebec, Canada. - `updated_at` string, date-time — Updated at time - `zip` string — ZIP - `shipping_discount` number — Caculated shipping discount - `shipping_fee` number — Caculated shipping fee - `shipping_lines` ShippingLinesDto[] — An array of objects, each of which details a shipping method used - `carrier_identifier` string — A reference to the carrier service that provided the rate. Present when the rate was computed by a third-party carrier service. - `code` string — A reference to the combined shipping method. - `discounted_price` number — The price of the shipping method after discounts. - `fulfillment_service` string — A reference to the fulfillment service that is being requested for the shipping method. Present if the shipping method requires processing by a third party fulfillment service; null otherwise. - `price` number — The price of this shipping method in the shop currency. Can't be negative. (sum of all shipping rates price) - `source` string — The source of the shipping method. - `tax_lines` TaxLineDto[] — A list of tax line objects, each of which details a tax applicable to this shipping line. - `price` number — The amount added to the order for this tax in the shop currency. - `rate` number — The tax rate applied to the order to calculate the tax price. - `title` string — The name of the tax. - `title` string — The title of the shipping method. - `shipping_tax` number — Caculated shipping tax - `shop_id` integer — Shop ID - `source_name` string — Where the order originated. Can be set only during order creation, and is not writeable afterwards. Values for ShopBase channels are protected and cannot be assigned by other API clients: web, pos, shopbase_draft_order, iphone, and android. Orders created via the API can be assigned any other string of your choice. If unspecified, then new orders are assigned the value of your app's ID. - `subtotal_price` number — Subtotal price - `tags` string — Tags attached to the order, formatted as a string of comma-separated values. Tags are additional short descriptors, commonly used for filtering and searching. Each individual tag is limited to 40 characters in length. - `tax_lines` TaxLineDto[] — A list of tax line objects. - `price` number — The amount added to the order for this tax in the shop currency. - `rate` number — The tax rate applied to the order to calculate the tax price. - `title` string — The name of the tax. - `taxes_included` boolean — Whether taxes are included in the order subtotal. - `token` string — Checkout token, unsing for identifing - `total_discounts` number — Total discounts - `total_line_items_discount` number — Total line item discount - `total_line_items_price` number — Total line item price - `total_price` number — Total price - `total_quantity` number — Total quantity - `total_shipping` number — it's equal shipping_fee - shipping_discount + shipping_tax - `total_tax` number — Total tax - `total_tip_received` number — The sum of all the tips in the order in the shop currency. - `total_weight` number — Total height - `updated_at` string — Time auto generate when the order was updated - `weight_unit` string — weight_unit --- [API](https://skmtc.net/shopbase/apis/shopbase-internal-api.md) · [All operations](https://skmtc.net/shopbase/apis/shopbase-internal-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/shopbase/shopbase-internal-api/revisions/353ccde6240d/schema)