Create a new Order

post https://api.torredecontrol.io/dev/v3/order

Create Order

Body Params

Create a new order given a branch and customer details

customer

object

required

Customer name

address

object

required

phone

object

required

branch

string

required

paymentMethod

string

required

This field is capable of receiving either the identifier of the payment method or its code.

total

double

required

≥ 0

Total amount of the order

products

array of objects

products

collectionPaymentMethods

array of objects

This field is optional, and you can exclusively use the paymentMethod (which will always be considered the primary payment method). It becomes relevant only when employing multiple payment methods. Note: The use of multiple payment methods will deactivate the involvement of external partners

collectionPaymentMethods

subtotal

double

required

≥ 0

Sub total amount of the order

paidWith

double

required

≥ 0

Amount to use by the client

isPaid

boolean

Defaults to false

Validates if the order has been paid

scheduledDate

string

The field denotes the intended approximate delivery date for this order. It interfaces with another setting to trigger the order x minutes prior to this date.

tags

vehicleTypes

array of strings

Defaults to MOTORCYCLE

Vehicles allowed to delivery this order

vehicleTypes

isAutomaticAssignment

boolean

An indicator designed to streamline the process by automatically sending orders for assignment, bypassing manual configuration or assignment.

publicId

string

Identifier for the shop/client/integration of the order

trackingId

string

Identifier normally used with external services to be know by client/shop/delivery partner.

orderType

string

Defaults to DELIVERY

Type of order the allowed values at the moment are pickup (cliento to shop) and delivery (driver/shop to client)

pickupCode

string

Defaults to null

This field is used to add a code when using external drivers (if they apply), and when they arrived to the branch this code will be required to get the product

deliveryCode

string

Defaults to null

This field is used to add a code when using external drivers (if they apply), and when the product is being delivered a code will be needed to give the product to the client

config

object

Object containing multiple configuration options for the order as in example cookingTime (time in seconds to wait before begin assignment)

requiredSkills

array of strings

Defaults to

This field is used to filter drivers or providers by specific skills, any other provider or driver will be removed from the seleccion

requiredSkills

prescriptionAction

string

Defaults to NONE

This field is used by a variety of clients more specifically pharmacist, and will specify the action required for the doctor recipes

comment

string

Defaults to null

Notes from the client to the store/branch

Responses

401

Forbidden exception

Language

Credentials

URL


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.torredecontrol.io/dev/v3/order \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfull operation - Note: Some fields may no appear if they do not have value

400Invalid Request or Data

403Unauthorized access - Wrong or invalid keys (headers)