Fulfillments

post

https://api.signifyd.com/v3/orders/events/fulfillments

Use this endpoint to record a list of fulfillments associated with an Order. All fulfillments passed here will be appended to existing fulfillments. If a fulfillment already exists on the order with any of the provided shipmentIds the entire request will be rejected.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

orderId

string

required

The id that uniquely identifies the order the shipment is for. This should be the same orderId provided when created by Checkout or Sale event.

fulfillmentStatus

string

enum

Statuses to indicate fulfillment state.

PARTIAL - Some of the items in the order have not been shipped.
COMPLETE - All of the items in the order have been shipped.
REPLACEMENT - A replacement for one of the items in the order has been shipped.
CANCELED - For some or all of the items in the order, shipment was canceled.

Allowed:

fulfillments

array of objects

required

A list of fulfillments associated with an order.

fulfillments*

Headers

SIGNIFYD-TEAM-ID

int64

The team id requested for authentication. This should normally be omitted, as it's only relevant when auth credentials allow requests for multiple teams.

Responses

204

A 204 response indicates that the request was processed but no response is expected.

Language

Credentials

Basic

base64

Loading…

Response

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

application/json

200

400Response if there was a problem with the request, such as when a required field is missing or otherwise fails validation.

401Response if the provided authentication credentials are not known or do not match what is on file for the specified user.

403Response if the authenticated user does not have permission to perform the requested action.

409Response if the Request is considered to conflict with data already on the system.

500Response if an unexplained error occurs on the server.