Delegate Fulfillment

Send an order to the fulfillment provider. Returns a Fufillment Provider Order ID used on other methods referencing this requested fulfillment.

Request
Request Body schema: application/json
transaction_id
required
string <guid>

A randomly generated transaction ID, used to correlate the request and response

required
object (Auth)

Authentication properties

object (BillTo)

This model represents information for who is being billed

object (Buyer)

Contact information for the buyer of this sales order

created_date_time
string

The (ISO 8601) datetime (UTC) associated with when this order was created

currency
string

The three character ISO 4217 code of the currency used for all monetary amounts

fulfilled_date
string

The (ISO 8601) datetime (UTC) associated with when this order shipped

integration_context
string

Data provided by the order source that should be included in calls back to the order source. This data is only meaningful to the integration and not otherwise used by the platform.

modified_date_time
string

The (ISO 8601) datetime (UTC) associated with when this order was last modified

Array of objects (Note)

Notes about the order

order_id
string

The unique identifier of the sales order from the order source

order_number
string

The customer facing identifier of the sales order

order_url
string

A unique url associated with the order

object (OriginalOrderSource)

Represents information from the source marketplace. (This is common with reselling goods)

paid_date
string

The (ISO 8601) datetime (UTC) associated with when this sales order was paid for

object (Payment)
required
Array of objects (RequestedFulfillment)

The fulfillment requested by the marketplace or the buyer

object (Address)

This defines the shape of an address

status
required
string

The sales order status

Enum: "AwaitingPayment" "AwaitingShipment" "Cancelled" "Completed" "OnHold" "PendingFulfillment"
Responses
200

OK

post/delegate_fulfillment
Request samples
application/json
{
  • "bill_to": {
    },
  • "buyer": {
    },
  • "created_date_time": "2021-03-31T18:21:14.858Z",
  • "currency": "USD,EUR,NZD",
  • "fulfilled_date": "2021-03-31T18:21:14.858Z",
  • "integration_context": "string",
  • "modified_date_time": "2021-03-31T18:21:14.858Z",
  • "notes": [
    ],
  • "order_id": "string",
  • "order_number": "string",
  • "order_url": "string",
  • "original_order_source": {
    },
  • "paid_date": "2021-03-31T18:21:14.858Z",
  • "payment": {
    },
  • "requested_fulfillments": [
    ],
  • "ship_from": {
    },
  • "status": "AwaitingPayment"
}
Response samples
application/json
{
  • "fulfillment_provider_order_id": "3b5aa32d-c082-4058-9c7a-1b523d431b52"
}