Create order

post https://api.moderndropship.com/buyer/orders

A buyer can create a new order. This order can be associated with multiple sellers and it will be split.

Body Params

The buyer and product details necessary to create an order in Convictional.

address

object

required

attributes

object

buyerReference

string

required

A reference to an ID in your (the buyer's) system. The ID must be unique.

customerEmail

string

The end customer's email address.

customerReference

string

The customer-facing reference to the order in your (the buyer's) system.

isTest

boolean

items

array of objects

required

The line items on the buyer order.

items*

metafields

object

note

string

Additional information that will be passed along to each vendor with this order.

orderedDate

string

required

The timestamp when the order was originally placed by the customer. Use RFC 3339 format. Null if not set.

shippingMethods

array of objects

The shipping methods for the order.

shippingMethods

Responses

Response body

object

address

object

addressOne

string

Address line one.

addressTwo

string

Address line two.

city

string

The city.

company

string

The name of the organization receiving the fulfillment.

country

string

The country.

name

string

The name of the customer receiving the fulfillment.

phoneNumber

string

An associated phone number.

state

string

The state or province.

zip

string

The zip code or postal code.

attributes

object

buyerReference

string

A reference to an ID in your (the buyer's) system. The ID must be unique.

created

string

The time the buyer order was created. Null if not set. Read only.

customerEmail

string

The end customer's email address.

customerReference

string

The customer-facing reference to the order in your (the buyer's) system.

string

ID of this buyer order. Read only.

isTest

boolean

Indicates whether the order is a test order

items

array of objects

The line items on the buyer order.

items

object

basePrice

number

buyerReference

string

A reference to an ID in the buyer's system corresponding to this order line item.

buyerVariantCode

string

The buyer's variant code for this line item.

string

ID of this buyer order item. Read only.

productId

string

ID of the product to be fulfilled. Use the value from product.id returned by the GET /buyer/products endpoint.

quantity

integer

The quantity of this variant to be fulfilled.

retailPrice

number

The after tax retail price of a single unit of this line item. Used for packing slip generation.

sellerOrderId

string

ID of the seller order fulfilling this line item. Read only.

sellerOrderItemId

string

ID of the seller order item corresponding to this line item. Read only.

variantId

string

ID of the variant to be fulfilled. Use the value from product.variants.id returned by the GET /buyer/products endpoint.

itemsNotAccepted

array of objects

The line items that have not been accepted on the buyer order. This is only valid for companies with partial orders enabled.

itemsNotAccepted

object

basePrice

number

buyerReference

string

A reference to an ID in the buyer's system corresponding to this order line item.

buyerVariantCode

string

The buyer's variant code for this line item.

string

ID of this buyer order item. Read only.

productId

string

ID of the product to be fulfilled. Use the value from product.id returned by the GET /buyer/products endpoint.

quantity

integer

The quantity of this variant to be fulfilled.

retailPrice

number

The after tax retail price of a single unit of this line item. Used for packing slip generation.

sellerOrderId

string

ID of the seller order fulfilling this line item. Read only.

sellerOrderItemId

string

ID of the seller order item corresponding to this line item. Read only.

variantId

string

ID of the variant to be fulfilled. Use the value from product.variants.id returned by the GET /buyer/products endpoint.

metafields

object

note

string

Additional information that will be passed along to each vendor with this order.

orderedDate

string

The timestamp when the order was originally placed by the customer. Use RFC 3339 format. Null if not set.

sellerOrders

array of objects

The seller orders fulfilling this buyer order. Read only.

sellerOrders

object

address

object

attributes

object

baseCurrency

string

The currency of the base prices on the order items.

buyerOrderID

string

ID of the buyer order this seller order belongs to.

buyerReference

string

A reference to an ID in the buyer's system.

companyId

string

The ID of the seller that fulfills this order.

created

string

The time the seller order was created. Null if not set. Read only.

customerReference

string

The customer-facing reference to the order in your (the buyer's) system.

flagged

boolean

Flag to indicate that something went wrong with the order that needs to be manually resolved.

flaggedAt

string

Which stage of the order pipeline the order was flagged at. Used by reconciliation jobs.

flaggedDate

string

The timestamp when order was flagged.

flaggedMessage

string

Message containing details of the flagged order.

fulfilled

boolean

Indicates that the seller order has been completely fulfilled. This will be set to true once the fulfillments on the order satisfy all the line items on the order.

fulfilledDate

string

The timestamp when the seller order was fulfilled. RFC 3339 format. Null if not set.

fulfillments

array of objects

The fulfillments created by the seller to satisfy this order.

fulfillments

object

carrier

string

The shipping carrier.

created

string

The time the seller order was created. Null if not set. Read only.

string

ID of the fulfillment.

items

array of objects

The seller order items included in this fulfillment.

items

object

string

ID of the fulfillment item.

orderItemId

string

ID of the seller order item corresponding to the variant being fulfilled.

quantity

integer

The amount being fulfilled.

posted

boolean

Indicates that the marketplace has received the fulfillment information.

postedDate

string

The timestamp when the fulfillment was posted. RFC 3339 format. Null if not set. Read only.

trackingCode

string

Tracking code provided by the carrier.

trackingUrls

array of strings

Tracking URLs provided by the carrier.

trackingUrls

updated

string

The time the seller order was last updated. Null if not set. Read only.

hasCancellations

boolean

Indicates that the sellerOrder contains cancellations

string

ID of this seller order.

invoiceId

string

ID of the invoice corresponding to this seller order.

invoiced

boolean

Indicates that the marketplace has been invoiced for this seller order. If automatic invoicing is enabled, Convictional will invoice the order soon after it has been marked fulfilled.

invoicedDate

string

The timestamp when the seller order was invoiced. RFC 3339 format. Null if not set.

isTest

boolean

Indicates whether the order is a test order

items

array of objects

The line items on the seller order.

items

object

basePrice

number

The wholesale price of the variant per unit, charged to the retailer/marketplace.

buyerReference

string

Reference code for the order in the buyers system

cancelled

boolean

Indicates whether this order item has been cancelled.

cancelledBy

string

Identifies the company that initiated the cancellation. Options: "buyer", "seller", or "" (blank only if item is not cancelled).

cancelledDate

date-time

Time at which the order item was cancelled.

cancelledReason

string

Reason that the order item was cancelled.

string

ID of this seller order item.

quantity

integer

The quantity of this variant to be fulfilled.

retailPrice

number

The MSRP value of the order that was charged to the customer by the retail/marketplace.

sellerOrderId

string

ID of the order as a whole in the sellers system

sellerOrderItemId

string

ID of the line item in the sellers system

variantId

string

ID of the variant to be fulfilled.

packingSlipUrl

string

URL of a packing slip for this seller order.

posted

boolean

Indicates that the seller has received the order.

postedDate

string

The timestamp when the seller order was posted. RFC 3339 format. Null if not set.

sellerReference

string

A reference to an ID in the seller's system.

updated

string

The time the seller order was last updated. Null if not set. Read only.

shippingMethods

array of objects

The shipping methods for the order.

shippingMethods

object

code

string

The code of the shipping method.

price

object

Has additional fields

title

string

The title of the shipping method.

updated

string

The time the buyer order was last updated. Null if not set. Read only.

Language

Credentials

Header


xxxxxxxxxx
1
curl --request POST \
2
     --url https://api.moderndropship.com/buyer/orders \
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

200OK

400Bad Request

401Unauthorized

500Internal Server Error