Update Shipping Courier | Welcome to Afterpay Documentation

curl -X PUT https://global-api-sandbox.afterpay.com/v2/payments/orderId/courier \
     -H "User-Agent: User-Agent" \
     -H "Content-Type: application/json" \
     -u "<username>:<password>" \
     -d '{}'

{
  "id": "300000016189",
  "token": "002.6bjbsaowxvfqam2nw4u3xudppheuh4gsuat3n2w3f6t44euzgy",
  "status": "APPROVED",
  "created": "2024-03-11T20:11:42.487Z",
  "originalAmount": {
    "amount": "37.00",
    "currency": "USD"
  },
  "openToCaptureAmount": {
    "amount": "0.00",
    "currency": "USD"
  },
  "paymentState": "CAPTURED",
  "merchantReference": "updated-k6-reference-utaddnpx",
  "refunds": [],
  "orderDetails": {
    "consumer": {
      "email": "test@example.com"
    },
    "billing": {
      "name": "Joe Customer",
      "line1": "1004 New Avenue",
      "area1": "Melbourne",
      "region": "VIC",
      "postcode": "94121",
      "countryCode": "AU",
      "phoneNumber": "2120000000",
      "countrycode": "US"
    },
    "courier": {
      "shippedAt": "2024-01-01T08:00:00Z",
      "name": "FedEx",
      "tracking": "000 000 000 000",
      "priority": "STANDARD"
    },
    "items": [
      {
        "name": "Blue Carabiner",
        "quantity": 1,
        "price": {
          "amount": "40.00",
          "currency": "USD"
        },
        "sku": "12341234"
      }
    ],
    "shipping": {
      "name": "Joe Customer",
      "line1": "1004 New Avenue",
      "postcode": "94121",
      "countrycode": "US",
      "phoneNumber": "2120000000"
    },
    "categories": {
      "name": "Jeans",
      "sku": "123412345",
      "quantity": 1,
      "price": {
        "amount": "20.00",
        "currency": "USD"
      }
    }
  },
  "events": [
    {
      "id": "2dYbLXpOtEPQbg1DT7x9D8R4oCY",
      "created": "2024-03-11T20:11:43.897Z",
      "type": "CAPTURED",
      "amount": {
        "amount": "37.00",
        "currency": "USD"
      },
      "paymentEventMerchantReference": "k6-gsrdqspusf"
    }
  ],
  "discounts": [],
  "shippingAmount": {
    "amount": "10.00",
    "currency": "USD"
  },
  "taxAmount": {
    "amount": "0.00",
    "currency": "USD"
  }
}

This endpoint updates an order with shipping courier information. The Afterpay team may utilise this information when providing support.

Connection Timeouts

Timeout	Time (Seconds)
Open	10
Read	20

This endpoint updates an order with shipping courier information. The Afterpay team may utilise this information when providing support. **Connection Timeouts** | Timeout | Time (Seconds) | |---------|----------------| | Open | 10 | | Read | 20 |

Authentication

AuthorizationBasic

Basic authentication of the form Basic <base64(username:password)>.

Path parameters

orderIdstringRequired

The unique Afterpay Order ID to update.

Request

shippedAtstringOptionalformat: "date-time"

The date and time when the order was shipped, in ISO 8601 format.

namestringOptional<=128 characters

The name of the courier.

trackingstringOptional<=128 characters

The tracking number provided by the courier.

priorityenumOptional

The shipping priority.

Allowed values:

Response

Returns a Payment object in response.

idstring

The unique, permanent, Afterpay generated Order ID.

tokenstring

The token obtained from the checkout call

statusenum

represents the status of the order

Allowed values:

createdstring

The UTC timestamp of when the payment was completed.

originalAmountobject

Total amount charged to the customer for the order.

openToCaptureAmountobject

Remaining amount that can be captured. Will always be zero for Immediate Payment Flow orders.

paymentStateenumRead-only

is the current state for capturing payments

merchantReferencestring

is the merchant’s order id/reference that the payment corresponds to.

refundslist of objects

An array of refunds. Note: in response to a Capture Full Payment call, this array will always be empty, since refunds cannot occur until payment is captured.

orderDetailsobject

The details of the order bound to the payment.

eventslist of objects

One or more payment events that have occurred against the order.

agreementslist of objects

List of billing agreements created if any (field omitted if empty)

Errors

412

Precondition Failed Error

422

Unprocessable Entity Error

Authentication

Path parameters

Headers

Request

Response

Errors