OrderMesh
  1. Orders
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.
      POST
    • Search for orders based on various criteria and filters.
      GET
    • Create multiple orders
      POST
    • Retrieve multiple orders
      GET
    • Update multiple orders
      PATCH
    • Retrieve a list of orders
      GET
    • Retrieve an order by Order ID.
      GET
    • Update order data.
      PATCH
    • Retrieve an order by Safe ID
      GET
    • Retrieve order item by Order Item ID
      GET
    • Update an item within an order.
      PATCH
    • Cancel Order or order items
      POST
    • Change the order status to Customer Care Hold
      POST
    • Retrieve audit logs for a specific order.
      GET
    • Retrieve audit logs for a specific order.
      GET
    • Retrieve audit logs for a specific order item.
      GET
    • Add a Refund Request.
      POST
  • Packing Slip
    • Generates a packing slip for a specific shipment by Shipment ID.
  • Shipments
    • Get details of a specific shipment by Shipment ID.
    • Update details of a specific shipment by Shipment ID.
    • Create packages for a specific shipment.
    • Delete shipment with packages.
    • Get all shipments for an order by Order ID.
    • Create shipment for order, vendor, and order items.
    • Get shipment with packages for order and vendor.
    • Get shipment details by Order Item ID.
    • Update a specific shipment package.
    • Cancel shipment.
    • Unassign items to shipment.
    • Shipment resubmission to assigned facility.
    • Retry outbound polling for a shipment by publishing an OutboundShipmentUpdate event.
    • Search shipments.
    • Reroute shipment.
    • Rejects a shipment.
    • Bulk reroute shipments.
    • Get shipment audit logs.
    • Get package audit logs.
    • Get message audit logs for shipment updates.
    • Assign Shipment.
  • 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. Orders

Retrieve an order by Safe ID

GET
/v1/orders/safeId/{safeId}
This endpoint allows you to retrieve information about an order using the order Safe ID.

Request

Path Params

Responses

🟢200OK
text/plain
OK
Body

🟠400Bad Request
🟠401Unauthorized
🟠403Forbidden
🟠404Record Not Found
🔴500Server Error
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET 'https://api.dev.ordermesh.io/v1/orders/safeId/'
Response Response Example
200 - Success Example
{
    "order": {
        "items": [
            {
                "id": "7890abcdef123456",
                "shortId": "I12345678",
                "externalId": "EXT789012",
                "sku": "MERCH-TSHIRT-BLACK-M",
                "originalSKU": "TSHIRT-5000-M-BLACK",
                "quantity": 2,
                "status": "Fulfilled",
                "statusDesc": null,
                "createdAt": "2026-02-27T22:29:29.4914307Z",
                "updatedAt": null,
                "processedAt": null,
                "cancelledAt": null,
                "images": null,
                "options": null,
                "attributes": null,
                "customerSubtotal": {
                    "currency": "USD",
                    "amount": 20
                },
                "customerPrice": {
                    "currency": "USD",
                    "amount": 10
                },
                "customerShippingPrice": {
                    "currency": "USD",
                    "amount": 5
                },
                "customerTaxes": null,
                "merchantPrice": null,
                "merchantShippingPrice": null,
                "merchantTax": null,
                "merchantSubTotal": null,
                "merchantItemTotal": null,
                "clientAttributes": null,
                "meta": null,
                "isSample": true,
                "skipImgManip": false,
                "skipImageValidation": false,
                "skipSkuValidation": false,
                "fulfillmentReady": false,
                "refundData": null
            }
        ],
        "merchantItemTotal": null,
        "merchantTaxTotal": null,
        "merchantShippingTotal": null,
        "merchantTotal": null,
        "reprint": {
            "originalOrderId": "65add270441de72442397b6e",
            "reasonId": "reason_1",
            "shipments": [
                {
                    "facilityId": "facility-Id",
                    "shippingMethod": "Standard",
                    "costCoverage": {
                        "item": "Merchant",
                        "shipping": "Customer"
                    },
                    "items": [
                        {
                            "sku": "TSHIRT-5000-M-BLACK",
                            "quantity": 2
                        }
                    ]
                }
            ]
        },
        "facilityNames": [
            "Facility 1",
            "Facility 2"
        ],
        "shipmentCreatedDates": [
            "2026-02-27T22:29:29.4914352Z",
            "2026-02-28T22:29:29.4914354Z"
        ],
        "shipmentIds": [
            "SHIP123456",
            "SHIP789012"
        ],
        "id": "65add270441de72442397b6e",
        "shortId": "O04790082",
        "shippingAddress": {
            "location": null,
            "firstName": "Emily",
            "lastName": "Williams",
            "line1": "475 Oak Avenue",
            "line2": "Suite 2B",
            "line3": null,
            "city": "Pleasantville",
            "state": "NJ",
            "zip": "08232",
            "countryCode": "US",
            "phone": "609-555-0123",
            "email": "emily.w@example.com"
        },
        "billingAddress": {
            "location": null,
            "firstName": "Emily",
            "lastName": "Williams",
            "line1": "475 Oak Avenue",
            "line2": "Suite 2B",
            "line3": null,
            "city": "Pleasantville",
            "state": "NJ",
            "zip": "08232",
            "countryCode": "US",
            "phone": "609-555-0123",
            "email": "billing@example.com"
        },
        "returnAddress": null,
        "externalId": "75a452bf-d245-45da-9f65-a4d7957d8893",
        "safeId": "0f438c56-5ebe-4090-8d90-e0bba7cbb52c",
        "languageCode": "en",
        "customerTotal": {
            "currency": "USD",
            "amount": 30
        },
        "customerItemTotal": {
            "currency": "USD",
            "amount": 20
        },
        "customerTotalShipping": {
            "currency": "USD",
            "amount": 5
        },
        "customerTotalTaxes": {
            "currency": "USD",
            "amount": 5
        },
        "customerTotalDiscountAndPromotions": {
            "currency": "USD",
            "amount": 0
        },
        "customerPaymentMethods": [
            {
                "method": "Debit Card",
                "subMethod": "Visa",
                "cardFirst4": "1234",
                "cardLast4": "1234",
                "billingInfo": {
                    "fullName": "Emily Williams",
                    "address": {
                        "location": null,
                        "firstName": "Emily",
                        "lastName": "Williams",
                        "line1": "475 Oak Avenue",
                        "line2": "Suite 2B",
                        "line3": null,
                        "city": "Pleasantville",
                        "state": "NJ",
                        "zip": "08232",
                        "countryCode": "US",
                        "phone": "609-555-0123",
                        "email": ""
                    }
                },
                "customerTransactions": [
                    {
                        "total": {
                            "currency": "USD",
                            "amount": 30
                        },
                        "transactionDate": "01/22/2024 02:26:56",
                        "transactionId": "TX12345678",
                        "authorizationCode": "AUTH7890"
                    }
                ]
            }
        ],
        "status": "Open",
        "billingStatus": "Refunded",
        "merchantId": "46bae16f-3ccd-4afa-90d2-706551acbed7",
        "merchantName": "Test Merchant",
        "customerShippingMethod": "Standard",
        "isTest": true,
        "isSample": true,
        "createdAt": "2024-01-22T02:26:56.56+00:00",
        "updatedAt": null,
        "cancelledAt": null,
        "meta": {
            "additionalProp1": "Test"
        },
        "allowExternalOrderIdDuplication": false,
        "isPollingStopped": false,
        "automaticProcessing": null
    }
}
Modified at 2026-02-27 22:33:53
Previous
Update order data.
Next
Retrieve order item by Order Item ID
Built with