Skip to content

Ecommerce

Manage ecommerce integrations

Operations

Create order from ecommerce

Request

Create a new order from ecommerce platform.

Query
shopIdinteger, (int32)required
Bodyapplication/jsonrequired
cmsOrderIdinteger, (int64)

CMS order identifier.

Default:""
Example:12345
paymentstring

Payment method name.

Default:""
Example:"Credit Card"
dateAddstring, (date)

Order creation date. Format: yyyy-MM-dd

Default:""
Example:"2024-12-31"
totalShippingTaxExclnumber

Total shipping amount excluding taxes.

Default:""
Example:15
totalShippingTaxInclnumber

Total shipping amount including taxes.

Default:""
Example:18.15
giftboolean

Flag indicating if this order is a gift.

Default:false
Example:true
giftMessagestring

Gift message.

Default:""
Example:"Happy Birthday!"
cmsstring

CMS system name.

Default:""
Example:"WooCommerce"
referencestring

Order reference number.

Default:""
Example:"ORD-2024-12345"
messageOrderstring

Order message or notes from customer.

Default:""
Example:"Please deliver on Tuesday"
totalDiscountsTaxExclnumber

Total discounts amount excluding taxes.

Default:""
Example:25
totalDiscountsTaxInclnumber

Total discounts amount including taxes.

Default:""
Example:30.25
customerobject(ApiCustomerEcommerceWriteDto)

Customer information.

Default:""
addressDeliveryobject(ApiCustomerAddressEcommerceWriteDto)

Delivery address information.

Default:""
addressInvoiceobject(ApiCustomerAddressEcommerceWriteDto)

Invoice address information.

Default:""
orderCartRulesArray of objects(ApiOrderCartRulesWriteDto)

List of cart rules/discounts applied to the order.

Default:""
orderDetailsArray of objects(ApiOrderLineEcommerceWriteDto)

List of order lines/items in the order.

Default:""
POST
/api/v1/ecommerce/order
curl -i -X POST \
  'https://api.prana.software/api/v1/ecommerce/order?shopId=0' \
  -H 'Content-Type: application/json'

Responses

OK

Bodyapplication/json
idinteger, (int32)required

Unique identifier of the object

Default:""
numberintegerrequired
documentDatestring, (date)required
quantityTotalnumber
observationsstring
linesArray of objects(ApiOrderLineReadDto)
changenumber
discount1number
discount2number
discountAmountTotalnumber
discountAmountTotalCompanyCurrencynumber
discountPpnumber
discountPpAmountTotalnumber
discountPpAmountTotalCompanyCurrencynumber
grossAmountTotalnumber
grossAmountTotalCompanyCurrencynumber
netAmountTotalnumber
netAmountTotalCompanyCurrencynumber
vatAmountTotalnumber
vatAmountTotalCompanyCurrencynumber
surchargeAmountTotalnumber
surchargeAmountTotalCompanyCurrencynumber
withholdingnumber
withholdingAmountTotalnumber
withholdingAmountTotalCompanyCurrencynumber
totalnumber
totalCompanyCurrencynumber
disbursementAmountTotalnumber
disbursementAmountTotalCompanyCurrencynumber
billingSeriesobject(ApiBillingSeriesListReadDto)

Billing series details.

Default:""
serviceDatestring, (date)

Service date. Format: yyyy-MM-dd

Default:""
Example:"2024-12-31"
manufacturingDatestring, (date)

Manufacturing date. Format: yyyy-MM-dd

Default:""
Example:"2024-12-31"
seasonobject(ApiSeasonListReadDto)

Season details.

Default:""
warehouseobject(ApiWarehouseListReadDto)

Warehouse details.

Default:""
customerAddressobject(ApiCustomerAddressViewReadDto)required

Customer address details.

Default:""
orderTypeobject(ApiOrderTypeListReadDto)

Order type details.

Default:""
rateCodeobject(ApiRateCodeListReadDto)

Rate code details.

Default:""
referencestring

Reference number.

Default:""
Example:"REF-001"
billingObservationsstring

Billing observations.

Default:""
Example:"Special billing instructions"
paymentMethodobject(ApiPaymentMethodListReadDto)

Payment method details.

Default:""
firstTerminteger, (int32)

First term days.

Default:""
Example:30
daysTerminteger, (int32)

Days term.

Default:""
Example:30
termsinteger, (int32)

Number of terms.

Default:""
Example:3
proximityTypestring(ApiProximityTypeEnum)

Proximity type for date calculation.

Default:""
Enum:"NEARBY""PREVIOUS""LATER"
irpfTypestring(ApiIRPFTypeEnum)

IRPF withholding type.

Default:""
Enum:"LEASES""PROFESIONAL_ACTIVITIES""AGRO""AGRO_REAGP"
Example:"AGRO"
discount3number

Third discount percentage.

Default:""
Example:5
discount4number

Fourth discount percentage.

Default:""
Example:2.5
currencyobject(ApiCurrencyListReadDto)

Currency details.

Default:""
ibanstring

IBAN account number.

Default:""
Example:"ES7501234567890123456789"
customerVatTypeobject(ApiCustomerVatTypeListReadDto)

Customer VAT type details.

Default:""
billingCompanyobject(ApiCompanyInfoListReadDto)

Billing company details.

Default:""
collectedAmountnumber

Collected amount.

Default:""
Example:500
collectedAmountCompanyCurrencynumber

Collected amount in company currency.

Default:""
Example:500
representative1object(ApiRepresentativeListReadDto)

First representative details.

Default:""
commissionType1string(ApiCommissionTypeEnum)

First commission type (PERCENTAGE, FIXED, etc.)

Default:""
Enum:"PERCENTAGE""AMOUNT_PER_UNIT""FIXED"
commission1number

First commission amount.

Default:""
Example:100
representative2object(ApiRepresentativeListReadDto)

Second representative details.

Default:""
commissionType2string(ApiCommissionTypeEnum)

Second commission type (PERCENTAGE, FIXED, etc.)

Default:""
Enum:"PERCENTAGE""AMOUNT_PER_UNIT""FIXED"
commission2number

Second commission amount.

Default:""
Example:75
representative3object(ApiRepresentativeListReadDto)

Third representative details.

Default:""
commissionType3string(ApiCommissionTypeEnum)

Third commission type (PERCENTAGE, FIXED, etc.)

Default:""
Enum:"PERCENTAGE""AMOUNT_PER_UNIT""FIXED"
commission3number

Third commission amount.

Default:""
Example:50
valueDatestring, (date)

Value date. Format: yyyy-MM-dd

Default:""
Example:"2024-12-31"
agencyobject(ApiAgencyListReadDto)

Agency details.

Default:""
shippingTermobject(ApiShippingTermListReadDto)

Shipping term details.

Default:""
shippingVatTypestring

Shipping VAT type.

Default:""
Example:"STANDARD"
shippingVatPercentagenumber

Shipping VAT percentage.

Default:""
Example:21
shippingSurchargePercentagenumber

Shipping surcharge percentage.

Default:""
Example:5
shippingAmountnumber

Shipping amount.

Default:""
Example:50
packagesinteger, (int32)

Number of packages.

Default:""
Example:5
grossWeightnumber

Gross weight.

Default:""
Example:150.5
netWeightnumber

Net weight.

Default:""
Example:100.5
volumenumber

Volume.

Default:""
Example:5
noAccumulateWarehouseboolean

Flag to not accumulate warehouse.

Default:false
Example:false
cancelledQuantityTotalnumber

Cancelled quantity total.

Default:""
Example:0
servedQuantityTotalnumber

Served quantity total.

Default:""
Example:100
pendingQuantityTotalnumber

Pending quantity total.

Default:""
Example:0
effectiveQuantityTotalnumber

Effective quantity total.

Default:""
Example:0
noAccumulateRiskboolean

Flag to not accumulate risk.

Default:false
Example:false
lockedboolean

Flag indicating order is locked.

Default:false
Example:false
netAmountPendingTotalnumber

Net amount pending total.

Default:""
Example:500
invoiceEditObservationsstring

Invoice edit observations.

Default:""
Example:"Special notes for invoicing"
invoicesArray of objects(ApiLastInfoResponseDto)

List of related invoices.

Default:""
tagsArray of strings

List of order tags.

Default:""
receiptCollectionsArray of objects(ApiQuoteReceiptCollectionListReadDto)

List of receipt collections.

Default:""
discount1AmountTotalnumber

First discount amount total.

Default:""
Example:100
discount1AmountTotalCompanyCurrencynumber

First discount amount total in company currency.

Default:""
Example:100
discount2AmountTotalnumber

Second discount amount total.

Default:""
Example:50
discount2AmountTotalCompanyCurrencynumber

Second discount amount total in company currency.

Default:""
Example:50
discount3AmountTotalnumber

Third discount amount total.

Default:""
Example:25
discount3AmountTotalCompanyCurrencynumber

Third discount amount total in company currency.

Default:""
Example:25
discount4AmountTotalnumber

Fourth discount amount total.

Default:""
Example:10
discount4AmountTotalCompanyCurrencynumber

Fourth discount amount total in company currency.

Default:""
Example:10
quoteNumberinteger

Related quote number.

Default:""
Example:2024001
quoteIdinteger, (int32)

Related quote identifier.

Default:""
Example:100
reportTokenstring

Report token for downloading.

Default:""
Example:"token-xyz"
reportUrlstring

Report URL.

Default:""
Example:"https://example.com/report"
reportNamestring

Report name.

Default:""
Example:"OrderReport"
emailSentboolean

Flag indicating email was sent.

Default:false
Example:true
cmsOrderIdinteger, (int64)

CMS order identifier.

Default:""
Example:12345
shopobject(ApiShopListReadDto)

Shop details.

Default:""
usersCompany1object(ApiUsersCompanyListReadDto)

First company user details.

Default:""
usersCompany2object(ApiUsersCompanyListReadDto)

Second company user details.

Default:""
usersCompany3object(ApiUsersCompanyListReadDto)

Third company user details.

Default:""
documentTemplateobject(ApiDocumentTemplateListReadDto)

Document template selected for PDF generation.

Default:""
projectobject(ApiProjectListReadDto)

Associated project.

Default:""
Response
// No response example