Skip to main content
POST
Create/Update Order
Use this endpoint to create or update an order in your Reportana store. The reference_id attribute is required and must correspond to the id or unique identifier of the order in your system, ensuring proper association between your system’s data and our platform.

​
Headers

​
string
required
Basic base64(client_id + ’:’ + client_secret)
​
string
required
Content-Type:application/json

​
Body

​
string
required
Enter the reference ID.Example: “123456789”.
​
string
Enter the Shopify order ID.Example: “4567890123456”.Note: This field is used to update the data of an existing order that was integrated through our official Shopify integration, where shopify_order_id is the same order ID as in the Shopify API. The following fields are accepted for update: total_price, delivery_price, discount_price, payment_status, payment_method, installments, billet_url, billet_line, and billet_expired_at in our system.
​
string
required
Enter the order number.Example: “1234”.
​
string
Enter the admin panel URL for accessing the order.Example: “https://example.com/admin/orders/123456789”.
​
string
required
Enter the customer’s name.Example: “John Doe”.
​
string
required
Enter the customer’s phone number.Example: “+5511911111111”.
​
string
required
Enter the customer’s email address.Example: “johndoe@gmail.com”.
​
string
Enter the customer’s document number.Example: “123456789”.

​
Billing Adress

​
object
required
Enter the billing address information.
​
string
Enter the customer’s name.Example: “John Doe”.
​
string
Enter the customer’s first name.Example: “John”.
​
string
Enter the customer’s last name.Example: “Doe”.
​
string
Enter the company name.Example: “John Doe Ltda”.
​
string
Enter the customer’s phone number.Example: “+5511911111111”.
​
string
Enter the customer’s address.Example: “6925 Hollywood Blvd”.
​
string
Enter the customer’s neighborhood.Example: “Times Square”.
​
string
Enter the customer’s city.Example: “New York”.
​
string
Enter the customer’s state.Example: “North Carolina”.
​
string
Enter the customer’s state code.Example: “NC”.
​
string
Enter the customer’s country.Example: “United States of America”.
​
string
Enter the customer’s country code.Example: “USA”.
​
string
Enter the customer’s ZIP code.Example: “90213”.
​
number
Enter the customer’s latitude.Example: -27.807915923881836
​
number
Enter the customer’s longitude.Example: -50.3183162423294

​
Shipping Adress

​
object
required
Enter the shipping address information.
​
string
Enter the customer’s name.Example: “John Doe”.
​
string
Enter the customer’s first name.Example: “John”.
​
string
Enter the customer’s last name.Example: “Doe”.
​
string
Enter the company name.Example: “John Doe Ltda”.
​
string
Enter the customer’s phone number.Example: “+5511911111111”.
​
string
Enter the customer’s address.Example: “6925 Hollywood Blvd”.
​
string
Enter the customer’s neighborhood.Example: “Times Square”.
​
string
Enter the customer’s city.Example: “New York”.
​
string
Enter the customer’s state.Example: “North Carolina”.
​
string
Enter the customer’s state code.Example: “NC”.
​
string
Enter the customer’s country.Example: “United States of America”.
​
string
Enter the customer’s country code.Example: “USA”.
​
string
Enter the customer’s ZIP code.Example: “88508100”.
​
string
Enter the customer’s latitude.Example: -27.807915923881836
​
string
Enter the customer’s longitude.Example: -50.3183162423294

​
Line Items

​
object[]
required
Click on “Add an item” to add a product.
​
string
Enter the product title.Example: “Sunglasses”.
​
string
Enter the product variant title.Example: “Black”.
​
number
Enter the quantity of products in the order.Example: 1
​
number
Enter the product price.Example: 49.9
​
string
Enter the public access URL of the product.Example: “https://example.com/products/1234”.
​
string
Enter the product image URL.Example: “https://example.com/products/1234/image.jpg”.
​
string
Enter the product tracking number.Example: “LB123456789BR”.

​
Payment & More Info

​
string
required
Enter the currency used.Example: “USD”.
​
number
required
Enter the total amount.Example: 124.8
​
number
required
Enter the subtotal amount.Example: 109.8
​
number
Enter the shipping cost.Example: 15.0
​
number
Enter the discount amount.Example: 10.0
​
string
Enter the payment status.Example: “PAID”.Available options: PAID, PENDING, NOT_PAID.
​
string
Enter the payment method.Example: “CREDIT_CARD”.Available options: CREDIT_CARD, PIX, DEPOSIT, BOLETO, OTHER.
​
number
Enter the number of payment installments.Example: 3
​
string
Enter the order tracking numbers.Example: “LB123456789BR,LB987654321BR”.
​
string
Enter the site URL.Example: “https://www.facebook.com/”.
​
string
Enter the order status URL.Example: “https://example.com/orders/123456789”.
​
string
Enter the payment URL.Example: “https://example.com/orders/123456789/creditcard.pdf”.
​
string
Enter the billet barcode or Pix “Copy and Paste” string.
​
string
Enter the payment expiration date.Example: “2022-05-31”.
​
string
required
Enter the order creation date.Example: “2022-05-27 12:00”.