Services

Create a service

Changed on

Create a new service for a shipment.

What happens

  • Service is created for the specified shipment
  • Vendor is associated with the service
  • Charges are recorded

Note

Services are typically created as part of shipment creation. Use this endpoint to add additional services to an existing shipment.

post/services

Request

  • Base URL: https://api.mvmnt.io/v1
  • URL: https://api.mvmnt.io/v1/services
  • Auth: HTTP bearer

Request body

shipmentIdstring uuid required

Parent shipment ID

Response

Service created successfully

idstring uuid required
keystring nullable

Human-readable service ID

shipmentIdstring uuid

Parent shipment

shipmentKeystring nullable

Parent shipment friendly ID

status'ACTIVE' | 'AWAITING_INVOICE' | 'INVOICE_IN_REVIEW' | 'APPROVED_TO_PAY' | 'PAID' | 'CANCELED' required

Current status of the service.

Active states:

  • ACTIVE: Service is active/in progress

Billing states (AP):

  • AWAITING_INVOICE: Waiting for vendor invoice
  • INVOICE_IN_REVIEW: Invoice received, under review
  • APPROVED_TO_PAY: Approved for payment
  • PAID: Paid to vendor

Final states:

  • CANCELED: Service canceled
descriptionstring nullable

Service description

totalCostnumber nullable

Sum of all charges

scheduledDatestring date nullable
completedDatestring date nullable
referenceNumberstring nullable

Vendor reference number

createdAtstring date-time required
updatedAtstring date-time nullable

Example response

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "key": "SVC-12345",
  "vendor": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "key": "ERP-VENDOR-ABC-001",
    "friendlyId": "V123456",
    "name": "ABC Warehouse Services",
    "email": "billing@abcwarehouse.com",
    "phone": "+1-555-123-4567",
    "status": "ACTIVE",
    "currency": "USD",
    "createdAt": "2025-01-15T10:00:00Z",
    "updatedAt": "2025-01-15T14:30:00Z"
  },
  "charges": [
    {
      "chargeCode": {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "key": "ERP-USER-12345"
      }
    }
  ]
}

Changes

    • breaking

      added the new required request property ///

    • breaking

      added the new required request property ///

    • warning

      the /// request property's maxLength was set to 500

    • warning

      the /// request property's min was set to 0.00

    • warning

      removed the request property ///

    • warning

      removed the request property ///

    • info

      added the new optional request property ///

    • info

      added the optional property // to the response with the status

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      added subschema #2 to the response body allOf list for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      media type application/json was changed to a more specific media type application/problem+json for the response status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status

    • info

      added the required property to the response with the status