Skip to main content
API docs by Redocly

Fulfillment Provider Webhooks (v0)

Download OpenAPI specification:Download

Represents the fulfillment requests that NewStore might send you, to fulfill using a fulfillment provider (WMS, OMS, 3PL).

To integrate your fulfillment provider with NewStore, implement the method in this resource. Also see Fulfillment requests.

For information about the integration process, see Integrating a fulfillment provider in our documentation.

Note: The defined baseUri is for illustration purposes only, edit it as needed.

Create fulfillment request

Incoming call from NewStore which creates a new fulfillment request for your fulfillment provider to fulfill.

If an API key was provided when setting up the webhook, every call to this method includes the line Authorization: Bearer <api_key> in its header.

Request Body schema: application/json
id
required
string

Unique ID for this Fulfillment request

order_id
string

The identifier of the order the fulfillment request is assigned to. Please mind that a single order can result in multiple fulfillment requests.

required
object (Fulfillment Provider Request Address.)
required
object (Fulfillment Provider Request Address.)
required
object
created_at
required
string <date-time>

Date and time when the order was created.

required
Array of objects non-empty

List containing items in the order; one list index equals one item.

Array of objects <= 100 items [ items <= 2 properties ]

A set of custom attributes defined during the order creation.

Responses

Request samples

Content type
application/json
{
  • "id": "4234r56j3k",
  • "order_id": "1563362",
  • "billing_address": {
    },
  • "shipping_address": {
    },
  • "shipping_options": {
    },
  • "created_at": "2017-10-27T12:24:17Z",
  • "items": [
    ],
  • "extended_attributes": [
    ]
}