Lectronz API Reference, Version 1
Orders
JSON order representation
The order object represents an order from a customer. An order has one of the following 3 statuses:
- payment_success means the order has been paid by the customer but not fulfilled yet.
- fulfilled means that the order has been shipped by the seller.
- refunded means that the order has been fully refunded by the seller (or Lectronz).
This object has the following properties:
Unique identifier of the order.
Status of the order.
Valid values are: payment_success, fulfilled, refunded.
Unique store identifier for the products described in the order.
Store URL on Lectronz.
Customer contact email address for delivery.
Customer contact phone for delivery.
Shipping address for fulfillment.
See details
First name
Last name, family name
Name of organization
Street address, including the name of the street and number"
Additional street location information (e.g. building name and number)
City
Postal code, ZIP code
State, province or region
Country
Alpha-2 country code (ISO 3166)
Billing address for invoicing purposes.
See details
First name
Last name, family name
Name of organization
Street address, including the name of the street and number"
Additional street location information (e.g. building name and number)
City
Postal code, ZIP code
State, province or region
Country
Alpha-2 country code (ISO 3166)
True if the customer has explicitly stated that the billing address is the same as the shipping address.
Tax identifier provided by customer during checkout (e.g. EU VAT number).
The self-declared legal status of the customer during checkout. In practice, it will either be "business" or "unspecified". The value "individual" is currently unused.
Valid values are: unspecified, individual, business.
Name of the shipping option selected by the customer during checkout.
True if the shipping option has tracking information.
No description provided
See details
Estimated weight of packaging, excluding ordered items.
Estimated total weight of the order, including packaging.
Weight unit.
Valid values are: kg, gr, lb, oz.
This contains the IOSS number used by Lectronz for imports into the EU, for sellers outside of the EU. This will only be present if an IOSS number is required for the order, and if the order in not fulfilled or refunded.
List of items ordered.
See details
Unique product identifier.
Product name
Short product description, as shown on the corresponding web page.
Optional unique identifier used by the seller to track inventory. Only provided if present.
Price of one unit of the product, excluding taxes.
Discount amount applied to one unit of product. It will only be present if a discount was applied.
Quantity of the product ordered.
Estimated weight of the product.
Product options
See details
Name of the option
Choice selected for the specified option.
Optional unique identifier used by the seller to track inventory. Only provided if present.
Weight added by this option.
3-letter currency code of the order. Applies to all amounts in the order.
Valid values are: EUR.
Shipping cost
If false, the shipping_cost amount is excluded from tax calculation.
Total amount of the order, excluding taxes.
The total amount to which taxes apply.
The total amount of taxes.
Applicable tax rate (percentage).
Total amount paid for the order.
Date of fulfillment in ISO 8601 format (UTC). Only provided if the order has been fulfilled.
Tracking code used for shipping the order.
Tracking URL used for shipping the order.
Amount collected by Lectronz as a service fee.
Amount of tax collected by Lectronz on behalf of the seller where applicable.
Discount code applied to this order, if any.
Fees collected by the payment provider on the payment for this order. May be absent if the payment provider has not provided this information yet.
Amount paid out to the seller for this order. May be absent if the payout has not been calculated yet.
No description provided
See details
The name of the payment provider.
Valid values are: stripe.
Reference of the payment with the selected provider.
UTC creation date of order in ISO 8601 format.
Last update of order in ISO 8601 format (UTC).
Deadline for shipping the order.
Note left by customer with the order, if any.
Get an order
Request
Response body (object)
JSON order representation
details
Unique identifier of the order.
Status of the order.
Valid values are: payment_success, fulfilled, refunded.
Unique store identifier for the products described in the order.
Store URL on Lectronz.
Customer contact email address for delivery.
Customer contact phone for delivery.
Shipping address for fulfillment.
See details
First name
Last name, family name
Name of organization
Street address, including the name of the street and number"
Additional street location information (e.g. building name and number)
City
Postal code, ZIP code
State, province or region
Country
Alpha-2 country code (ISO 3166)
Billing address for invoicing purposes.
See details
First name
Last name, family name
Name of organization
Street address, including the name of the street and number"
Additional street location information (e.g. building name and number)
City
Postal code, ZIP code
State, province or region
Country
Alpha-2 country code (ISO 3166)
True if the customer has explicitly stated that the billing address is the same as the shipping address.
Tax identifier provided by customer during checkout (e.g. EU VAT number).
The self-declared legal status of the customer during checkout. In practice, it will either be "business" or "unspecified". The value "individual" is currently unused.
Valid values are: unspecified, individual, business.
Name of the shipping option selected by the customer during checkout.
True if the shipping option has tracking information.
No description provided
See details
Estimated weight of packaging, excluding ordered items.
Estimated total weight of the order, including packaging.
Weight unit.
Valid values are: kg, gr, lb, oz.
This contains the IOSS number used by Lectronz for imports into the EU, for sellers outside of the EU. This will only be present if an IOSS number is required for the order, and if the order in not fulfilled or refunded.
List of items ordered.
See details
Unique product identifier.
Product name
Short product description, as shown on the corresponding web page.
Optional unique identifier used by the seller to track inventory. Only provided if present.
Price of one unit of the product, excluding taxes.
Discount amount applied to one unit of product. It will only be present if a discount was applied.
Quantity of the product ordered.
Estimated weight of the product.
Product options
See details
Name of the option
Choice selected for the specified option.
Optional unique identifier used by the seller to track inventory. Only provided if present.
Weight added by this option.
3-letter currency code of the order. Applies to all amounts in the order.
Valid values are: EUR.
Shipping cost
If false, the shipping_cost amount is excluded from tax calculation.
Total amount of the order, excluding taxes.
The total amount to which taxes apply.
The total amount of taxes.
Applicable tax rate (percentage).
Total amount paid for the order.
Date of fulfillment in ISO 8601 format (UTC). Only provided if the order has been fulfilled.
Tracking code used for shipping the order.
Tracking URL used for shipping the order.
Amount collected by Lectronz as a service fee.
Amount of tax collected by Lectronz on behalf of the seller where applicable.
Discount code applied to this order, if any.
Fees collected by the payment provider on the payment for this order. May be absent if the payment provider has not provided this information yet.
Amount paid out to the seller for this order. May be absent if the payout has not been calculated yet.
No description provided
See details
The name of the payment provider.
Valid values are: stripe.
Reference of the payment with the selected provider.
UTC creation date of order in ISO 8601 format.
Last update of order in ISO 8601 format (UTC).
Deadline for shipping the order.
Note left by customer with the order, if any.
Update an order
Update an order to mark it as fulfilled and optionally provide tracking information.
The fields tracking_code and tracking_url are required if the shipping method associated with the order
is tracked, as indicated by the shipping_is_tracked property of the order.
Request
Request body (object)
JSON fulfillment information object
details
Updated status of order.
Valid values are: fulfilled.
Tracking code of shipment.
Tracking URL of shipment.
Get a list of orders
Get a list of orders from oldest to newest. You can use the limit and offset query parameters to
paginate the results. Tip: Use the total_count property of the response to know how many orders are
available, which can be obtained without fetching the entire list by using the limit=0 query parameter.
Request
Query string parameters
Optional. The maximum number of orders provided in the response (default is 20).
Optional. The number of orders to skip in the response (default is 0). By combining offset and limit, it is possible to display only a specific portion of all orders.
Response body (object)
JSON object representing a list of orders
details
The maximum number of orders in the list.
The index of the first order in the list, where index 0 represents the oldest order in the list, and where total_count-1 represents the newest order.
The total number of existing orders.
No description provided
See details
Unique identifier of the order.
Status of the order.
Valid values are: payment_success, fulfilled, refunded.
Unique store identifier for the products described in the order.
Store URL on Lectronz.
Customer contact email address for delivery.
Customer contact phone for delivery.
Shipping address for fulfillment.
See details
First name
Last name, family name
Name of organization
Street address, including the name of the street and number"
Additional street location information (e.g. building name and number)
City
Postal code, ZIP code
State, province or region
Country
Alpha-2 country code (ISO 3166)
Billing address for invoicing purposes.
See details
First name
Last name, family name
Name of organization
Street address, including the name of the street and number"
Additional street location information (e.g. building name and number)
City
Postal code, ZIP code
State, province or region
Country
Alpha-2 country code (ISO 3166)
True if the customer has explicitly stated that the billing address is the same as the shipping address.
Tax identifier provided by customer during checkout (e.g. EU VAT number).
The self-declared legal status of the customer during checkout. In practice, it will either be "business" or "unspecified". The value "individual" is currently unused.
Valid values are: unspecified, individual, business.
Name of the shipping option selected by the customer during checkout.
True if the shipping option has tracking information.
No description provided
See details
Estimated weight of packaging, excluding ordered items.
Estimated total weight of the order, including packaging.
Weight unit.
Valid values are: kg, gr, lb, oz.
This contains the IOSS number used by Lectronz for imports into the EU, for sellers outside of the EU. This will only be present if an IOSS number is required for the order, and if the order in not fulfilled or refunded.
List of items ordered.
See details
Unique product identifier.
Product name
Short product description, as shown on the corresponding web page.
Optional unique identifier used by the seller to track inventory. Only provided if present.
Price of one unit of the product, excluding taxes.
Discount amount applied to one unit of product. It will only be present if a discount was applied.
Quantity of the product ordered.
Estimated weight of the product.
Product options
See details
Name of the option
Choice selected for the specified option.
Optional unique identifier used by the seller to track inventory. Only provided if present.
Weight added by this option.
3-letter currency code of the order. Applies to all amounts in the order.
Valid values are: EUR.
Shipping cost
If false, the shipping_cost amount is excluded from tax calculation.
Total amount of the order, excluding taxes.
The total amount to which taxes apply.
The total amount of taxes.
Applicable tax rate (percentage).
Total amount paid for the order.
Date of fulfillment in ISO 8601 format (UTC). Only provided if the order has been fulfilled.
Tracking code used for shipping the order.
Tracking URL used for shipping the order.
Amount collected by Lectronz as a service fee.
Amount of tax collected by Lectronz on behalf of the seller where applicable.
Discount code applied to this order, if any.
Fees collected by the payment provider on the payment for this order. May be absent if the payment provider has not provided this information yet.
Amount paid out to the seller for this order. May be absent if the payout has not been calculated yet.
No description provided
See details
The name of the payment provider.
Valid values are: stripe.
Reference of the payment with the selected provider.
UTC creation date of order in ISO 8601 format.
Last update of order in ISO 8601 format (UTC).
Deadline for shipping the order.
Note left by customer with the order, if any.