Sign in
Orders

Add shipment status history to an order

Requires the order:update scope. Create a new shipment status history entry for an order.

post/v3/orders/{id}/shipment-status-history

Request body

descriptionstring required

Description of the shipment status change

status'draft' | 'pending' | 'confirmed' | 'in_process' | 'ready' | 'shipped' | 'completed' | 'canceled' | 'rts' | 'closed' required

Order status

timestampstring date-time required

Timestamp of the shipment status change (ISO 8601 format)

Response

SSH connection created

gross_revenue_for_dropshipperstring decimal

Gross revenue for dropshipper after discounts

cogsstring decimal

Cost of goods sold for the order

dropshipper_namestring nullable

Name of the dropshipper

transferproof_urlstring nullable

Transfer proof URL

scalev_feestring decimal

Scalev fee for the order

discount_code_codestring nullable

Discount code used in the order

ready_timestring date-time nullable
payment_fee_ratestring decimal

Payment fee rate applied to the order

pg_paid_infoobject nullable

Payment gateway paid info

transfer_timestring date-time nullable
dropshipper_phonestring nullable

Phone number of the dropshipper

shipping_coststring decimal

Shipping cost for the order

product_pricestring decimal

Total product price before discounts

total_quantityinteger

Total quantity of items in the order

net_revenuestring decimal

Net revenue after all discounts and fees

bundle_price_optionsobject nullable

Bundle price options for the order

variantsobject nullable

Variants of the order

chat_messagestring

Chat message associated with the order

handler_phonestring nullable

Handler phone number

order_idstring

Order ID in string format

product_discountstring decimal

Total product discount applied

payment_account_numberstring nullable

Payment account number

payment_method'va_bca' | 'va_bni' | 'va_bri' | 'va_mandiri' | 'va_permata' | 'va_cimb' | 'va_bsi' | 'va_maybank' | 'va_bnc' | 'va_danamon' | 'va_artha_graha' | 'va_muamalat' | 'va_btn' | 'va_ocbc' | 'va_bjb' | 'va_sahabat_sampoerna' | 'va_artajasa' | 'qris' | 'card' | 'invoice' | 'payment_link' | 'alfamart' | 'ovo' | 'dana' | 'shopeepay' | 'linkaja' | 'gopay' | 'no_payment' | 'bank_transfer' | 'marketplace' | 'cod'

Order payment method

courierinteger nullable

Courier ID for the order

epayment_providerstring nullable

E-payment provider. xendit is the current/managed Xendit provider; xendit_legacy is the owned legacy Xendit provider. Other possible values include duitku, midtrans, durianpay, and singapay.

in_process_timestring date-time nullable
pg_reference_idstring nullable

Payment gateway reference ID

weight_bumpstring decimal

Weight bump added to the order

follow_up_chat_typestring nullable

Type of follow-up chat for the order

awb_status'unavailable' | 'pending' | 'waiting' | 'failed' | 'created' | 'canceled'

Order AWB status

platformstring

Platform of the order

is_purchase_kwaiboolean

Is this order a Kwai purchase

shipping_discountstring decimal

Shipping discount applied to the order

conflict_timestring date-time nullable
paid_timestring date-time nullable
confirmed_timestring date-time nullable
canceled_timestring date-time nullable
status'draft' | 'pending' | 'confirmed' | 'in_process' | 'ready' | 'shipped' | 'completed' | 'canceled' | 'rts' | 'closed'

Order status

is_dropshippingboolean

Is the order a dropshipping order

payment_account_idinteger nullable

Payment account ID

is_repeatboolean

Is repeat order

tiktok_pixel_idsstring[]

TikTok pixel IDs associated with the order

fb_pixel_idsstring[]

Facebook pixel IDs associated with the order

idstring uuid

Canonical UUIDv7 order primary key returned by the partitioned orders table.

unpaid_timestring date-time nullable
is_purchase_tiktokboolean

Is this order a TikTok purchase

shipment_statusstring nullable

Current shipment status of the order

kwai_pixel_idsstring[]

Kwai pixel IDs associated with the order

cogs_btstring decimal

Cost of goods sold for the order minus tax

payment_feestring decimal

Payment fee for the order

channel_namestring nullable

Channel name of the order

discount_ratestring decimal

Discount rate applied to the order

final_variantsobject nullable

Final variants of the order after bundle options

other_income_namestring nullable

Name of other income source

gross_revenuestring decimal

Gross revenue of the order

tagsstring[]

Tags associated with the order

discount_code_idinteger nullable

Discount code ID

other_incomestring decimal

Other income amount

payment_link_incomestring decimal

Additional E-Payment Link amount paid by the customer

total_weightstring decimal

Total weight of the order including weight bump

is_probably_spamboolean

Is probably spam

external_idstring

External ID of the order

discount_code_discountstring decimal

Discount code discount amount

product_discount_btstring decimal

Total product discount applied minus tax

pg_payment_infoobject nullable

Payment gateway payment info. SingaPay payments use normalized keys such as payment_url, deeplink_url, qr_string, qr_image_url, va_number, and va_name.

other_income_btstring decimal

Other income amount minus tax

payment_link_income_btstring decimal

Additional E-Payment Link amount before tax

mark_as_spam_bystring

Who marked as spam

net_payment_revenuestring decimal

Net payment revenue after fees

rts_timestring date-time nullable
min_payment_feestring decimal

Minimum payment fee applied to the order

is_from_formboolean

Is from form submission

secret_slugstring

Secret slug of the order

public_order_urlstring uri nullable

Public order URL built from metadata.custom_domain_full_url and secret_slug.

payment_urlstring uri nullable

Payment URL built from public_order_url with /success appended.

agent_contextobject nullable

Untrusted agent or app attribution metadata

shipping_feestring decimal

Shipping fee charged for the order

tax_ratenumber float nullable

Tax rate applied to the order

draft_timestring date-time nullable
last_updated_atstring date-time

Last updated timestamp of the order

courier_additional_infostring nullable

Additional information for the courier

closed_timestring date-time nullable
product_price_btstring decimal

Total product price before discounts minus tax

is_purchase_fbboolean

Is this order a Facebook purchase

product_weightstring decimal

Total weight of products in the order

completed_timestring date-time nullable
utm_sourcestring nullable

UTM source of the order

payment_account_holderstring nullable

Payment account holder name

ipstring nullable

IP address of the customer who placed the order

shipment_receiptstring nullable

Shipment receipt URL for the order

payment_status'unpaid' | 'paid' | 'conflict' | 'settled'

Order payment status

shipment_provider_code'mengantar' | 'lincah' | 'ninja' nullable

Shipment provider code

metadataobject nullable

Metadata associated with the order

rtsproof_urlstring nullable

RTS proof URL for the order

discount_code_applied_tostring nullable

What the discount code was applied to

shipped_timestring date-time nullable
awb_ca_status'unavailable' | 'pending' | 'waiting' | 'failed' | 'created' | 'canceled'

Order AWB courier aggregator status

created_atstring date-time

Order creation timestamp

pending_timestring date-time nullable
notesstring nullable

Notes or comments for the order

unique_code_discountstring decimal

Unique code discount applied to the order

shipping_fee_discountstring decimal

Shipping fee discount applied to the order

Example response

{
  "orderlines": [
    {
      "inserted_at": "2023-10-01T12:00:00Z"
    }
  ]
}

Changes

Changed in 1 of the 4 revisions of this API.214

  • 251b881b98eb214See the full diff
    • ●

      removed the optional property /// from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property / from the response with the status

      response-optional-property-removed

    • ●

      removed the optional property from the response with the status

      response-optional-property-removed

    • ●

      added the new payment_link enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new va_artajasa enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new va_artha_graha enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new va_bca enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new va_bjb enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new va_bnc enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new va_bni enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new va_bri enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new va_bsi enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new va_btn enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new va_cimb enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new va_danamon enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new va_mandiri enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new va_maybank enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new va_muamalat enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new va_ocbc enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new va_permata enum value to the response property for the response status

      response-property-enum-value-added

    • ●

      added the new va_sahabat_sampoerna enum value to the response property for the response status

      response-property-enum-value-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      added the optional property to the response with the status

      response-optional-property-added

    • ○

      removed the indomaret enum value from the response property for the response status

      response-property-enum-value-removed

    • ○

      removed the va enum value from the response property for the response status

      response-property-enum-value-removed