OrderMesh
  1. Shipments
OrderMesh
  • Introduction to OrderMesh API
    • Getting Started
    • Product Catalog
    • Webhooks
    • Merchant Notifications Guide
  • Notes
    • /v1/notes
      POST
    • /v1/notes
      GET
    • /v1/notes/{noteId}
      GET
    • /v1/notes/{id}
      PUT
    • /v1/notes/{id}
      DELETE
    • /v1/notes/{id}/auditLogs
      GET
  • OrderItems
    • Search for order items based on various criteria and filters
  • Orders
    • Create a New Order.
    • Search for orders based on various criteria and filters.
    • Create multiple orders
    • Retrieve multiple orders
    • Update multiple orders
    • Retrieve a list of orders
    • Retrieve an order by Order ID.
    • Update order data.
    • Retrieve an order by Safe ID
    • Retrieve order item by Order Item ID
    • Update an item within an order.
    • Cancel Order or order items
    • Change the order status to Customer Care Hold
    • Retrieve audit logs for a specific order.
    • Retrieve audit logs for a specific order.
    • Retrieve audit logs for a specific order item.
    • Add a Refund Request.
  • Packing Slip
    • Generates a packing slip for a specific shipment by Shipment ID.
  • Shipments
    • Get details of a specific shipment by Shipment ID.
      GET
    • Update details of a specific shipment by Shipment ID.
      PATCH
    • Create packages for a specific shipment.
      POST
    • Delete shipment with packages.
      DELETE
    • Get all shipments for an order by Order ID.
      GET
    • Create shipment for order, vendor, and order items.
      POST
    • Get shipment with packages for order and vendor.
      GET
    • Get shipment details by Order Item ID.
      GET
    • Update a specific shipment package.
      PATCH
    • Cancel shipment.
      PATCH
    • Unassign items to shipment.
      POST
    • Shipment resubmission to assigned facility.
      POST
    • Retry outbound polling for a shipment by publishing an OutboundShipmentUpdate event.
      POST
    • Search shipments.
      GET
    • Reroute shipment.
      POST
    • Rejects a shipment.
      POST
    • Bulk reroute shipments.
      POST
    • Get shipment audit logs.
      GET
    • Get package audit logs.
      GET
    • Get message audit logs for shipment updates.
      GET
    • Assign Shipment.
      POST
  • Client
    • Generate service client access token (valid for 24 hours).
  • User
    • Login user by username and password.
    • Login user with refresh token.
  • Schemas
    • CreateNoteModel
    • APIClientInfoModel
    • AssignDTO
    • AssignUserRoleDto
    • CreateNoteReponse
    • AddRefundItemModel
    • AssignShipmentResponse
    • Error
    • AddRefundModel
    • ForbiddenErrorResponse
    • AddressModel
    • ClientTokenResponseDTO
    • GetAuditLogResponse
    • AttributeModel
    • CancelShipmentDto
    • GetNoteByIdResponse
    • BaseAddressModel
    • CreateInvitationDto
    • GetNoteResponseItemModel
    • BillingInfoModel
    • CountryCodes
    • CreateInvitationDtoBulkModel
    • GetNotesResponse
    • BulkResponse
    • CreatePackageDTO
    • CreateInvitationResponse
    • NotFoundErrorResponse
    • BulkResponseItem
    • CreatePackagesResponse
    • CreateRoleDTO
    • ResourceFormat
    • CancelOrderItemModel
    • CreateShipmentDTO
    • CreateServiceClientDto
    • ResourceReferenceModel
    • CancelOrderModel
    • CreateShipmentResponse
    • CreateServiceClientResponseDTO
    • StringAuditEvent
    • CancelOrderResponse
    • CurrencyCodes
    • CreateUserDto
    • UnauthorizedResult
    • ConflictErrorResponse
    • DeleteInvitationResponse
    • UnhandledErrorResponse
    • CoordinatesModel
    • ExternalErrorResponse
    • UpdateNotePayload
    • CreateOrderCustomerPaymentMethodModel
    • UpdateNoteResponse
    • CreateOrderCustomerTransactionModel
    • GeneratePackingSlipResponse
    • UserReferenceModel
    • CreateOrderItemImageModel
    • ForgotPasswordDTO
    • ValidationErrorResponse
    • CreateOrderItemModel
    • GetOrdersCountByFacilityResponse
    • FutureAssociationsDTO
    • CreateOrderModel
    • GetShipmentPollingStoppedCountResponse
    • GetInvitationResponse
    • CreateOrderModelBulkModel
    • GetShipmentsCountByStatusResponse
    • GetInvitationsByMerchantIdResponse
    • CreateOrderResponse
    • LanguageCodes
    • GetInvitationsByMerchantIdResponseDto
    • CustomerCareHoldOrderResponse
    • GetServiceClientTokenDto
    • OrderCount
    • InvitationDeliveryMethodEnum
    • OrderItem
    • InvitationDeliveryResponse
    • OrderItemDTO
    • InvitationStatusEnum
    • GetOrderCustomerPaymentMethodModel
    • PackageDTO
    • InvitationsByMerchantIdSortByEnum
    • GetOrderCustomerTransactionModel
    • PackageOrderItemDTO
    • LoginUserDto
    • GetOrderItemImageModel
    • PackingSlipDto
    • LoginUserWithAuthorizationCode
    • GetOrderItemModel
    • Price
    • LoginUserWithRefreshToken
    • GetOrderItemRefundDataItemModel
    • Reject
    • GetOrderItemRefundDataModel
    • RejectResponse
    • OnboardUserDto
    • GetOrderItemResponse
    • Reroute
    • PasswordPolicyDTO
    • GetOrderModel
    • RerouteBulkModel
    • PatchUserDTO
    • GetOrderResponse
    • RerouteOrderItem
    • PermissionDTO
    • GetOrdersCountByStatusResponse
    • RerouteResponse
    • PermissionSet
    • GetOrdersPollingStoppedCountResponse
    • PermissionSetsRequestDTO
    • ListOrderModel
    • SearchShipmentModel
    • PermissionSetsResponseDTO
    • ListOrdersResponse
    • SearchShipmentResponse
    • ResendInvitationResponse
    • SelectedCarrierShippingServiceMethodDTO
    • ResetPasswordDTO
    • OptionModel
    • SelectedShippingMappingDTO
    • ResourceDTO
    • OrderItemStatus
    • SelectedShippingMappingMethodDTO
    • RoleDTO
    • OrderStatus
    • SelectedVendorMappingDTO
    • RolePermissionDTO
    • OrdersCountByStatus
    • ShipmentDTO
    • RoleWithPermissionDTO
    • PriceModel
    • ShipmentStatus
    • SearchRolesEnum
    • RefreshProcessingModel
    • ShipmentsCountByStatus
    • SearchRolesResponseDTO
    • RefreshProcessingResponse
    • SearchUsersEnum
    • ReprintCostCoverageModel
    • UnassignOrderItemDTO
    • SearchUsersResponseDTO
    • ReprintModel
    • ServiceClientResponseDTO
    • ReprintShipmentItemModel
    • StringBulkModel
    • ReprintShipmentModel
    • UpdatePackageDTO
    • TokenResponseDTO
    • UpdateShipmentDTO
    • UnassignUserRoleDTO
    • SearchOrderItemsResponse
    • UnauthorizedErrorResponse
    • SearchOrderModel
    • SearchOrdersResponse
    • ShipmentMetadata
    • UpdateAssociationTypeDTO
    • StartProcessingModel
    • UpdateAttributesDto
    • StartProcessingResponse
    • UpdateRoleDTO
    • UpdateRolePermissionsDTO
    • UserResponseDTO
    • ValidateEmailsResponse
    • UpdateOrderItemImageModel
    • UpdateOrderItemModel
    • ValidationResponseDTO
    • UpdateOrderItemResponse
    • UpdateOrderModel
    • UpdateOrderModelBulkModel
    • UpdateOrderResponse
    • UpdatePriceModel
    • VariantAttribute
    • VariantOption
  1. Shipments

Create shipment for order, vendor, and order items.

POST
/v1/order/{orderId}

Request

Path Params

Body Params application/json

Examples

Responses

🟢201Created
text/plain
Returns the created shipment with the provided shipment id.
Body

🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠409
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api.dev.ordermesh.io/v1/order/' \
--header 'Content-Type: application/json' \
--data-raw '{
    "merchantId": "1",
    "vendorId": "2",
    "facilityId": "3",
    "facilityName": "Facility test",
    "vendorName": "Vendor test",
    "customerId": "4",
    "customerShippingAddressId": 5,
    "merchantPaymentId": "6",
    "shippingCountryCode": "US",
    "shippingCountryCodeISO": 236,
    "shipmentStatus": 1,
    "shippingMethod": null,
    "isPollingStopped": false,
    "orderExternalId": "1",
    "safeId": "2",
    "currencyCodeISO": 148,
    "currencyCode": "USD",
    "languageCodeISO": 40,
    "languageCode": "US",
    "transactionalCostModel": "transactional",
    "orderCreatedDate": "2022-04-02T12:00:00",
    "merchantOrderTotal": 123,
    "merchantPackageTotal": 22,
    "merchantTaxTotal": 55,
    "merchantShippingTotal": 33,
    "packageTotal": 321,
    "taxTotal": 55,
    "shippingTotal": 12,
    "total": 32,
    "costTotal": 43,
    "costTaxTotal": 77,
    "costShippingTotal": 42,
    "costShippingTaxTotal": 93,
    "orderItemIds": [
        "a1f0a9cc-f66c-447f-b770-9b4884e9f02d"
    ],
    "orderItems": [
        {
            "id": "a1f0a9cc-f66c-447f-b770-9b4884e9f02d",
            "sku": "Sku-test",
            "vendorSku": "VendorSku-test",
            "variantId": "1",
            "vendorProductId": "1",
            "quantity": 1,
            "merchantPrice": {
                "currency": "USD",
                "amount": 10,
                "tax": 5
            },
            "price": {
                "currency": "USD",
                "amount": 10,
                "tax": 5
            }
        }
    ]
}'
Response Response Example
201 - Success Example
{
    "shipmentId": "c8f51b34-3c03-417c-b3ff-1e49a159e851"
}
Modified at 2026-03-02 17:34:25
Previous
Get all shipments for an order by Order ID.
Next
Get shipment with packages for order and vendor.
Built with