API: Fulfill Order

POST /api/marketplace/v2/orders/fulfill/

Specification

Inform Kogan that an order has been dispatched.

Dispatching an order will remove it from the open orders results.

Products sent with different tracking numbers should be submitted on separate Dispatch Lines

Request Format

See below a list of the fields and description for the order’s fulfillment

Fulfillment Object

Parameter

Required

Description

Id

Yes

Order Id

Items

Yes

Items that have been shipped.
See the Items array object below

Item Array Object

Parameter

Required

Description

OrderItemID

Yes

Line Id

Quantity

Yes

The number of units shipped.
The quantity needs to be greater than 0

SellerSku

Yes

The SKU of the ordered line item that was shipped

ShippedDateUtc

Yes

The ISO 8601 UTC date/time on which the order has been shipped.

ShippingCarrier

Yes

The carrier company of the shipment.

  • See the values allowed below

ShippingClass

No

Send blank

TrackingNumber

Yes

The tracking number of the shipment.
This field should only contain one Tracking Number

Carrier Companies

Here is a list with all the carriers allowed (refer to the field ShippingCarrier)

https://koganmarketplace.zendesk.com/hc/en-us/articles/900005468863-Supported-Carrier-Codes

Example

[
  {
    "ID": " 123456 ",
    "Items": [
      {
        "OrderItemID": "0",
        "SellerSku": "XX-Valyrian-steel-SWORD-1",
        "Quantity": 1,
        "ShippedDateUtc": "2020-03-17T22:50:56.53906Z",
        "TrackingNumber": " XYZTRACKING0",
        "ShippingCarrier": "Pigeon Express",
        "ShippingClass": "Express"
      },
      {
        "OrderItemID": "1",
        "SellerSku": "XX-DRAGON-STONE",
        "Quantity": 4,
        "ShippedDateUtc": "2020-03-17T22:50:56.53906Z",
        "TrackingNumber": "XYZTRACKING1",
        "ShippingCarrier": "Pigeon Express",
        "ShippingClass": "Express"
      }
    ]
  }
]

Did this page help you?